echopoint.positionable
Class AbstractScrollableComponent

java.lang.Object
  nextapp.echo.AbstractComponent
      nextapp.echo.Container
          echopoint.EchoPointComponent
              echopoint.positionable.AbstractScrollableComponent

All Implemented Interfaces:

LayoutManageable, Borderable, Clippable, MouseCursorable, Positionable, Scrollable, ScrollableContainer, ToolTipPopUpSupport, ReflectionSetter, java.io.Serializable, Component, ToolTipSupport

Direct Known Subclasses:

ScrollableBox

public abstract class AbstractScrollableComponent
extends EchoPointComponent
implements ScrollableContainer

The AbstractScrollableComponent is a base component class that implements Scrollable, Postionable and Clippable via the all in one interface ScrollableContainer.

Use this as the basis of any positionable components if it is an appropriate base class.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class echopoint.EchoPointComponent

EchoPointComponent.NestedStyleInfo

Nested classes/interfaces inherited from interface echopoint.positionable.ScrollableContainer

ScrollableContainer.NestedStyleInfo

Field Summary

Fields inherited from class echopoint.EchoPointComponent

STYLE_TOOL_TIP_TEXT, TOOL_TIP_TEXT_CHANGED_PROPERTY, toolTipPopUp

Fields inherited from interface echopoint.positionable.ScrollableContainer

HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, INSETS_CHANGED_PROPERTY, STYLE_HORIZONTAL_ALIGNMENT, STYLE_INSETS, STYLE_VERTICAL_ALIGNMENT, VERTICAL_ALIGNMENT_CHANGED_PROPERTY

Fields inherited from interface echopoint.positionable.Scrollable

HEIGHT_CHANGED_PROPERTY, SCROLL_BAR_X_CHANGED_PROPERTY, SCROLL_BAR_Y_CHANGED_PROPERTY, SCROLLBAR_POLICY_CHANGED_PROPERTY, SCROLLBARS_ALWAYS, SCROLLBARS_AUTO, SCROLLBARS_CLIPHIDE, SCROLLBARS_NEVER, STYLE_HEIGHT, STYLE_SCROLL_BAR_POLICY, STYLE_WIDTH, UNDEFINED, undefinedSymbolic, WIDTH_CHANGED_PROPERTY

Fields inherited from interface echopoint.positionable.Positionable

POSITION_CHANGED_PROPERTY, POSITIONING_ABSOLUTE, POSITIONING_FLOW, POSITIONING_RELATIVE, positioningSymbolics, STYLE_BOTTOM, STYLE_LEFT, STYLE_POSITIONING, STYLE_RIGHT, STYLE_TOP, STYLE_ZINDEX, UNDEFINED, undefinedSymbolic

Fields inherited from interface echopoint.positionable.Clippable

CLIP_RECT_CHANGED_PROPERTY, STYLE_CLIP_RECT

Fields inherited from interface echopoint.positionable.Borderable

BORDER_DASHED, BORDER_DOTTED, BORDER_DOUBLE, BORDER_GROOVE, BORDER_INSET, BORDER_NONE, BORDER_OUTSET, BORDER_RIDGE, BORDER_SOLID, borderStyleSymbolics, STYLE_BORDER_COLOR, STYLE_BORDER_SIZE, STYLE_BORDER_STYLE, STYLE_BOTTOM_BORDER_COLOR, STYLE_BOTTOM_BORDER_SIZE, STYLE_BOTTOM_BORDER_STYLE, STYLE_LEFT_BORDER_COLOR, STYLE_LEFT_BORDER_SIZE, STYLE_LEFT_BORDER_STYLE, STYLE_RIGHT_BORDER_COLOR, STYLE_RIGHT_BORDER_SIZE, STYLE_RIGHT_BORDER_STYLE, STYLE_TOP_BORDER_COLOR, STYLE_TOP_BORDER_SIZE, STYLE_TOP_BORDER_STYLE

Fields inherited from interface echopoint.layout.LayoutManageable

