echopoint.positionable
Interface Borderable

All Known Subinterfaces:

ScrollableContainer

All Known Implementing Classes:

AbstractScrollableComponent, BorderableDelegate, BoxSection, EmbeddedPane, ExpandableSection, GroupBox, Label, PagedTableController, Panel, PushButton, ScrollableBox, ScrollablePanel, TextField, TitleBar

public interface Borderable

The Borderable interface is used to produce a border around a component. This border can have width, color and a border style.

The setBorderColor, setBorderSize and setBorderStyle methods will also set the left, top, right and bottom border properties.

These more specific left, top, right and bottom border properties take precedence over the general border properties, in that they are applied last during applyStyle() and are drawn so they override anything previously set by the general border properties.

Nested Class Summary

static class

Borderable.NestedStyleInfo Nested public static StyleInfo class.

Field Summary

static int	BORDER_DASHED Defines a dashed border
static int	BORDER_DOTTED Defines a dotted border
static int	BORDER_DOUBLE Defines two borders.
static int	BORDER_GROOVE Defines a 3D grooved border
static int	BORDER_INSET Defines a 3D inset border
static int	BORDER_NONE Defines no border
static int	BORDER_OUTSET Defines a 3D outset border
static int	BORDER_RIDGE Defines a 3D ridged border
static int	BORDER_SOLID Defines a solid border
static SymbolicValue[]	borderStyleSymbolics Helper static SymbolicValue[] - Borderable borderStyle Symbolics
static java.lang.String	STYLE_BORDER_COLOR A style constant for the BorderColor property.
static java.lang.String	STYLE_BORDER_SIZE A style constant for the BorderSize property.
static java.lang.String	STYLE_BORDER_STYLE A style constant for the BorderStyle property.
static java.lang.String	STYLE_BOTTOM_BORDER_COLOR A style constant for the bottomBorderColor property.
static java.lang.String	STYLE_BOTTOM_BORDER_SIZE A style constant for the bottomBorderSize property.
static java.lang.String	STYLE_BOTTOM_BORDER_STYLE A style constant for the bottomBorderStyle property.
static java.lang.String	STYLE_LEFT_BORDER_COLOR A style constant for the leftBorderColor property.
static java.lang.String	STYLE_LEFT_BORDER_SIZE A style constant for the leftBorderSize property.
static java.lang.String	STYLE_LEFT_BORDER_STYLE A style constant for the leftBorderStyle property.
static java.lang.String	STYLE_RIGHT_BORDER_COLOR A style constant for the rightBorderColor property.
static java.lang.String	STYLE_RIGHT_BORDER_SIZE A style constant for the rightBorderSize property.
static java.lang.String	STYLE_RIGHT_BORDER_STYLE A style constant for the rightBorderStyle property.
static java.lang.String	STYLE_TOP_BORDER_COLOR A style constant for the topBorderColor property.
static java.lang.String	STYLE_TOP_BORDER_SIZE A style constant for the topBorderSize property.
static java.lang.String	STYLE_TOP_BORDER_STYLE A style constant for the topBorderStyle property.

Method Summary

void	applyStyle(nextapp.echo.Style style) This will apply the borderColor, borderWidth and borderStyle properties first followed by the left, top, right and bottom borer properties.
nextapp.echo.Color	getBorderColor()
int	getBorderSize()
int	getBorderStyle() Returns the border style of the Borderable.
nextapp.echo.Color	getBottomBorderColor()
int	getBottomBorderSize()
int	getBottomBorderStyle()
nextapp.echo.Color	getLeftBorderColor()
int	getLeftBorderSize()
int	getLeftBorderStyle()
nextapp.echo.Color	getRightBorderColor()
int	getRightBorderSize()
int	getRightBorderStyle()
nextapp.echo.Color	getTopBorderColor()
int	getTopBorderSize()
int	getTopBorderStyle()
void	setBorderColor(nextapp.echo.Color borderColor) Sets the Color of the Borderable's border.
void	setBorderSize(int borderSize) Sets the size of the Borderables's border.
void	setBorderStyle(int borderStyle) Sets the border style of the Borderable.
void	setBottomBorderColor(nextapp.echo.Color borderColor) Sets the Color of the Borderable's bottom border.
void	setBottomBorderSize(int borderSize) Sets the size of the Borderables's bottom border.
void	setBottomBorderStyle(int borderStyle) Sets the border style of the Borderables's bottom border.
void	setLeftBorderColor(nextapp.echo.Color borderColor) Sets the Color of the Borderable's left border.
void	setLeftBorderSize(int borderSize) Sets the size of the Borderables's left border.
void	setLeftBorderStyle(int borderStyle) Sets the border style of the Borderables's left border.
void	setRightBorderColor(nextapp.echo.Color borderColor) Sets the Color of the Borderable's right border.
void	setRightBorderSize(int borderSize) Sets the size of the Borderables's right border.
void	setRightBorderStyle(int borderStyle) Sets the border style of the Borderables's right border.
void	setTopBorderColor(nextapp.echo.Color borderColor) Sets the Color of the Borderable's top border.
void	setTopBorderSize(int borderSize) Sets the size of the Borderables's top border.
void	setTopBorderStyle(int borderStyle) Sets the border style of the Borderables's top border.

