Sweet Home 3D 4.1

com.eteks.sweethome3d.plugin
Enum PluginAction.Property

java.lang.Object
  extended by java.lang.Enum<PluginAction.Property>
      extended by com.eteks.sweethome3d.plugin.PluginAction.Property
All Implemented Interfaces:
Serializable, Comparable<PluginAction.Property>
Enclosing class:
PluginAction

public static enum PluginAction.Property
extends Enum<PluginAction.Property>

Enumeration of the various properties this action may define.


Enum Constant Summary
ENABLED
          The key of the property of Boolean type that specifies if an action is enabled or not.
MENU
          The key of the property of String type that specifies in which menu of the main menu bar an action should appear.
MNEMONIC
          The key of the property of Character type that specifies the ASCII character used as the mnemonic of an action.
NAME
          The key of the property of String type that specifies the name of an action, used for a menu or button.
SHORT_DESCRIPTION
          The key of the property of String type that specifies a short description of an action, used for tool tip text.
SMALL_ICON
          The key of the property of Content type that specifies an image content of an action, used for tool bar buttons.
TOOL_BAR
          The key of the property of Boolean type that specifies if an action will appear in the main tool bar.
 
Method Summary
static PluginAction.Property valueOf(String name)
          Returns the enum constant of this type with the specified name.
static PluginAction.Property[] 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

NAME

public static final PluginAction.Property NAME
The key of the property of String type that specifies the name of an action, used for a menu or button.


SHORT_DESCRIPTION

public static final PluginAction.Property SHORT_DESCRIPTION
The key of the property of String type that specifies a short description of an action, used for tool tip text.


SMALL_ICON

public static final PluginAction.Property SMALL_ICON
The key of the property of Content type that specifies an image content of an action, used for tool bar buttons.


MNEMONIC

public static final PluginAction.Property MNEMONIC
The key of the property of Character type that specifies the ASCII character used as the mnemonic of an action.


TOOL_BAR

public static final PluginAction.Property TOOL_BAR
The key of the property of Boolean type that specifies if an action will appear in the main tool bar.


MENU

public static final PluginAction.Property MENU
The key of the property of String type that specifies in which menu of the main menu bar an action should appear.


ENABLED

public static final PluginAction.Property ENABLED
The key of the property of Boolean type that specifies if an action is enabled or not.

Method Detail

values

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

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

valueOf

public static PluginAction.Property 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

Sweet Home 3D 4.1

© Copyrights 2006-2013 eTeks - All rights reserved
Distributed under GNU General Public License