LAYOUT_MANAGED_CHANGED_PROPERTY

Fields inherited from interface echopoint.positionable.MouseCursorable

borderStyleSymbolics, CURSOR_AUTO, CURSOR_CROSSHAIR, CURSOR_CUSTOM_URI, CURSOR_DEFAULT, CURSOR_E_RESIZE, CURSOR_HELP, CURSOR_MOVE, CURSOR_N_RESIZE, CURSOR_NE_RESIZE, CURSOR_NW_RESIZE, CURSOR_POINTER, CURSOR_S_RESIZE, CURSOR_SE_RESIZE, CURSOR_SW_RESIZE, CURSOR_TEXT, CURSOR_W_RESIZE, CURSOR_WAIT, STYLE_MOUSE_CURSOR, STYLE_MOUSE_CURSOR_URI

Fields inherited from interface nextapp.echo.Component

BACKGROUND_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FONT_CHANGED_PROPERTY, FOREGROUND_CHANGED_PROPERTY, IDENTIFIER_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, MODEL_CHANGED_PROPERTY, SELECTABLE_CHANGED_PROPERTY, STYLE_BACKGROUND, STYLE_FONT, STYLE_FOREGROUND, UPDATE_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

AbstractScrollableComponent()
Construct a AbstractScrollableComponent with no direct positioning in affect at all.

AbstractScrollableComponent(int left, int top)
Constructs a AbstractScrollableComponent with to right and bottom properties set to Positionable.UNDEFINED, a zIndex of 0 and with POSITIONING_ABSOLUTE, SCROLLBARS_NEVER and no clipping rectangle.

AbstractScrollableComponent(int left, int top, int right, int bottom)
Constructs a AbstractScrollableComponent with a zIndex of 0 and with POSITIONING_ABSOLUTE, SCROLLBARS_NEVER and no clipping rectangle.

AbstractScrollableComponent(int left, int top, int right, int bottom, int zIndex)
Constructs a AbstractScrollableComponent with POSITIONING_ABSOLUTE, SCROLLBARS_NEVER and no clipping rectangle.

AbstractScrollableComponent(int left, int top, int right, int bottom, int zIndex, int positioning)
Constructs a AbstractScrollableComponent with SCROLLBARS_NEVER and no clipping rectangle.

AbstractScrollableComponent(int left, int top, int right, int bottom, int zIndex, int positioning, int scrollBarPolicy)
Constructs a AbstractScrollableComponent

AbstractScrollableComponent(int left, int top, int right, int bottom, int zIndex, int positioning, int scrollBarPolicy, int[] clipRect)
Constructs a AbstractScrollableComponent with all the properties

Method Summary

