@PublicAPI public class StandardizerActionDescriptor extends java.lang.Object implements java.lang.Cloneable
StandardizerAction
objects.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ACTIONSTRING_TOKEN
action string token of the action
|
static java.lang.String |
DESCRIPTION
description of action
|
static java.lang.String |
EDITOR_CLASS_NAME
editor class name property of standardizer action
|
static java.lang.String |
HELP_TEXT
help text for action
|
static java.lang.String |
ICON_PATH
icon path of action
|
static java.lang.String |
ID
id property of action
|
static java.lang.String |
NAME
name property of action
|
static java.lang.String |
TAGS
tags of action
|
static java.lang.String |
XML_TOKEN
xml token of the action
|
Constructor and Description |
---|
StandardizerActionDescriptor(java.lang.Class<? extends StandardizerAction> standardizerActionClass)
Constructs a descriptor based on standardizer action class.
|
Modifier and Type | Method and Description |
---|---|
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Add a PropertyChangeListener to the listener list.
|
void |
addPropertyChangeListener(java.lang.String propertyName,
java.beans.PropertyChangeListener listener)
Add a PropertyChangeListener for a specific property.
|
StandardizerActionDescriptor |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String[] |
getActionStringTokens()
Gets the action string tokens of the action
|
java.lang.String |
getDescription()
Gets the description of the action
|
java.lang.String |
getEditorClassName()
Returns the editorClassName
|
java.lang.String |
getHelpText()
Gets the help text of the action
|
javax.swing.Icon |
getIcon()
Returns the
Icon related to iconPath property |
java.lang.String |
getIconPath()
Gets the path of icon associated to the action
|
java.lang.String |
getId()
Gets the id of the action
|
java.lang.String |
getName()
Gets the name of the action
|
java.lang.String[] |
getTags()
Gets the tags associated to the action
|
java.lang.String[] |
getXMLTokens()
Gets the XML tokens of the action
|
int |
hashCode() |
boolean |
isLicensed()
Returns
true if this action can be used in current license environment. |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Remove a PropertyChangeListener from the listener list.
|
void |
removePropertyChangeListener(java.lang.String propertyName,
java.beans.PropertyChangeListener listener)
Remove a PropertyChangeListener for a specific property.
|
void |
setActionStringTokens(java.lang.String... actionStringTokens)
Sets the action string tokens of the action
|
void |
setDescription(java.lang.String description)
Sets the description of the action
|
void |
setEditorClassName(java.lang.String editorClassName)
Sets the editorClassName
|
void |
setHelpText(java.lang.String helpText)
Sets the help text of the action
|
void |
setIconPath(java.lang.String iconPath)
Sets the path of icon associated to the action
|
void |
setId(java.lang.String id)
Sets the id of the action
|
void |
setName(java.lang.String name)
Sets the name of the action
|
void |
setTags(java.lang.String... tags)
Sets the tags of the action
|
void |
setXMLTokens(java.lang.String... xmlTokens)
Sets the XML tokens of the action
|
java.lang.String |
toString() |
public static final java.lang.String ID
public static final java.lang.String NAME
public static final java.lang.String HELP_TEXT
public static final java.lang.String DESCRIPTION
public static final java.lang.String ACTIONSTRING_TOKEN
public static final java.lang.String XML_TOKEN
public static final java.lang.String ICON_PATH
public static final java.lang.String TAGS
public static final java.lang.String EDITOR_CLASS_NAME
public StandardizerActionDescriptor(java.lang.Class<? extends StandardizerAction> standardizerActionClass) throws java.lang.IllegalArgumentException
StandardizerActionInfo
of the specified class will be used for descriptor generation.standardizerActionClass
- the class used to generate descriptorjava.lang.IllegalArgumentException
- if the standardizerActionClass is nullpublic java.lang.String getId()
public java.lang.String getName()
public java.lang.String[] getActionStringTokens()
public java.lang.String[] getXMLTokens()
public java.lang.String getDescription()
public java.lang.String getHelpText()
public java.lang.String getIconPath()
public java.lang.String[] getTags()
public void setId(java.lang.String id)
id
- the id of the actionpublic void setName(java.lang.String name)
name
- the name of the actionpublic void setActionStringTokens(java.lang.String... actionStringTokens)
actionStringTokens
- the action string tokens of the actionpublic void setXMLTokens(java.lang.String... xmlTokens)
xmlTokens
- the XML tokens of the actionpublic void setTags(java.lang.String... tags)
tags
- the tags of the actionpublic void setDescription(java.lang.String description)
description
- the description of the actionpublic void setHelpText(java.lang.String helpText)
helpText
- the help text of the actionpublic void setIconPath(java.lang.String iconPath)
iconPath
- the path of icon associated to the actionpublic void removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
listener
was added more than once to the
same event source for the specified property, it will be notified one less time after being removed. If
propertyName
is null, no exception is thrown and no action is taken. If listener
is
null, or was never added for the specified property, no exception is thrown and no action is taken.propertyName
- The name of the property that was listened on.listener
- The PropertyChangeListener to be removedPropertyChangeSupport.removePropertyChangeListener(String, PropertyChangeListener)
public void addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
propertyName
or listener
is null, no exception is thrown and no action is taken.propertyName
- The name of the property to listen on.listener
- The PropertyChangeListener to be addedPropertyChangeSupport.addPropertyChangeListener(String, PropertyChangeListener)
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
was added more than once to the same event source, it will be
notified one less time after being removed. If listener
is null, or was never added, no exception is
thrown and no action is taken.listener
- The PropertyChangeListener to be removedPropertyChangeSupport.removePropertyChangeListener(PropertyChangeListener)
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
is null, no exception is thrown and no action is taken.listener
- The PropertyChangeListener to be addedPropertyChangeSupport.addPropertyChangeListener(PropertyChangeListener)
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public javax.swing.Icon getIcon()
Icon
related to iconPath propertyIcon
related to iconPath propertypublic java.lang.String getEditorClassName()
public void setEditorClassName(java.lang.String editorClassName)
editorClassName
- the editorClassName to setpublic boolean isLicensed()
true
if this action can be used in current license environment.true
if this action can be used in current license environmentpublic StandardizerActionDescriptor clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException