Package com.explodingpixels.widgets.plaf
Enum ScrollBarOrientation
- All Implemented Interfaces:
Serializable
,Comparable<ScrollBarOrientation>
,java.lang.constant.Constable
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.-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionstatic ScrollBarOrientation
getOrientation
(int swingScrollBarOrientation) Converts a Swing scroll bar orientation (eitherSwingConstants.HORIZONTAL
orSwingConstants.VERTICAL
to aScrollBarOrientation
.static ScrollBarOrientation
Returns the enum constant of this type with the specified name.static ScrollBarOrientation[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
HORIZONTAL
-
VERTICAL
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getOrientation
Converts a Swing scroll bar orientation (eitherSwingConstants.HORIZONTAL
orSwingConstants.VERTICAL
to aScrollBarOrientation
.- Parameters:
swingScrollBarOrientation
- the Swing scroll bar orientation, eitherSwingConstants.HORIZONTAL
orSwingConstants.VERTICAL
- Returns:
- the
ScrollBarOrientation
to the corresponding Swing scroll bar orientation. - Throws:
IllegalArgumentException
- if the given Swing scroll bar orientation is not valid.
-