echopoint.positionable
Interface Borderable

All Known Subinterfaces:

ScrollableContainer

All Known Implementing Classes:

AbstractButton, AbstractDateTimeField, AbstractScrollableComponent, AskScriptNameDialog, AskVariableNameDialog, BorderableDelegate, BoxSection, ClientDatePicker, ComboBox, ComponentInspectorDialog, ConfirmButton, DateEditor, DateField, DateTimeEditor, Dialog, DialogPanel, DropDownBox, DynaButton, DynaColorChooserDialog, DynaConfirmButton, DynaDateField, DynaDateTimeField, DynaLabel, DynaQuickSelectFieldDialog, DynaSaveButton, DynaTableSortDialog, DynaTimeField, EmbeddedPane, ExitButton, ExpandableSection, GridPanel, GroupBox, HidingSlidingPanel, HorizontalPanel, HtmlTemplatePanel, InsetsEditorDialog, JavaBeanPropertyEditorDialog, JavaScriptButton, JspTemplatePanel, Label, NewsTicker, NumberFormatField, PagedTableController, Panel, PasswordField, PickScriptVariableDialog, PushButton, RecallComboBox, ReRunButton, ScrapDialog, ScrollableBox, ScrollablePanel, ScrollablePanel2, SelectScriptDialog, ServerFileNameDialog, SpinField, StackTraceViewerDialog, StopButton, StringViewer, StyleManagerEditStyleDialog, SubmitButton, TestDialog, TextField, TimeField, TimeViewer, TitleBar, ValidationDialog, ViewStackTraceButton

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 byte	BORDER_DASHED Defines a dashed border
static byte	BORDER_DOTTED Defines a dotted border
static byte	BORDER_DOUBLE Defines two borders.
static byte	BORDER_GROOVE Defines a 3D grooved border
static byte	BORDER_INSET Defines a 3D inset border
static byte	BORDER_NONE Defines no border
static byte	BORDER_OUTSET Defines a 3D outset border
static byte	BORDER_RIDGE Defines a 3D ridged border
static byte	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(Style style) This will apply the borderColor, borderWidth and borderStyle properties first followed by the left, top, right and bottom borer properties.
Color	getBorderColor()
int	getBorderSize()
int	getBorderStyle() Returns the border style of the Borderable.
Color	getBottomBorderColor()
int	getBottomBorderSize()
int	getBottomBorderStyle()
Color	getLeftBorderColor()
int	getLeftBorderSize()
int	getLeftBorderStyle()
Color	getRightBorderColor()
int	getRightBorderSize()
int	getRightBorderStyle()
Color	getTopBorderColor()
int	getTopBorderSize()
int	getTopBorderStyle()
void	setBorderColor(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(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(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(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(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

static final byte BORDER_NONE

Defines no border

See Also:

Constant Field Values

BORDER_SOLID

static final byte BORDER_SOLID

Defines a solid border

See Also:

Constant Field Values

BORDER_INSET

static final byte BORDER_INSET

Defines a 3D inset border

See Also:

Constant Field Values

BORDER_DOTTED

static final byte BORDER_DOTTED

Defines a dotted border

See Also:

Constant Field Values

BORDER_DOUBLE

static final byte 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

static final byte BORDER_GROOVE

Defines a 3D grooved border

See Also:

Constant Field Values

BORDER_RIDGE

static final byte BORDER_RIDGE

Defines a 3D ridged border

See Also:

Constant Field Values

BORDER_DASHED

static final byte BORDER_DASHED

Defines a dashed border

See Also:

Constant Field Values

BORDER_OUTSET

static final byte BORDER_OUTSET

Defines a 3D outset border

See Also:

Constant Field Values

STYLE_BORDER_COLOR

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static final SymbolicValue[] borderStyleSymbolics

Helper static SymbolicValue[] - Borderable borderStyle Symbolics

Method Detail

getBorderColor

Color getBorderColor()

Returns:

The Color of the Borderable's border.

getBorderSize

int getBorderSize()

Returns:

The size of the Borderables's border.

getBorderStyle

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

void setBorderColor(Color borderColor)

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

setBorderSize

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

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

void applyStyle(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

Color getLeftBorderColor()

Returns:

The Color of the Borderable's left border.

getLeftBorderSize

int getLeftBorderSize()

Returns:

The size of the Borderables's left border.

getLeftBorderStyle

int getLeftBorderStyle()

Returns:

The style of the Borderables's left border.

See Also:

getBorderStyle()

setLeftBorderColor

void setLeftBorderColor(Color borderColor)

Sets the Color of the Borderable's left border.

setLeftBorderSize

void setLeftBorderSize(int borderSize)

Sets the size of the Borderables's left border.

setLeftBorderStyle

void setLeftBorderStyle(int borderStyle)

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

See Also:

setBorderStyle(int)

getTopBorderColor

Color getTopBorderColor()

Returns:

The Color of the Borderable's top border.

getTopBorderSize

int getTopBorderSize()

Returns:

The size of the Borderables's top border.

getTopBorderStyle

int getTopBorderStyle()

Returns:

The style of the Borderables's top border.

See Also:

getBorderStyle()

setTopBorderColor

void setTopBorderColor(Color borderColor)

Sets the Color of the Borderable's top border.

setTopBorderSize

void setTopBorderSize(int borderSize)

Sets the size of the Borderables's top border.

setTopBorderStyle

void setTopBorderStyle(int borderStyle)

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

See Also:

setBorderStyle(int)

getRightBorderColor

Color getRightBorderColor()

Returns:

The Color of the Borderable's right border.

getRightBorderSize

int getRightBorderSize()

Returns:

The size of the Borderables's right border.

getRightBorderStyle

int getRightBorderStyle()

Returns:

The style of the Borderables's right border.

See Also:

getBorderStyle()

setRightBorderColor

void setRightBorderColor(Color borderColor)

Sets the Color of the Borderable's right border.

setRightBorderSize

void setRightBorderSize(int borderSize)

Sets the size of the Borderables's right border.

setRightBorderStyle

void setRightBorderStyle(int borderStyle)

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

See Also:

setBorderStyle(int)

getBottomBorderColor

Color getBottomBorderColor()

Returns:

The Color of the Borderable's bottom border.

getBottomBorderSize

int getBottomBorderSize()

Returns:

The size of the Borderables's bottom border.

getBottomBorderStyle

int getBottomBorderStyle()

Returns:

The style of the Borderables's bottom border.

See Also:

getBorderStyle()

setBottomBorderColor

void setBottomBorderColor(Color borderColor)

Sets the Color of the Borderable's bottom border.

setBottomBorderSize

void setBottomBorderSize(int borderSize)

Sets the size of the Borderables's bottom border.

setBottomBorderStyle

void setBottomBorderStyle(int borderStyle)

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

See Also:

setBorderStyle(int)