Field Detail

BORDER_NONE

public static final int BORDER_NONE

Defines no border

See Also:

Constant Field Values

BORDER_SOLID

public static final int BORDER_SOLID

Defines a solid border

See Also:

Constant Field Values

BORDER_INSET

public static final int BORDER_INSET

Defines a 3D inset border

See Also:

Constant Field Values

BORDER_DOTTED

public static final int BORDER_DOTTED

Defines a dotted border

See Also:

Constant Field Values

BORDER_DOUBLE

public static final int BORDER_DOUBLE

Defines two borders. The width of the two borders are the same as the border-width value

See Also:

Constant Field Values

BORDER_GROOVE

public static final int BORDER_GROOVE

Defines a 3D grooved border

See Also:

Constant Field Values

BORDER_RIDGE

public static final int BORDER_RIDGE

Defines a 3D ridged border

See Also:

Constant Field Values

BORDER_DASHED

public static final int BORDER_DASHED

Defines a dashed border

See Also:

Constant Field Values

BORDER_OUTSET

public static final int BORDER_OUTSET

Defines a 3D outset border

See Also:

Constant Field Values

STYLE_BORDER_COLOR

public static final java.lang.String STYLE_BORDER_COLOR

A style constant for the BorderColor property. Values of this key must be of type Color

See Also:

Constant Field Values

STYLE_BORDER_SIZE

public static final java.lang.String STYLE_BORDER_SIZE

A style constant for the BorderSize property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_BORDER_STYLE

public static final java.lang.String STYLE_BORDER_STYLE

A style constant for the BorderStyle property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_LEFT_BORDER_COLOR

public static final java.lang.String STYLE_LEFT_BORDER_COLOR

A style constant for the leftBorderColor property. Values of this key must be of type Color

See Also:

Constant Field Values

STYLE_LEFT_BORDER_SIZE

public static final java.lang.String STYLE_LEFT_BORDER_SIZE

A style constant for the leftBorderSize property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_LEFT_BORDER_STYLE

public static final java.lang.String STYLE_LEFT_BORDER_STYLE

A style constant for the leftBorderStyle property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_TOP_BORDER_COLOR

public static final java.lang.String STYLE_TOP_BORDER_COLOR

A style constant for the topBorderColor property. Values of this key must be of type Color

See Also:

Constant Field Values

STYLE_TOP_BORDER_SIZE

public static final java.lang.String STYLE_TOP_BORDER_SIZE

A style constant for the topBorderSize property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_TOP_BORDER_STYLE

public static final java.lang.String STYLE_TOP_BORDER_STYLE

A style constant for the topBorderStyle property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_RIGHT_BORDER_COLOR

public static final java.lang.String STYLE_RIGHT_BORDER_COLOR

A style constant for the rightBorderColor property. Values of this key must be of type Color

See Also:

Constant Field Values

STYLE_RIGHT_BORDER_SIZE

public static final java.lang.String STYLE_RIGHT_BORDER_SIZE

A style constant for the rightBorderSize property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_RIGHT_BORDER_STYLE

public static final java.lang.String STYLE_RIGHT_BORDER_STYLE

A style constant for the rightBorderStyle property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_BOTTOM_BORDER_COLOR

public static final java.lang.String STYLE_BOTTOM_BORDER_COLOR

A style constant for the bottomBorderColor property. Values of this key must be of type Color

See Also:

Constant Field Values

STYLE_BOTTOM_BORDER_SIZE

public static final java.lang.String STYLE_BOTTOM_BORDER_SIZE

A style constant for the bottomBorderSize property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_BOTTOM_BORDER_STYLE

public static final java.lang.String STYLE_BOTTOM_BORDER_STYLE

A style constant for the bottomBorderStyle property. Values of this key must be of type int

See Also:

Constant Field Values

borderStyleSymbolics

public static final SymbolicValue[] borderStyleSymbolics

Helper static SymbolicValue[] - Borderable borderStyle Symbolics

Method Detail

getBorderColor

public nextapp.echo.Color getBorderColor()

Returns:

The Color of the Borderable's border.

getBorderSize

public int getBorderSize()

Returns:

The size of the Borderables's border.

