Package org.jdesktop.swingx

Enum Class ScrollableSizeHint

java.lang.Object

java.lang.Enum<ScrollableSizeHint>

org.jdesktop.swingx.ScrollableSizeHint

All Implemented Interfaces:

Serializable, Comparable<ScrollableSizeHint>, java.lang.constant.Constable

public enum ScrollableSizeHint
extends Enum<ScrollableSizeHint>

Sizing hints for layout, useful f.i. in a Scrollable implementation.

Inspired by Rob Camick.

PENDING JW: naming... suggestions?
KS: I'd go with TrackingHint or ScrollableTrackingHint, since it is used in getScrollableTracksViewportXXX.

Author:

Jeanette Winzenburg, Karl Schaefer

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FIT	Size should be adjusted to parent size.
MINIMUM_STRETCH	Stretches the component when its parent is larger than its minimum size.
NONE	Size should be unchanged.
PREFERRED_STRETCH	Stretches the component when its parent is larger than its preferred size.

Method Summary

Modifier and Type	Method	Description
boolean	getTracksParentSize(JComponent component, int orientation)	Returns a boolean indicating whether the component's size should be adjusted to parent.
static ScrollableSizeHint	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScrollableSizeHint[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final ScrollableSizeHint NONE

Size should be unchanged.

FIT

public static final ScrollableSizeHint FIT

Size should be adjusted to parent size.

MINIMUM_STRETCH

public static final ScrollableSizeHint MINIMUM_STRETCH

Stretches the component when its parent is larger than its minimum size.

PREFERRED_STRETCH

public static final ScrollableSizeHint PREFERRED_STRETCH

Stretches the component when its parent is larger than its preferred size.

Method Details

values

public static ScrollableSizeHint[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ScrollableSizeHint valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getTracksParentSize

public boolean getTracksParentSize(JComponent component,
 int orientation)

Returns a boolean indicating whether the component's size should be adjusted to parent.

Parameters:

component - the component resize, must not be null

Returns:

a boolean indicating whether the component's size should be adjusted to parent

Throws:

NullPointerException - if component is null

IllegalArgumentException - if orientation is invalid