Border (NextApp . Echo3 . API Specification)

java.lang.Object
- nextapp.echo.app.Border

All Implemented Interfaces:

java.io.Serializable
```
public class Border
extends java.lang.Object
implements java.io.Serializable
```
A representation of a simple border.

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Border.Side
A representation of one or more sides of a border.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Border.Side` A representation of one or more sides of a border.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`SIDE_BOTTOM` Index of bottom side in returned array of sides.
`static int`	`SIDE_LEFT` Index of left side in returned array of sides.
`static int`	`SIDE_RIGHT` Index of right side in returned array of sides.
`static int`	`SIDE_TOP` Index of top side in returned array of sides.
`static int`	`STYLE_DASHED` A border style that appears as a series of short line segments.
`static int`	`STYLE_DOTTED` A border style that appears as a series of dots.
`static int`	`STYLE_DOUBLE` A border style that creates two solid monochrome borders around an object.
`static int`	`STYLE_GROOVE` A border style that causes a simulated 3D border to be rendered, such that the border appears to have been carved out.
`static int`	`STYLE_INSET` A border style that causes a simulated 3D border to be rendered, such that an object appears recessed.
`static int`	`STYLE_NONE` A border style that causes no border to be rendered.
`static int`	`STYLE_OUTSET` A border style that causes a simulated 3D border to be rendered, such that an object appears raised.
`static int`	`STYLE_RIDGE` A border style that causes a simulated 3D border to be rendered, such that the border appears as a ridge around an object.
`static int`	`STYLE_SOLID` A border style that causes a single solid monochrome border around an object.

Constructor Summary

Constructors
Constructor and Description
`Border(Border.Side[] sides)`
`Border(Extent size, Color color, int style)` Creates a new `Border`.
`Border(int sizePx, Color color, int style)` Creates a new `Border` with a pixel-based size.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)` Note that this implementation of equals will return FALSE if two borders have a different number of sides but are nevertheless equivalent.
`Color`	`getColor()` Returns the border color.
`Border.Side[]`	`getSides()` Returns the sides of the border.
`Extent`	`getSize()` Returns the border size.
`int`	`getStyle()` Returns the border style.
`boolean`	`isMultisided()` Determines if the border is multisided.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SIDE_TOP
```
public static final int SIDE_TOP
```
    Index of top side in returned array of sides.
    
    See Also:
    Constant Field Values
  - SIDE_RIGHT
```
public static final int SIDE_RIGHT
```
    Index of right side in returned array of sides.
    
    See Also:
    Constant Field Values
  - SIDE_BOTTOM
```
public static final int SIDE_BOTTOM
```
    Index of bottom side in returned array of sides.
    
    See Also:
    Constant Field Values
  - SIDE_LEFT
```
public static final int SIDE_LEFT
```
    Index of left side in returned array of sides.
    
    See Also:
    Constant Field Values
  - STYLE_NONE
```
public static final int STYLE_NONE
```
    A border style that causes no border to be rendered.
    
    See Also:
    Constant Field Values
  - STYLE_SOLID
```
public static final int STYLE_SOLID
```
    A border style that causes a single solid monochrome border around an object.
    
    See Also:
    Constant Field Values
  - STYLE_INSET
```
public static final int STYLE_INSET
```
    A border style that causes a simulated 3D border to be rendered, such that an object appears recessed.
    
    See Also:
    Constant Field Values
  - STYLE_OUTSET
```
public static final int STYLE_OUTSET
```
    A border style that causes a simulated 3D border to be rendered, such that an object appears raised.
    
    See Also:
    Constant Field Values
  - STYLE_GROOVE
```
public static final int STYLE_GROOVE
```
    A border style that causes a simulated 3D border to be rendered, such that the border appears to have been carved out.
    
    See Also:
    Constant Field Values
  - STYLE_RIDGE
```
public static final int STYLE_RIDGE
```
    A border style that causes a simulated 3D border to be rendered, such that the border appears as a ridge around an object.
    
    See Also:
    Constant Field Values
  - STYLE_DOUBLE
```
public static final int STYLE_DOUBLE
```
    A border style that creates two solid monochrome borders around an object.
    
    See Also:
    Constant Field Values
  - STYLE_DOTTED
```
public static final int STYLE_DOTTED
```
    A border style that appears as a series of dots.
    
    See Also:
    Constant Field Values
  - STYLE_DASHED
```
public static final int STYLE_DASHED
```
    A border style that appears as a series of short line segments.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - Border
```
public Border(int sizePx,
      Color color,
      int style)
```
    Creates a new Border with a pixel-based size.
    Parameters:
    sizePx - the size of the border, in pixels
    color - the color of the border
    style - the style of the border, one of the following constant values:
    
    STYLE_NONE
    
    STYLE_SOLID
    
    STYLE_INSET
    
    STYLE_OUTSET
    
    STYLE_GROOVE
    
    STYLE_RIDGE
    
    STYLE_DOUBLE
    
    STYLE_DOTTED
    
    STYLE_DASHED
  - Border
```
public Border(Extent size,
      Color color,
      int style)
```
    Creates a new Border.
    Parameters:
    size - the size of the border (this property only supports Extents with fixed (i.e., not percent) units)
    color - the color of the border
    style - the style of the border, one of the following constant values:
    
    STYLE_NONE
    
    STYLE_SOLID
    
    STYLE_INSET
    
    STYLE_OUTSET
    
    STYLE_GROOVE
    
    STYLE_RIDGE
    
    STYLE_DOUBLE
    
    STYLE_DOTTED
    
    STYLE_DASHED
  - Border
```
public Border(Border.Side[] sides)
```
- Method Detail
  - equals
```
public boolean equals(java.lang.Object o)
```
    Note that this implementation of equals will return FALSE if two borders have a different number of sides but are nevertheless equivalent.
    
    Overrides:
    
    equals in class java.lang.Object
    
    See Also:
    Object.equals(java.lang.Object)
  - getColor
```
public Color getColor()
```
    Returns the border color.
    
    Returns:
    the color
  - getSize
```
public Extent getSize()
```
    Returns the border size. This property only supports Extents with fixed (i.e., not percent) units.
    
    Returns:
    the size
  - getStyle
```
public int getStyle()
```
    Returns the border style.
    Returns:
    the style, one of the following values:
    
    STYLE_NONE
    
    STYLE_SOLID
    
    STYLE_INSET
    
    STYLE_OUTSET
    
    STYLE_GROOVE
    
    STYLE_RIDGE
    
    STYLE_DOUBLE
    
    STYLE_DOTTED
    
    STYLE_DASHED
  - getSides
```
public Border.Side[] getSides()
```
    Returns the sides of the border. Do not modify; modification of returned array will result in indeterminate behavior.
    
    Returns:
    the array of sides
  - isMultisided
```
public boolean isMultisided()
```
    Determines if the border is multisided.
    
    Returns:
    true if the border is multisided

Class Border

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SIDE_TOP

SIDE_RIGHT

SIDE_BOTTOM

SIDE_LEFT

STYLE_NONE

STYLE_SOLID

STYLE_INSET

STYLE_OUTSET

STYLE_GROOVE

STYLE_RIDGE

STYLE_DOUBLE

STYLE_DOTTED

STYLE_DASHED

Constructor Detail

Border

Border

Border

Method Detail

equals

getColor

getSize

getStyle

getSides

isMultisided