EchoPoint
1.0

echopoint.positionable
Interface ScrollableContainer

All Superinterfaces:
Borderable, Clippable, LayoutManageable, Positionable, Scrollable
All Known Implementing Classes:
AbstractScrollableComponent, ScrollableBox, ScrollablePanel

public interface ScrollableContainer
extends Scrollable, Positionable, Clippable, Borderable, LayoutManageable

The ScrollableContainer is a composite interface that indicates that component that can contain other components like a Panel and has extended support for Scrollable, Positionable, Clippable and Borderable attributes, as well as being able to have a layout manager.


Nested Class Summary
static class ScrollableContainer.NestedStyleInfo
          Nested public static StyleInfo class.
 
Field Summary
static java.lang.String HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY
          This property name is fired when the horizontal alignment changes
static java.lang.String INSETS_CHANGED_PROPERTY
          This property name is fired when the Insets change
static java.lang.String STYLE_HORIZONTAL_ALIGNMENT
          A style constant for the Horizontal Alignment property.
static java.lang.String STYLE_INSETS
          A style constant for the Insets property.
static java.lang.String STYLE_VERTICAL_ALIGNMENT
          A style constant for the Vertical Alignment property.
static java.lang.String VERTICAL_ALIGNMENT_CHANGED_PROPERTY
          This property name is fired when the vertical alignment changes
 
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
 
Method Summary
 int getHorizontalAlignment()
          Returns the horizontal alignment of the contents of this ScrollableContainer.
 nextapp.echo.Insets getInsets()
          Returns the insets of the ScrollableContainer.
 int getVerticalAlignment()
          Returns the vertical alignment of the contents of this ScrollableContainer.
 void setHorizontalAlignment(int newValue)
          Sets the horizontal alignment of the contents of this ScrollableContainer.
 void setInsets(nextapp.echo.Insets newValue)
          Sets the insets (margins) of the pane.
 void setVerticalAlignment(int newValue)
          Sets the vertical alignment of the contents of this ScrollableContainer.
 
Methods inherited from interface echopoint.positionable.Scrollable
applyStyle, getHeight, getScrollBarPolicy, getScrollBarX, getScrollBarY, getWidth, setHeight, setScrollBarPolicy, setScrollBarX, setScrollBarY, setWidth
 
Methods inherited from interface echopoint.positionable.Positionable
applyStyle, clearPositioning, getBottom, getLeft, getPositioning, getRight, getTop, getzIndex, isPositioned, setBottom, setLeft, setPositioning, setRight, setTop, setzIndex
 
Methods inherited from interface echopoint.positionable.Clippable
applyStyle, getClipRect, setClipRect, setClipRect, setClipRect
 
Methods inherited from interface echopoint.positionable.Borderable
applyStyle, getBorderColor, getBorderSize, getBorderStyle, getBottomBorderColor, getBottomBorderSize, getBottomBorderStyle, getLeftBorderColor, getLeftBorderSize, getLeftBorderStyle, getRightBorderColor, getRightBorderSize, getRightBorderStyle, getTopBorderColor, getTopBorderSize, getTopBorderStyle, setBorderColor, setBorderSize, setBorderStyle, setBottomBorderColor, setBottomBorderSize, setBottomBorderStyle, setLeftBorderColor, setLeftBorderSize, setLeftBorderStyle, setRightBorderColor, setRightBorderSize, setRightBorderStyle, setTopBorderColor, setTopBorderSize, setTopBorderStyle
 
Methods inherited from interface echopoint.layout.LayoutManageable
add, add, add, add, getLayoutManager, remove, remove, setLayoutManager
 

Field Detail

STYLE_HORIZONTAL_ALIGNMENT

public static final java.lang.String STYLE_HORIZONTAL_ALIGNMENT
A style constant for the Horizontal Alignment property. Values of this key must be of type java.lang.Integer.

See Also:
Constant Field Values

STYLE_INSETS

public static final java.lang.String STYLE_INSETS
A style constant for the Insets property. Values of this key must be of type nextapp.echo.Insets.

See Also:
Constant Field Values

STYLE_VERTICAL_ALIGNMENT

public static final java.lang.String STYLE_VERTICAL_ALIGNMENT
A style constant for the Vertical Alignment property. Values of this key must be of type java.lang.Integer.

See Also:
Constant Field Values

HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY

public static final java.lang.String HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY
This property name is fired when the horizontal alignment changes

See Also:
Constant Field Values

INSETS_CHANGED_PROPERTY

public static final java.lang.String INSETS_CHANGED_PROPERTY
This property name is fired when the Insets change

See Also:
Constant Field Values

VERTICAL_ALIGNMENT_CHANGED_PROPERTY

public static final java.lang.String VERTICAL_ALIGNMENT_CHANGED_PROPERTY
This property name is fired when the vertical alignment changes

See Also:
Constant Field Values
Method Detail

getHorizontalAlignment

public int getHorizontalAlignment()
Returns the horizontal alignment of the contents of this ScrollableContainer.

Returns:
The horizontal alignment of the contents of this ScrollableContainer, one of the following values:
  • EchoConstants.LEFT (the default)
  • EchoConstants.CENTER
  • EchoConstants.RIGHT

getInsets

public nextapp.echo.Insets getInsets()
Returns the insets of the ScrollableContainer.

Returns:
The insets of the ScrollableContainer.

getVerticalAlignment

public int getVerticalAlignment()
Returns the vertical alignment of the contents of this ScrollableContainer.

Returns:
The vertical alignment of the contents of this ScrollableContainer, one of the following values:
  • EchoConstants.TOP (the default)
  • EchoConstants.CENTER
  • EchoConstants.BOTTOM

setHorizontalAlignment

public void setHorizontalAlignment(int newValue)
Sets the horizontal alignment of the contents of this ScrollableContainer.

Parameters:
newValue - The horizontal alignment of the contents of this ScrollableContainer, one of the following values.
  • EchoConstants.LEFT (the default)
  • EchoConstants.CENTER
  • EchoConstants.RIGHT

setInsets

public void setInsets(nextapp.echo.Insets newValue)
Sets the insets (margins) of the pane.

Parameters:
newValue - An insets object that specifies the size of each margin of this pane.

setVerticalAlignment

public void setVerticalAlignment(int newValue)
Sets the vertical alignment of the contents of this ScrollableContainer.

Parameters:
newValue - The vertical alignment of the contents of this ScrollableContainer, one of the following values.
  • EchoConstants.TOP (the default)
  • EchoConstants.CENTER
  • EchoConstants.BOTTOM

EchoPoint
1.0