echopoint.positionable
Interface Scrollable

All Known Subinterfaces:

ScrollableContainer

All Known Implementing Classes:

AbstractScrollableComponent, EmbeddedPane, ScrollableBox, ScrollableDelegate, ScrollablePanel, SortableTable, TabbedPane, WizardPane

public interface Scrollable

A Scrollable is a component that can have a a fixed width and/or height, and can present scrollbars when the content of the component is too large to fit inside.

SCROLLBARS

Since a Scrollable can be made a fixed size, by setting its width and/or height properties, it has support for a scroll bar policy which controls how scroll bars are used if the content of the component will not fit into the fixed size.

If the scroll bar policy is SCROLLBARS_NEVER, then no scroll bars will be shown and the content inside the component will be clipped to the bounding rectangle.

If the scroll bar policy is SCROLLBARS_ALWAYS, then scroll bars will always be shown, regardless of whether the content is too big for the bounding rectangle, which allows the user to view all the content.

If the scroll bar policy is SCROLLBARS_AUTO, then scroll bars will be shown when appropriate, ie when the content is too big for the bounding rectangle.

width and height

If the properties, width and height, are set to either Integer.MAX_VALUE or Integer.MIN_VALUE, then it will not be taken into affect when rednering the component.

Nested Class Summary

static class

Scrollable.NestedStyleInfo Nested public static StyleInfo class.

Field Summary

static java.lang.String	HEIGHT_CHANGED_PROPERTY This property name is fired when the height value changes
static java.lang.String	SCROLL_BAR_X_CHANGED_PROPERTY This property name is fired when the scolling bar X value changes
static java.lang.String	SCROLL_BAR_Y_CHANGED_PROPERTY This property name is fired when the scolling bar Y value changes
static java.lang.String	SCROLLBAR_POLICY_CHANGED_PROPERTY This property name is fired when the scolling bar policy changes
static int	SCROLLBARS_ALWAYS A scroll bar policy that will cause scroll bars to always appear, without regard for whether they are required.
static int	SCROLLBARS_AUTO A scroll bar policy that will cause scroll bars to be visible if they are necessary, and invisible if they are not.
static int	SCROLLBARS_CLIPHIDE A scroll bar policy that will cause scroll bars never to appear, without regard for whether they are required.
static int	SCROLLBARS_NEVER A scroll bar policy that will cause scroll bars never to appear, without regard for whether they are required.
static java.lang.String	STYLE_HEIGHT A style constant for the Height property.
static java.lang.String	STYLE_SCROLL_BAR_POLICY A style constant for the ScrollBar Policy property.
static java.lang.String	STYLE_WIDTH A style constant for the Width property.
static int	UNDEFINED This can be used to indicate that an integer parameter is not define (ie should not be interpreseted).
static SymbolicValue[]	undefinedSymbolic Helper static SymbolicValue[] - UNDEFINED Symbolic
static java.lang.String	WIDTH_CHANGED_PROPERTY This property name is fired when the width value changes

Method Summary

void	applyStyle(nextapp.echo.Style style)
int	getHeight() Returns the height of the component
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	getWidth() Returns the width of the component
void	setHeight(int newValue) Sets the height of the component
void	setScrollBarPolicy(int newScrollBarPolicy) Sets the scroll bar policy of the component This can be one of : SCOLLBARS_NONE SCOLLBARS_ALWAYS SCOLLBARS_AUTO
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	setWidth(int newValue) Set the width of the component

Field Detail

UNDEFINED

public static final int UNDEFINED

This can be used to indicate that an integer parameter is not define (ie should not be interpreseted).

See Also:

Constant Field Values

SCROLLBARS_NEVER

public static final int SCROLLBARS_NEVER

A scroll bar policy that will cause scroll bars never to appear, without regard for whether they are required. Content is always be never clipped even if its to large for the components dimensions.

See Also:

Constant Field Values

SCROLLBARS_ALWAYS

public static final int SCROLLBARS_ALWAYS

A scroll bar policy that will cause scroll bars to always appear, without regard for whether they are required.

See Also:

Constant Field Values

SCROLLBARS_AUTO

public static final int SCROLLBARS_AUTO

A scroll bar policy that will cause scroll bars to be visible if they are necessary, and invisible if they are not.

See Also:

Constant Field Values

SCROLLBARS_CLIPHIDE

public static final int SCROLLBARS_CLIPHIDE

A scroll bar policy that will cause scroll bars never to appear, without regard for whether they are required. Content is always be clipped to the components dimensions and the scollbars are hidden.

See Also:

Constant Field Values

STYLE_HEIGHT

public static final java.lang.String STYLE_HEIGHT

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

See Also:

Constant Field Values

STYLE_SCROLL_BAR_POLICY

public static final java.lang.String STYLE_SCROLL_BAR_POLICY

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

See Also:

Constant Field Values

STYLE_WIDTH

public static final java.lang.String STYLE_WIDTH

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

See Also:

Constant Field Values

SCROLLBAR_POLICY_CHANGED_PROPERTY

public static final java.lang.String SCROLLBAR_POLICY_CHANGED_PROPERTY

This property name is fired when the scolling bar policy changes

See Also:

Constant Field Values

SCROLL_BAR_X_CHANGED_PROPERTY

public static final java.lang.String SCROLL_BAR_X_CHANGED_PROPERTY

This property name is fired when the scolling bar X value changes

See Also:

Constant Field Values

SCROLL_BAR_Y_CHANGED_PROPERTY

public static final java.lang.String SCROLL_BAR_Y_CHANGED_PROPERTY

This property name is fired when the scolling bar Y value changes

See Also:

Constant Field Values

HEIGHT_CHANGED_PROPERTY

public static final java.lang.String HEIGHT_CHANGED_PROPERTY

This property name is fired when the height value changes

See Also:

Constant Field Values

WIDTH_CHANGED_PROPERTY

public static final java.lang.String WIDTH_CHANGED_PROPERTY

This property name is fired when the width value changes

See Also:

Constant Field Values

undefinedSymbolic

public static final SymbolicValue[] undefinedSymbolic

Helper static SymbolicValue[] - UNDEFINED Symbolic

Method Detail

applyStyle

public void applyStyle(nextapp.echo.Style style)

See Also:

Component.applyStyle(nextapp.echo.Style)

getHeight

public int getHeight()

Returns the height of the component

getScrollBarPolicy

public int getScrollBarPolicy()

Returns the ScrollBarPolicy in place This can be one of :

• SCOLLBARS_NONE
• SCOLLBARS_ALWAYS
• SCOLLBARS_AUTO

getScrollBarX

public int getScrollBarX()

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

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.

Returns:

The position of the vertical scroll bar.

getWidth

public int getWidth()

Returns the width of the component

setHeight

public void setHeight(int newValue)

Sets the height of the component

setScrollBarPolicy

public void setScrollBarPolicy(int newScrollBarPolicy)

Sets the scroll bar policy of the component This can be one of :

• SCOLLBARS_NONE
• SCOLLBARS_ALWAYS
• SCOLLBARS_AUTO

setScrollBarX

public void setScrollBarX(int newValue)

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

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.

Parameters:

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

setWidth

public void setWidth(int newValue)

Set the width of the component