Enum ScrollBarOrientation

java.lang.Object
java.lang.Enum<ScrollBarOrientation>
com.explodingpixels.widgets.plaf.ScrollBarOrientation
All Implemented Interfaces:
Serializable, Comparable<ScrollBarOrientation>, java.lang.constant.Constable

public enum ScrollBarOrientation extends Enum<ScrollBarOrientation>
An orientation corresponding to a JScrollBar. The methods in this enumeration allow for orentation-agnostic calculations, which can be used when laying out a scroll bar. A scroll bar, regargless of it's orientation, has a length and thickness. These values correspond to different dimensions (x or y) depending on the orientation.
  • Enum Constant Details

  • Method Details

    • values

      public static ScrollBarOrientation[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static ScrollBarOrientation 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
    • getOrientation

      public static ScrollBarOrientation getOrientation(int swingScrollBarOrientation)
      Converts a Swing scroll bar orientation (either SwingConstants.HORIZONTAL or SwingConstants.VERTICAL to a ScrollBarOrientation.
      Parameters:
      swingScrollBarOrientation - the Swing scroll bar orientation, either SwingConstants.HORIZONTAL or SwingConstants.VERTICAL
      Returns:
      the ScrollBarOrientation to the corresponding Swing scroll bar orientation.
      Throws:
      IllegalArgumentException - if the given Swing scroll bar orientation is not valid.