chemaxon.standardizer

Class StandardizerActionDescriptor

java.lang.Object

chemaxon.standardizer.StandardizerActionDescriptor

All Implemented Interfaces:

java.lang.Cloneable

@PublicAPI
public class StandardizerActionDescriptor
extends java.lang.Object
implements java.lang.Cloneable

Descriptor of StandardizerAction objects.
Contains all needed interface informations.

• Name of the action
• Description of the action
• Help text of the action
• Icon of the action

Contains all configuration identifier informations.

• XML tags of the action
• Action string tokens of the action

Since:

5.11

Author:

Imre Barna

Field Summary

Fields

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 Summary

Constructors

Constructor and Description
StandardizerActionDescriptor(java.lang.Class<? extends StandardizerAction> standardizerActionClass) Constructs a descriptor based on standardizer action class.

Method Summary

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()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ID

public static final java.lang.String ID

id property of action

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

name property of action

See Also:

Constant Field Values

HELP_TEXT

public static final java.lang.String HELP_TEXT

help text for action

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

description of action

See Also:

Constant Field Values

ACTIONSTRING_TOKEN

public static final java.lang.String ACTIONSTRING_TOKEN

action string token of the action

See Also:

Constant Field Values

XML_TOKEN

public static final java.lang.String XML_TOKEN

xml token of the action

See Also:

Constant Field Values

ICON_PATH

public static final java.lang.String ICON_PATH

icon path of action

See Also:

Constant Field Values

TAGS

public static final java.lang.String TAGS

tags of action

See Also:

Constant Field Values

EDITOR_CLASS_NAME

public static final java.lang.String EDITOR_CLASS_NAME

editor class name property of standardizer action

See Also:

Constant Field Values

Constructor Detail

StandardizerActionDescriptor

public StandardizerActionDescriptor(java.lang.Class<? extends StandardizerAction> standardizerActionClass)
                             throws java.lang.IllegalArgumentException

Constructs a descriptor based on standardizer action class.
The annotation StandardizerActionInfo of the specified class will be used for descriptor generation.

Parameters:

standardizerActionClass - the class used to generate descriptor

Throws:

java.lang.IllegalArgumentException - if the standardizerActionClass is null

Method Detail

getId

public java.lang.String getId()

Gets the id of the action

Returns:

the id of the action

getName

public java.lang.String getName()

Gets the name of the action

Returns:

the name of the action

getActionStringTokens

public java.lang.String[] getActionStringTokens()

Gets the action string tokens of the action

Returns:

the action string tokens of the action

getXMLTokens

public java.lang.String[] getXMLTokens()

Gets the XML tokens of the action

Returns:

the XML tokens of the action

getDescription

public java.lang.String getDescription()

Gets the description of the action

Returns:

the description of the action

getHelpText

public java.lang.String getHelpText()

Gets the help text of the action

Returns:

the help text of the action

getIconPath

public java.lang.String getIconPath()

Gets the path of icon associated to the action

Returns:

the path of icon associated to the action

getTags

public java.lang.String[] getTags()

Gets the tags associated to the action

Returns:

the tags associated to the action

setId

public void setId(java.lang.String id)

Sets the id of the action

Parameters:

id - the id of the action

setName

public void setName(java.lang.String name)

Sets the name of the action

Parameters:

name - the name of the action

setActionStringTokens

public void setActionStringTokens(java.lang.String... actionStringTokens)

Sets the action string tokens of the action

Parameters:

actionStringTokens - the action string tokens of the action

setXMLTokens

public void setXMLTokens(java.lang.String... xmlTokens)

Sets the XML tokens of the action

Parameters:

xmlTokens - the XML tokens of the action

setTags

public void setTags(java.lang.String... tags)

Sets the tags of the action

Parameters:

tags - the tags of the action

setDescription

public void setDescription(java.lang.String description)

Sets the description of the action

Parameters:

description - the description of the action

setHelpText

public void setHelpText(java.lang.String helpText)

Sets the help text of the action

Parameters:

helpText - the help text of the action

setIconPath

public void setIconPath(java.lang.String iconPath)

Sets the path of icon associated to the action

Parameters:

iconPath - the path of icon associated to the action

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)

Remove a PropertyChangeListener for a specific property. If 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.

Parameters:

propertyName - The name of the property that was listened on.

listener - The PropertyChangeListener to be removed

See Also:

PropertyChangeSupport.removePropertyChangeListener(String, PropertyChangeListener)

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)

Add a PropertyChangeListener for a specific property. The listener will be invoked only when a call on firePropertyChange names that specific property. The same listener object may be added more than once. For each property, the listener will be invoked the number of times it was added for that property. If propertyName or listener is null, no exception is thrown and no action is taken.

Parameters:

propertyName - The name of the property to listen on.

listener - The PropertyChangeListener to be added

See Also:

PropertyChangeSupport.addPropertyChangeListener(String, PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties. If 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.

Parameters:

listener - The PropertyChangeListener to be removed

See Also:

PropertyChangeSupport.removePropertyChangeListener(PropertyChangeListener)

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Add a PropertyChangeListener to the listener list. The listener is registered for all properties. The same listener object may be added more than once, and will be called as many times as it is added. If listener is null, no exception is thrown and no action is taken.

Parameters:

listener - The PropertyChangeListener to be added

See Also:

PropertyChangeSupport.addPropertyChangeListener(PropertyChangeListener)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getIcon

public javax.swing.Icon getIcon()

Returns the Icon related to iconPath property

Returns:

the Icon related to iconPath property

getEditorClassName

public java.lang.String getEditorClassName()

Returns the editorClassName

Returns:

the editorClassName

setEditorClassName

public void setEditorClassName(java.lang.String editorClassName)

Sets the editorClassName

Parameters:

editorClassName - the editorClassName to set

isLicensed

public boolean isLicensed()

Returns true if this action can be used in current license environment.

Returns:

true if this action can be used in current license environment

Since:

6.0

clone

public StandardizerActionDescriptor clone()
                                   throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException