Package org.pushingpixels.substance.api

Enum SubstanceSlices.Side

java.lang.Object

java.lang.Enum<SubstanceSlices.Side>

org.pushingpixels.substance.api.SubstanceSlices.Side

Enclosing class:

SubstanceSlices

public static enum SubstanceSlices.Side
extends java.lang.Enum<SubstanceSlices.Side>

Enumerates available sides.

See Also:

SubstanceCortex.ComponentScope.setButtonOpenSide(JComponent, SubstanceSlices.Side), SubstanceCortex.ComponentScope.setButtonStraightSide(JComponent, SubstanceSlices.Side)

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTTOM	Bottom side.
LEFT	Left side.
RIGHT	Right side.
TOP	Top side.

Method Summary

Modifier and Type	Method	Description
static SubstanceSlices.Side	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static SubstanceSlices.Side[]	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

LEFT

public static final SubstanceSlices.Side LEFT

Left side.

RIGHT

public static final SubstanceSlices.Side RIGHT

Right side.

TOP

public static final SubstanceSlices.Side TOP

Top side.

BOTTOM

public static final SubstanceSlices.Side BOTTOM

Bottom side.

Method Detail

values

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

Returns:

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

valueOf

public static SubstanceSlices.Side 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