void	add(Component c) Adds a Component to the AbstractScrollableComponent This method then informs any LayoutManager that is present.
void	add(Component c, int index) Adds a Component to the AbstractScrollableComponent at the specified index This method then informs any LayoutManager that is present.
void	add(Component comp, java.lang.Object constraints) Adds a Component to the AbstractScrollableComponent at the end of the list.
void	add(Component comp, java.lang.Object constraints, int index) Adds a Component to the AbstractScrollableComponent at the specified index.
protected void	addImpl(Component comp, java.lang.Object contraints, int index) The common implementation of add that notifies the LayoutManager if necessary
void	applyStyle(Style style) Sets stylistic properties of this component based on a Style object.
void	clearPositioning() This sets all the positioning attributes (left,top,right,bottom,z-index) to Integer.MAX, the positioning POSITIONING_FLOW and the scroll bar policy to SCROLLBAR_NONE.
Color	getBorderColor()
int	getBorderSize()
int	getBorderStyle() Returns the border style of the Borderable.
int	getBottom() Returns the bottom Y position of the component
Color	getBottomBorderColor()
int	getBottomBorderSize()
int	getBottomBorderStyle()
ClipRect	getClipRect() Returns the clipping rectangle on the component.
int	getHeight() Returns the height of the component
int	getHorizontalAlignment() Returns the horizontal alignment of the contents of this container.
LayoutManager	getLayoutManager() Returns the LayoutManager of the LayoutManageable container, or null if one is not present.
int	getLeft() Returns the left X position of the component
Color	getLeftBorderColor()
int	getLeftBorderSize()
int	getLeftBorderStyle()
int	getPositioning() This can be one of : POSITIONING_NONE POSITIONING_ABSOLUTE POSITIONING_RELATIVE
int	getRight() Returns the right X position of the component
Color	getRightBorderColor()
int	getRightBorderSize()
int	getRightBorderStyle()
int	getScreenHeight() This convenience method returns the current client screen height.
static int	getScreenHeight(EchoInstance instance) This convenience method returns the current client screen height.
int	getScreenWidth() This convenience method returns the current client screen width.
static int	getScreenWidth(EchoInstance instance) This convenience method returns the current client screen width.
int	getScrollBarPolicy() Returns the ScrollBarPolicy in place This can be one of : SCOLLBARS_NONE SCOLLBARS_ALWAYS SCOLLBARS_AUTO
int	getScrollBarX() Returns the position of the horizontal scroll bar, in pixels offset from the left of the component.
int	getScrollBarY() Returns the position of the vertical scroll bar, in pixels offset from the top the component.
int	getTop() Returns the top Y position of the component
Color	getTopBorderColor()
int	getTopBorderSize()
int	getTopBorderStyle()
int	getVerticalAlignment() Returns the vertical alignment of the contents of this container.
int	getWidth() Returns the width of the component
int	getzIndex() Returns the z-index of the component
boolean	isPositioned() This returns true if any positioning is in place
void	remove(Component c) Removes a component from the ScrollablePanel.
void	remove(int index) Removes a component from the ScrollablePanel at the given index.
java.lang.Object	set(java.lang.reflect.Field field, java.lang.Object newValue) Called to save the old value of a field, set in a new value and return the old value of a field.
void	setBorderColor(Color newBorderColor) Sets the Color of the Borderable's border.
void	setBorderSize(int newBorderSize) Sets the size of the Borderables's border.
void	setBorderStyle(int borderStyle) Sets the border style of the Borderable.
void	setBottom(int newValue) Sets the bottom Y position of the component
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	setClipRect(ClipRect clipRect) Sets the clipping rectangle of the component.
void	setClipRect(int[] clipRectArr) Sets the clipping rectangle of the component.
void	setClipRect(int x, int y, int width, int height) Sets the clipping rectangle of the component.
void	setHeight(int newValue) Sets the height of the component
void	setHorizontalAlignment(int newValue) Sets the horizontal alignment of the contents of this container.
void	setLayoutManager(LayoutManager newLayoutManager) Sets a new LayoutManager into the LayoutManageable container.
void	setLeft(int newValue) Set the left X position of the component
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	setPositioning(int newPositioning) Sets the positioning of the component This can be one of : POSITIONING_NONE POSITIONING_ABSOLUTE POSITIONING_RELATIVE
void	setRight(int newValue) Sets the right X position of the component
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	setScrollBarPolicy(int newScrollBarPolicy) This sets the scroll bar policy to use.
void	setScrollBarX(int newValue) Sets the position of the horizontal scroll bar, in pixels offset from the left of the component.
void	setScrollBarY(int newValue) Sets the position of the vertical scroll bar, in pixels offset from the top of the component.
void	setTop(int newValue) Sets the top Y position of the component
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.
void	setVerticalAlignment(int newValue) Sets the vertical alignment of the contents of this container.
void	setWidth(int newValue) Sets the width of the component
void	setzIndex(int newValue) Sets the z-index of the component

Methods inherited from class echopoint.EchoPointComponent

getMouseCursor, getMouseCursorURI, getToolTipPopUp, getToolTipText, set, set, set, set, set, set, set, set, set, setEnabledAllChildren, setMouseCursor, setMouseCursorURI, setToolTipText, validate

