Package edu.wisc.ssec.mcidasv.ui

Enum Class UIManager.ActionAttribute

java.lang.Object

java.lang.Enum<UIManager.ActionAttribute>

edu.wisc.ssec.mcidasv.ui.UIManager.ActionAttribute

All Implemented Interfaces:

Serializable, Comparable<UIManager.ActionAttribute>, Constable

Enclosing class:

UIManager

protected static enum UIManager.ActionAttribute
extends Enum<UIManager.ActionAttribute>

Represents what McIDAS-V "knows" about IDV actions.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTION	Actual method call used to invoke a given IDV action.
DESCRIPTION	Brief description of a IDV action.
GROUP	Allows actions to be clustered into arbitrary groups.
ICON	Path to an icon for this action.
ID	Unique identifier for an IDV action.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	defaultValue	A blank String if this is a required attribute, or a String value to use in case this attribute has not been specified by a given IDV action.
private final String	idvString	String representation of this attribute as used by the IDV.
private final boolean	required	Whether or not this attribute is required.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ActionAttribute(String idvString)	Creates a constant that represents a required IDV action attribute.
private	ActionAttribute(String idvString, String defValue)	Creates a constant that represents an optional IDV action attribute.

Method Summary

Modifier and Type	Method	Description
String	asIdvString()
String	defaultValue()
boolean	isRequired()
static UIManager.ActionAttribute	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UIManager.ActionAttribute[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ID

public static final UIManager.ActionAttribute ID

Unique identifier for an IDV action. Required attribute.

See Also:

• IdvUIManager.ATTR_ID

ICON

public static final UIManager.ActionAttribute ICON

Path to an icon for this action. Currently required. Note that McIDAS-V differs from the IDV in that actions must support different icon sizes. This is implemented in McIDAS-V by simply having the value of this path be a valid "format string", such as image="/edu/wisc/ssec/mcidasv/resources/icons/toolbar/background-image%d.png"

The upshot is that this value will not be a valid path in McIDAS-V. Use either UIManager.IdvAction.getMenuIcon() or UIManager.IdvAction.getIconForStyle(edu.wisc.ssec.mcidasv.ui.UIManager.ToolbarStyle).

See Also:

• IdvUIManager.ATTR_IMAGE
• UIManager.IdvAction.getRawIconPath()
• UIManager.IdvAction.getMenuIcon()
• UIManager.IdvAction.getIconForStyle(edu.wisc.ssec.mcidasv.ui.UIManager.ToolbarStyle)

DESCRIPTION

public static final UIManager.ActionAttribute DESCRIPTION

Brief description of a IDV action. Required attribute.

See Also:

• IdvUIManager.ATTR_DESCRIPTION

GROUP

public static final UIManager.ActionAttribute GROUP

Allows actions to be clustered into arbitrary groups. Currently optional; defaults to "General".

See Also:

• IdvUIManager.ATTR_GROUP

ACTION

public static final UIManager.ActionAttribute ACTION

Actual method call used to invoke a given IDV action. Required attribute.

See Also:

• IdvUIManager.ATTR_ACTION

Field Details

defaultValue

private final String defaultValue

A blank String if this is a required attribute, or a String value to use in case this attribute has not been specified by a given IDV action.

idvString

private final String idvString

String representation of this attribute as used by the IDV.

See Also:

• asIdvString()

required

private final boolean required

Whether or not this attribute is required.

Constructor Details

ActionAttribute

private ActionAttribute(String idvString)

Creates a constant that represents a required IDV action attribute.

Parameters:

idvString - Corresponding IDV attribute String. Cannot be null.

Throws:

NullPointerException - if idvString is null.

ActionAttribute

private ActionAttribute(String idvString,
 String defValue)

Creates a constant that represents an optional IDV action attribute.

Parameters:

idvString - Corresponding IDV attribute String. Cannot be null.

defValue - Default value for actions that do not have this attribute. Cannot be null or an empty String.

Throws:

NullPointerException - if either idvString or defValue is null.

IllegalArgumentException - if defValue is an empty String.

Method Details

values

public static UIManager.ActionAttribute[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static UIManager.ActionAttribute valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

asIdvString

public String asIdvString()

Returns:

The String representation of this attribute, as is used by the IDV.

See Also:

• IdvUIManager.ATTR_ACTION
• IdvUIManager.ATTR_DESCRIPTION
• IdvUIManager.ATTR_GROUP
• IdvUIManager.ATTR_ID
• IdvUIManager.ATTR_IMAGE

defaultValue

public String defaultValue()

Returns:

"Default value" for this attribute. Blank Strings imply that the attribute is required (and thus lacks a true default value).

isRequired

public boolean isRequired()

Returns:

Whether or not this attribute is a required attribute for valid UIManager.IdvActions.