org.jdesktop.swingx
Enum ScrollableSizeHint

java.lang.Object
  extended by java.lang.Enum<ScrollableSizeHint>
      extended by org.jdesktop.swingx.ScrollableSizeHint
All Implemented Interfaces:
Serializable, Comparable<ScrollableSizeHint>

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

Enum Constant Summary
FIT
          Size should be adjusted to parent size.
HORIZONTAL_STRETCH
          Deprecated. 
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.
VERTICAL_STRETCH
          Deprecated. 
 
Method Summary
 boolean getTracksParentSize(JComponent component)
          Deprecated. 
 boolean getTracksParentSize(JComponent component, int orientation)
          Returns a boolean indicating whether the component's size should be adjusted to parent.
 boolean isHorizontalCompatible()
          Deprecated. 
 boolean isVerticalCompatible()
          Deprecated. 
static ScrollableSizeHint valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ScrollableSizeHint[] 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

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.


HORIZONTAL_STRETCH

@Deprecated
public static final ScrollableSizeHint HORIZONTAL_STRETCH
Deprecated. 
Width should be stretched to parent width if smaller, unchanged otherwise.


VERTICAL_STRETCH

@Deprecated
public static final ScrollableSizeHint VERTICAL_STRETCH
Deprecated. 
Width should be stretched to parent height if smaller, unchanged otherwise.

Method Detail

values

public static ScrollableSizeHint[] 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 (ScrollableSizeHint c : ScrollableSizeHint.values())
    System.out.println(c);

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

valueOf

public static ScrollableSizeHint 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

getTracksParentSize

@Deprecated
public boolean getTracksParentSize(JComponent component)
Deprecated. 

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

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

isHorizontalCompatible

@Deprecated
public boolean isHorizontalCompatible()
Deprecated. 

Returns a boolean indicating whether the hint can be used in horizontal orientation.

Returns:
a boolean indicating whether the hint can be used in horizontal orientation.

isVerticalCompatible

@Deprecated
public boolean isVerticalCompatible()
Deprecated. 

Returns a boolean indicating whether the hint can be used in vertical orientation.

Returns:
a boolean indicating whether the hint can be used in vertical orientation.


Copyright © 2012. All Rights Reserved.