Methods inherited from class nextapp.echo.AbstractComponent

addHierarchyListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getClientId, getComponent, getComponentCount, getComponents, getEchoInstance, getFont, getForeground, getIdentifier, getListenerList, getLocale, getParent, indexOf, init, isAncestorOf, isDifferent, isEnabled, isFocused, isRecursivelyVisible, isRegistered, isSelectableForScriptRecorder, isShowing, isVisible, processHierarchyEvent, removeAll, removeHierarchyListener, removePropertyChangeListener, setBackground, setClientId, setEnabled, setFocused, setFont, setForeground, setIdentifier, setLocale, setParent, setRegistered, setSelectableForScriptRecorder, setVisible, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface echopoint.positionable.ScrollableContainer

getInsets, setInsets

Constructor Detail

AbstractScrollableComponent

public AbstractScrollableComponent()

Construct a AbstractScrollableComponent with no direct positioning in affect at all.

AbstractScrollableComponent

public AbstractScrollableComponent(int left,
                                   int top)

Constructs a AbstractScrollableComponent with to right and bottom properties set to Positionable.UNDEFINED, a zIndex of 0 and with POSITIONING_ABSOLUTE, SCROLLBARS_NEVER and no clipping rectangle.

AbstractScrollableComponent

public AbstractScrollableComponent(int left,
                                   int top,
                                   int right,
                                   int bottom)

Constructs a AbstractScrollableComponent with a zIndex of 0 and with POSITIONING_ABSOLUTE, SCROLLBARS_NEVER and no clipping rectangle.

AbstractScrollableComponent

public AbstractScrollableComponent(int left,
                                   int top,
                                   int right,
                                   int bottom,
                                   int zIndex)

Constructs a AbstractScrollableComponent with POSITIONING_ABSOLUTE, SCROLLBARS_NEVER and no clipping rectangle.

AbstractScrollableComponent

public AbstractScrollableComponent(int left,
                                   int top,
                                   int right,
                                   int bottom,
                                   int zIndex,
                                   int positioning)

Constructs a AbstractScrollableComponent with SCROLLBARS_NEVER and no clipping rectangle.

AbstractScrollableComponent

public AbstractScrollableComponent(int left,
                                   int top,
                                   int right,
                                   int bottom,
                                   int zIndex,
                                   int positioning,
                                   int scrollBarPolicy)

Constructs a AbstractScrollableComponent

AbstractScrollableComponent

public AbstractScrollableComponent(int left,
                                   int top,
                                   int right,
                                   int bottom,
                                   int zIndex,
                                   int positioning,
                                   int scrollBarPolicy,
                                   int[] clipRect)

Constructs a AbstractScrollableComponent with all the properties

Method Detail

add

public void add(Component c)

Adds a Component to the AbstractScrollableComponent

This method then informs any LayoutManager that is present.

Specified by:

add in interface LayoutManageable

Specified by:

add in interface Component

Overrides:

add in class AbstractComponent

Parameters:

c - The child component to add.

add

public void add(Component c,
                int index)

Adds a Component to the AbstractScrollableComponent at the specified index

This method then informs any LayoutManager that is present.

Specified by:

add in interface LayoutManageable

Specified by:

add in interface Component

Overrides:

add in class AbstractComponent

Parameters:

c - The child component to add.

index - The index at which to add the child component, or -1 to add the component at the end.

add

public void add(Component comp,
                java.lang.Object constraints)

Adds a Component to the AbstractScrollableComponent at the end of the list.

This method then informs any LayoutManager that is present.

Specified by:

add in interface LayoutManageable

add

public void add(Component comp,
                java.lang.Object constraints,
                int index)

Adds a Component to the AbstractScrollableComponent at the specified index.

This method then informs any LayoutManager that is present.

Specified by:

add in interface LayoutManageable

addImpl

protected void addImpl(Component comp,
                       java.lang.Object contraints,
                       int index)

The common implementation of add that notifies the LayoutManager if necessary

applyStyle

public void applyStyle(Style style)

