org.apache.pivot.wtk
Enum ScrollPane.ScrollBarPolicy

java.lang.Object
  extended by java.lang.Enum<ScrollPane.ScrollBarPolicy>
      extended by org.apache.pivot.wtk.ScrollPane.ScrollBarPolicy
All Implemented Interfaces:
Serializable, Comparable<ScrollPane.ScrollBarPolicy>
Enclosing class:
ScrollPane

public static enum ScrollPane.ScrollBarPolicy
extends Enum<ScrollPane.ScrollBarPolicy>

Enumeration defining when to show a scroll bar, and if not showing, whether to constrain the pane's content to the size of the ScrollPane, or to let the content be shown at its unconstrained size.


Enum Constant Summary
ALWAYS
          Always show the scroll bar, and don't affect the layout of the pane's content.
AUTO
          Show the scroll bar if the pane's content exceeds the size of the pane in the relevant dimension.
FILL
          Do not show the scroll bar, and cause the pane's content to be laid out to exactly fill the available space in the relevant dimension of the pane.
FILL_TO_CAPACITY
          Show the scroll bar if the pane's content exceeds the size of the pane in the relevant dimension; if it does not, act like FILL, omitting the scroll bar and causing the pane's content to fill the available space in the relevant dimension of the pane.
NEVER
          Never show the scroll bar, and don't affect the layout of the pane's content.
 
Method Summary
static ScrollPane.ScrollBarPolicy valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ScrollPane.ScrollBarPolicy[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

AUTO

public static final ScrollPane.ScrollBarPolicy AUTO
Show the scroll bar if the pane's content exceeds the size of the pane in the relevant dimension. Does not have any effect on the layout of the content. This is the default setting.


NEVER

public static final ScrollPane.ScrollBarPolicy NEVER
Never show the scroll bar, and don't affect the layout of the pane's content.


ALWAYS

public static final ScrollPane.ScrollBarPolicy ALWAYS
Always show the scroll bar, and don't affect the layout of the pane's content.


FILL

public static final ScrollPane.ScrollBarPolicy FILL
Do not show the scroll bar, and cause the pane's content to be laid out to exactly fill the available space in the relevant dimension of the pane.


FILL_TO_CAPACITY

public static final ScrollPane.ScrollBarPolicy FILL_TO_CAPACITY
Show the scroll bar if the pane's content exceeds the size of the pane in the relevant dimension; if it does not, act like FILL, omitting the scroll bar and causing the pane's content to fill the available space in the relevant dimension of the pane.

Method Detail

values

public static ScrollPane.ScrollBarPolicy[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (ScrollPane.ScrollBarPolicy c : ScrollPane.ScrollBarPolicy.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static ScrollPane.ScrollBarPolicy valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null