getBorderStyle

public int getBorderStyle()

Returns the border style of the Borderable. This will be one of the following values :

• BORDER_DOTTED - a dotted border
• BORDER_DASHED - dashed border
• BORDER_SOLID - a solid border
• BORDER_DOUBLE - a double border
• BORDER_GROOVE - a 3D grooved border
• BORDER_RIDGE - a 3D ridge border
• BORDER_INSET - a 3D inset border
• BORDER_OUTSET - a 3D outset border

Returns:

int the current border style

setBorderColor

public void setBorderColor(nextapp.echo.Color borderColor)

Sets the Color of the Borderable's border. This will also set the left, top, right and bottom border color.

setBorderSize

public void setBorderSize(int borderSize)

Sets the size of the Borderables's border. This will also set the left, top, right and bottom border size.

setBorderStyle

public void setBorderStyle(int borderStyle)

Sets the border style of the Borderable. This must be one of the following values :

• BORDER_DOTTED - a dotted border
• BORDER_DASHED - dashed border
• BORDER_SOLID - a solid border
• BORDER_DOUBLE - a double border
• BORDER_GROOVE - a 3D grooved border
• BORDER_RIDGE - a 3D ridge border
• BORDER_INSET - a 3D inset border
• BORDER_OUTSET - a 3D outset border

This will also set the left, top, right and bottom border style.

applyStyle

public void applyStyle(nextapp.echo.Style style)

This will apply the borderColor, borderWidth and borderStyle properties first followed by the left, top, right and bottom borer properties.

See Also:

Component.applyStyle(nextapp.echo.Style)

getLeftBorderColor

public nextapp.echo.Color getLeftBorderColor()

Returns:

The Color of the Borderable's left border.

getLeftBorderSize

public int getLeftBorderSize()

Returns:

The size of the Borderables's left border.

getLeftBorderStyle

public int getLeftBorderStyle()

Returns:

The style of the Borderables's left border.

See Also:

getBorderStyle()

setLeftBorderColor

public void setLeftBorderColor(nextapp.echo.Color borderColor)

Sets the Color of the Borderable's left border.

setLeftBorderSize

public void setLeftBorderSize(int borderSize)

Sets the size of the Borderables's left border.

setLeftBorderStyle

public void setLeftBorderStyle(int borderStyle)

Sets the border style of the Borderables's left border.

See Also:

setBorderStyle(int)

getTopBorderColor

public nextapp.echo.Color getTopBorderColor()

Returns:

The Color of the Borderable's top border.

getTopBorderSize

public int getTopBorderSize()

Returns:

The size of the Borderables's top border.

getTopBorderStyle

public int getTopBorderStyle()

Returns:

The style of the Borderables's top border.

See Also:

getBorderStyle()

setTopBorderColor

public void setTopBorderColor(nextapp.echo.Color borderColor)

Sets the Color of the Borderable's top border.

setTopBorderSize

public void setTopBorderSize(int borderSize)

Sets the size of the Borderables's top border.

setTopBorderStyle

public void setTopBorderStyle(int borderStyle)

Sets the border style of the Borderables's top border.

See Also:

setBorderStyle(int)

getRightBorderColor

public nextapp.echo.Color getRightBorderColor()

Returns:

The Color of the Borderable's right border.

getRightBorderSize

public int getRightBorderSize()

Returns:

The size of the Borderables's right border.

getRightBorderStyle

public int getRightBorderStyle()

Returns:

The style of the Borderables's right border.

See Also:

getBorderStyle()

setRightBorderColor

public void setRightBorderColor(nextapp.echo.Color borderColor)

Sets the Color of the Borderable's right border.

setRightBorderSize

public void setRightBorderSize(int borderSize)

Sets the size of the Borderables's right border.

setRightBorderStyle

public void setRightBorderStyle(int borderStyle)

Sets the border style of the Borderables's right border.

See Also:

setBorderStyle(int)

getBottomBorderColor

public nextapp.echo.Color getBottomBorderColor()

Returns:

The Color of the Borderable's bottom border.

getBottomBorderSize

public int getBottomBorderSize()

Returns:

The size of the Borderables's bottom border.

getBottomBorderStyle

public int getBottomBorderStyle()

Returns:

The style of the Borderables's bottom border.

See Also:

getBorderStyle()

setBottomBorderColor

public void setBottomBorderColor(nextapp.echo.Color borderColor)

Sets the Color of the Borderable's bottom border.

setBottomBorderSize

public void setBottomBorderSize(int borderSize)

Sets the size of the Borderables's bottom border.

setBottomBorderStyle

public void setBottomBorderStyle(int borderStyle)

Sets the border style of the Borderables's bottom border.

See Also:

setBorderStyle(int)