Description copied from interface: Component

Sets stylistic properties of this component based on a Style object. The version of this method in Component will set foreground and background colors and the font from the style if they are present. Components should override this method if they allow more properties to be set from a style object, and should call super.applyStyle() if necessary.

Specified by:

applyStyle in interface Borderable

Specified by:

applyStyle in interface Clippable

Specified by:

applyStyle in interface MouseCursorable

Specified by:

applyStyle in interface Positionable

Specified by:

applyStyle in interface Scrollable

Specified by:

applyStyle in interface Component

Overrides:

applyStyle in class EchoPointComponent

Parameters:

style - The style object from which to retrieve properties for this Component.

See Also:

Component.applyStyle(nextapp.echo.Style)

clearPositioning

public void clearPositioning()

This sets all the positioning attributes (left,top,right,bottom,z-index) to Integer.MAX, the positioning POSITIONING_FLOW and the scroll bar policy to SCROLLBAR_NONE.

Specified by:

clearPositioning in interface Positionable

getBottom

public int getBottom()

Returns the bottom Y position of the component

Specified by:

getBottom in interface Positionable

getClipRect

public ClipRect getClipRect()

Returns the clipping rectangle on the component. This can be null or a ClipRect object.

Specified by:

getClipRect in interface Clippable

getHeight

public int getHeight()

Returns the height of the component

Specified by:

getHeight in interface Scrollable

getHorizontalAlignment

public int getHorizontalAlignment()

Returns the horizontal alignment of the contents of this container.

Specified by:

getHorizontalAlignment in interface ScrollableContainer

Returns:

The horizontal alignment of the contents of this container, one of the following values:

• EchoConstants.LEFT (the default)
• EchoConstants.CENTER
• EchoConstants.RIGHT

getLayoutManager

public LayoutManager getLayoutManager()

Returns the LayoutManager of the LayoutManageable container, or null if one is not present.

Specified by:

getLayoutManager in interface LayoutManageable

getLeft

public int getLeft()

Returns the left X position of the component

Specified by:

getLeft in interface Positionable

getPositioning

public int getPositioning()

This can be one of :

• POSITIONING_NONE
• POSITIONING_ABSOLUTE
• POSITIONING_RELATIVE

Specified by:

getPositioning in interface Positionable

getRight

public int getRight()

Returns the right X position of the component

Specified by:

getRight in interface Positionable

getScreenHeight

public int getScreenHeight()

This convenience method returns the current client screen height.

getScreenHeight

public static int getScreenHeight(EchoInstance instance)

This convenience method returns the current client screen height.

getScreenWidth

public int getScreenWidth()

This convenience method returns the current client screen width.

getScreenWidth

public static int getScreenWidth(EchoInstance instance)

This convenience method returns the current client screen width.

getScrollBarPolicy

public int getScrollBarPolicy()

Returns the ScrollBarPolicy in place This can be one of :

• SCOLLBARS_NONE
• SCOLLBARS_ALWAYS
• SCOLLBARS_AUTO

Specified by:

getScrollBarPolicy in interface Scrollable

getScrollBarX

public int getScrollBarX()

Returns the position of the horizontal scroll bar, in pixels offset from the left of the component.

Specified by:

getScrollBarX in interface Scrollable

Returns:

The position of the horizontal scroll bar.

getScrollBarY

public int getScrollBarY()

Returns the position of the vertical scroll bar, in pixels offset from the top the component.

Specified by:

getScrollBarY in interface Scrollable

Returns:

The position of the vertical scroll bar.

getTop

public int getTop()

Returns the top Y position of the component

Specified by:

getTop in interface Positionable

getVerticalAlignment

public int getVerticalAlignment()

Returns the vertical alignment of the contents of this container.

Specified by:

getVerticalAlignment in interface ScrollableContainer

Returns:

The vertical alignment of the contents of this container, one of the following values:

• EchoConstants.TOP (the default)
• EchoConstants.CENTER
• EchoConstants.BOTTOM

