com.xmlmind.xmleditapp.desktop.toolbar

Enum ToolPosition

java.lang.Object

java.lang.Enum<ToolPosition>

com.xmlmind.xmleditapp.desktop.toolbar.ToolPosition

All Implemented Interfaces:

Serializable, Comparable<ToolPosition>

public enum ToolPosition
extends Enum<ToolPosition>

The position of a custom component hosted by ConfigSpecificToolBarItems relatively to sibling custom components of the same class.

This allows to nicely group similar custom components.

See Also:

ToolBarTool

Enum Constant Summary

Enum Constants

Enum Constant and Description
END The custom component is at the end of a group of similar custom components.
MIDDLE The custom component is in the middle of a group of similar custom components.
OTHER The custom component is neither at the start, middle or end of a group of similar custom components.
START The custom component is at the start of a group of similar custom components.

Method Summary

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

START

public static final ToolPosition START

The custom component is at the start of a group of similar custom components.

MIDDLE

public static final ToolPosition MIDDLE

The custom component is in the middle of a group of similar custom components.

END

public static final ToolPosition END

The custom component is at the end of a group of similar custom components.

OTHER

public static final ToolPosition OTHER

The custom component is neither at the start, middle or end of a group of similar custom components.

Method Detail

values

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

Returns:

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

valueOf

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