Package chemaxon.standardizer

Class StandardizerActionDescriptor

  • All Implemented Interfaces:
    Cloneable
    @PublicAPI
public class StandardizerActionDescriptor
extends Object
implements 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

    • Constructor Detail

      • StandardizerActionDescriptor

        public StandardizerActionDescriptor​(Class<? extends StandardizerAction> standardizerActionClass)
                             throws 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:
        IllegalArgumentException - if the standardizerActionClass is null

    • Method Detail

      • getId

        public String getId()
        Gets the id of the action
        Returns:
        the id of the action

      • getName

        public String getName()
        Gets the name of the action
        Returns:
        the name of the action

      • getActionStringTokens

        public String[] getActionStringTokens()
        Gets the action string tokens of the action
        Returns:
        the action string tokens of the action

      • getXMLTokens

        public String[] getXMLTokens()
        Gets the XML tokens of the action
        Returns:
        the XML tokens of the action

      • getDescription

        public String getDescription()
        Gets the description of the action
        Returns:
        the description of the action

      • getHelpText

        public String getHelpText()
        Gets the help text of the action
        Returns:
        the help text of the action

      • getIconPath

        public String getIconPath()
        Gets the path of icon associated to the action
        Returns:
        the path of icon associated to the action

      • getTags

        public String[] getTags()
        Gets the tags associated to the action
        Returns:
        the tags associated to the action

      • setId

        public void setId​(String id)
        Sets the id of the action
        Parameters:
        id - the id of the action

      • setName

        public void setName​(String name)
        Sets the name of the action
        Parameters:
        name - the name of the action

      • setActionStringTokens

        public void setActionStringTokens​(String... actionStringTokens)
        Sets the action string tokens of the action
        Parameters:
        actionStringTokens - the action string tokens of the action

      • setXMLTokens

        public void setXMLTokens​(String... xmlTokens)
        Sets the XML tokens of the action
        Parameters:
        xmlTokens - the XML tokens of the action

      • setTags

        public void setTags​(String... tags)
        Sets the tags of the action
        Parameters:
        tags - the tags of the action

      • setDescription

        public void setDescription​(String description)
        Sets the description of the action
        Parameters:
        description - the description of the action

      • setHelpText

        public void setHelpText​(String helpText)
        Sets the help text of the action
        Parameters:
        helpText - the help text of the action

      • setIconPath

        public void setIconPath​(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​(String propertyName,
                                         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​(String propertyName,
                                      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​(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​(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 Object

      • getIcon

        public Icon getIcon()
        Returns the Icon related to iconPath property
        Returns:
        the Icon related to iconPath property

      • getEditorClassName

        public String getEditorClassName()
        Returns the editorClassName
        Returns:
        the editorClassName

      • setEditorClassName

        public void setEditorClassName​(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