getWidth

public int getWidth()

Returns the width of the component

Specified by:

getWidth in interface Scrollable

getzIndex

public int getzIndex()

Returns the z-index of the component

Specified by:

getzIndex in interface Positionable

isPositioned

public boolean isPositioned()

This returns true if any positioning is in place

Specified by:

isPositioned in interface Positionable

remove

public void remove(int index)

Removes a component from the ScrollablePanel at the given index.

This method then informs any LayoutManager that is removed.

Specified by:

remove in interface LayoutManageable

Specified by:

remove in interface Component

Overrides:

remove in class AbstractComponent

Parameters:

index - The index of the child component to remove.

remove

public void remove(Component c)

Removes a component from the ScrollablePanel.

This method then informs any LayoutManager that is removed.

Specified by:

remove in interface LayoutManageable

Specified by:

remove in interface Component

Overrides:

remove in class AbstractComponent

Parameters:

c - The child component to remove.

setBottom

public void setBottom(int newValue)

Sets the bottom Y position of the component

Specified by:

setBottom in interface Positionable

setClipRect

public void setClipRect(int[] clipRectArr)

Sets the clipping rectangle of the component. This should be a 4 in array containing the clipping poath.

eg. new int { 2,3,10,15}

If no clipping is required, this should be set to null.

Specified by:

setClipRect in interface Clippable

setClipRect

public void setClipRect(int x,
                        int y,
                        int width,
                        int height)

Sets the clipping rectangle of the component.

Specified by:

setClipRect in interface Clippable

setClipRect

public void setClipRect(ClipRect clipRect)

Sets the clipping rectangle of the component. This should be a ClipRect object.

eg. new ClipRect{ 2,3,10,15}

If no clipping is required, this should be set to null.

Specified by:

setClipRect in interface Clippable

setHeight

public void setHeight(int newValue)

Sets the height of the component

Specified by:

setHeight in interface Scrollable

setHorizontalAlignment

public void setHorizontalAlignment(int newValue)

Sets the horizontal alignment of the contents of this container.

Specified by:

setHorizontalAlignment in interface ScrollableContainer

Parameters:

newValue - The horizontal alignment of the contents of this container, one of the following values.

• EchoConstants.LEFT (the default)
• EchoConstants.CENTER
• EchoConstants.RIGHT

setLayoutManager

public void setLayoutManager(LayoutManager newLayoutManager)

Sets a new LayoutManager into the LayoutManageable container.

Specified by:

setLayoutManager in interface LayoutManageable

setLeft

public void setLeft(int newValue)

Set the left X position of the component

Specified by:

setLeft in interface Positionable

setPositioning

public void setPositioning(int newPositioning)

Sets the positioning of the component This can be one of :

• POSITIONING_NONE
• POSITIONING_ABSOLUTE
• POSITIONING_RELATIVE

Specified by:

setPositioning in interface Positionable

setRight

public void setRight(int newValue)

Sets the right X position of the component

Specified by:

setRight in interface Positionable

setScrollBarPolicy

public void setScrollBarPolicy(int newScrollBarPolicy)

This sets the scroll bar policy to use. This can be one of :

• SCOLLBARS_NONE
• SCOLLBARS_ALWAYS
• SCOLLBARS_AUTO

Specified by:

setScrollBarPolicy in interface Scrollable

setScrollBarX

public void setScrollBarX(int newValue)

Sets the position of the horizontal scroll bar, in pixels offset from the left of the component.

Specified by:

setScrollBarX in interface Scrollable

Parameters:

newValue - The new position of the horizontal scroll bar, in pixels.

setScrollBarY

public void setScrollBarY(int newValue)

Sets the position of the vertical scroll bar, in pixels offset from the top of the component.

Specified by:

setScrollBarY in interface Scrollable

Parameters:

newValue - The new position of the vertical scroll bar, in pixels.

setTop

public void setTop(int newValue)

Sets the top Y position of the component

Specified by:

setTop in interface Positionable

