Enum ScrollableSizeHint

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ScrollableSizeHint>

    public enum ScrollableSizeHint
    extends java.lang.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.

    • 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.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private ScrollableSizeHint()  
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      boolean getTracksParentSize​(javax.swing.JComponent component, int orientation)
      Returns a boolean indicating whether the component's size should be adjusted to parent.
      (package private) abstract boolean getTracksParentSizeImpl​(javax.swing.JComponent component, int orientation)
      Determines whether the supplied component is smaller than its parent; used to determine whether to track with the parents size.
      static ScrollableSizeHint valueOf​(java.lang.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

      • 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.
    • Constructor Detail

      • ScrollableSizeHint

        private ScrollableSizeHint()
    • 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​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getTracksParentSize

        public boolean getTracksParentSize​(javax.swing.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:
        java.lang.NullPointerException - if component is null
        java.lang.IllegalArgumentException - if orientation is invalid
      • getTracksParentSizeImpl

        abstract boolean getTracksParentSizeImpl​(javax.swing.JComponent component,
                                                 int orientation)
        Determines whether the supplied component is smaller than its parent; used to determine whether to track with the parents size.
        Parameters:
        component - the component to test
        orientation - the orientation to test
        Returns:
        true to track; false otherwise