setVerticalAlignment

public void setVerticalAlignment(int newValue)

Sets the vertical alignment of the contents of this container.

Specified by:

setVerticalAlignment in interface ScrollableContainer

Parameters:

newValue - The vertical alignment of the contents of this container, one of the following values.

• EchoConstants.TOP (the default)
• EchoConstants.CENTER
• EchoConstants.BOTTOM

setWidth

public void setWidth(int newValue)

Sets the width of the component

Specified by:

setWidth in interface Scrollable

setzIndex

public void setzIndex(int newValue)

Sets the z-index of the component

Specified by:

setzIndex in interface Positionable

getBorderColor

public Color getBorderColor()

Specified by:

getBorderColor in interface Borderable

Returns:

The Color of the Borderable's border.

See Also:

Borderable.getBorderColor()

getBorderSize

public int getBorderSize()

Specified by:

getBorderSize in interface Borderable

Returns:

The size of the Borderables's border.

See Also:

Borderable.getBorderSize()

getBorderStyle

public int getBorderStyle()

Description copied from interface: Borderable

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

Specified by:

getBorderStyle in interface Borderable

Returns:

int the current border style

See Also:

Borderable.getBorderStyle()

setBorderColor

public void setBorderColor(Color newBorderColor)

Description copied from interface: Borderable

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

Specified by:

setBorderColor in interface Borderable

See Also:

Borderable.setBorderColor(nextapp.echo.Color)

setBorderSize

public void setBorderSize(int newBorderSize)

Description copied from interface: Borderable

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

Specified by:

setBorderSize in interface Borderable

See Also:

Borderable.setBorderSize(int)

setBorderStyle

public void setBorderStyle(int borderStyle)

Description copied from interface: Borderable

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.

Specified by:

setBorderStyle in interface Borderable

See Also:

Borderable.setBorderStyle(int)

getLeftBorderColor

public Color getLeftBorderColor()

Specified by:

getLeftBorderColor in interface Borderable

Returns:

The Color of the Borderable's left border.

See Also:

Borderable.getLeftBorderColor()

getLeftBorderSize

public int getLeftBorderSize()

Specified by:

getLeftBorderSize in interface Borderable

Returns:

The size of the Borderables's left border.

See Also:

Borderable.getLeftBorderSize()

getLeftBorderStyle

public int getLeftBorderStyle()

Specified by:

getLeftBorderStyle in interface Borderable

Returns:

The style of the Borderables's left border.

See Also:

Borderable.getLeftBorderStyle()

setLeftBorderColor

public void setLeftBorderColor(Color borderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's left border.

Specified by:

setLeftBorderColor in interface Borderable

See Also:

Borderable.setLeftBorderColor(nextapp.echo.Color)

setLeftBorderSize

public void setLeftBorderSize(int borderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's left border.

Specified by:

setLeftBorderSize in interface Borderable

See Also:

Borderable.setLeftBorderSize(int)

setLeftBorderStyle

public void setLeftBorderStyle(int borderStyle)

Description copied from interface: Borderable

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

Specified by:

setLeftBorderStyle in interface Borderable

See Also:

Borderable.setLeftBorderStyle(int)

getTopBorderColor

public Color getTopBorderColor()

Specified by:

getTopBorderColor in interface Borderable

Returns:

The Color of the Borderable's top border.

See Also:

Borderable.getTopBorderColor()

getTopBorderSize

public int getTopBorderSize()

Specified by:

getTopBorderSize in interface Borderable

Returns:

The size of the Borderables's top border.

See Also:

Borderable.getTopBorderSize()

getTopBorderStyle

public int getTopBorderStyle()

Specified by:

getTopBorderStyle in interface Borderable

Returns:

The style of the Borderables's top border.

See Also:

Borderable.getTopBorderStyle()

setTopBorderColor

public void setTopBorderColor(Color borderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's top border.

Specified by:

setTopBorderColor in interface Borderable

See Also:

Borderable.setTopBorderColor(nextapp.echo.Color)

setTopBorderSize

public void setTopBorderSize(int borderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's top border.

Specified by:

setTopBorderSize in interface Borderable

See Also:

Borderable.setTopBorderSize(int)

setTopBorderStyle

public void setTopBorderStyle(int borderStyle)

Description copied from interface: Borderable

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

Specified by:

setTopBorderStyle in interface Borderable

See Also:

Borderable.setTopBorderStyle(int)

getRightBorderColor

public Color getRightBorderColor()

Specified by:

getRightBorderColor in interface Borderable

Returns:

The Color of the Borderable's right border.

See Also:

Borderable.getRightBorderColor()

getRightBorderSize

public int getRightBorderSize()

Specified by:

getRightBorderSize in interface Borderable

Returns:

The size of the Borderables's right border.

See Also:

Borderable.getRightBorderSize()

getRightBorderStyle

public int getRightBorderStyle()

Specified by:

getRightBorderStyle in interface Borderable

Returns:

The style of the Borderables's right border.

See Also:

Borderable.getRightBorderStyle()

setRightBorderColor

public void setRightBorderColor(Color borderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's right border.

Specified by:

setRightBorderColor in interface Borderable

See Also:

Borderable.setRightBorderColor(nextapp.echo.Color)

setRightBorderSize

public void setRightBorderSize(int borderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's right border.

Specified by:

setRightBorderSize in interface Borderable

See Also:

Borderable.setRightBorderSize(int)

setRightBorderStyle

public void setRightBorderStyle(int borderStyle)

Description copied from interface: Borderable

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

Specified by:

setRightBorderStyle in interface Borderable

See Also:

Borderable.setRightBorderStyle(int)

getBottomBorderColor

public Color getBottomBorderColor()

Specified by:

getBottomBorderColor in interface Borderable

Returns:

The Color of the Borderable's bottom border.

See Also:

Borderable.getBottomBorderColor()

getBottomBorderSize

public int getBottomBorderSize()

Specified by:

getBottomBorderSize in interface Borderable

Returns:

The size of the Borderables's bottom border.

See Also:

Borderable.getBottomBorderSize()

getBottomBorderStyle

public int getBottomBorderStyle()

Specified by:

getBottomBorderStyle in interface Borderable

Returns:

The style of the Borderables's bottom border.

See Also:

Borderable.getBottomBorderStyle()

setBottomBorderColor

public void setBottomBorderColor(Color borderColor)

Description copied from interface: Borderable

Sets the Color of the Borderable's bottom border.

Specified by:

setBottomBorderColor in interface Borderable

See Also:

Borderable.setBottomBorderColor(nextapp.echo.Color)

setBottomBorderSize

public void setBottomBorderSize(int borderSize)

Description copied from interface: Borderable

Sets the size of the Borderables's bottom border.

Specified by:

setBottomBorderSize in interface Borderable

See Also:

Borderable.setBottomBorderSize(int)

setBottomBorderStyle

public void setBottomBorderStyle(int borderStyle)

Description copied from interface: Borderable

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

Specified by:

setBottomBorderStyle in interface Borderable

See Also:

Borderable.setBottomBorderStyle(int)

set

public java.lang.Object set(java.lang.reflect.Field field,
                            java.lang.Object newValue)
                     throws java.lang.Exception

Description copied from interface: ReflectionSetter

Called to save the old value of a field, set in a new value and return the old value of a field. This interface allows a field set operation to be "delegated" back into the class that has permission to perform the field set.

 public Object set(Field f, Object newValue) throws Exception {
      Object oldValue = f.get(this);
      f.set(this,newValue);
      return oldValue;
 }
 

Specified by:

set in interface ReflectionSetter

Parameters:

field - - the field to be set

newValue - - the new value to be set

Returns:

the oldValue of the field

Throws:

java.lang.IllegalAccessException

java.lang.IllegalArgumentException

java.lang.NullPointerException

java.lang.Exception

See Also:

ReflectionSetter.set(Field, Object)