|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.jbbres.lib.actions.tools.elements.variables.VariableActionDescription
public class VariableActionDescription
The ActionDescription
for VariableAction
.
Field Summary |
---|
Fields inherited from interface com.jbbres.lib.actions.elements.ActionDescription |
---|
DEFAULT_INPUT_PROVIDER, DESCRIPTION_INPUT, DESCRIPTION_OUTPUT, WARNING_CANCEL_BUTTON, WARNING_CONTINUE_BUTTON, WARNING_MESSAGE, WARNING_SUGGESTED_ACTION |
Fields inherited from interface com.jbbres.lib.actions.elements.ElementDescription |
---|
CATEGORY_SEPARATOR, DESCRIPTION_CATEGORIES, DESCRIPTION_COMPANY_NAME, DESCRIPTION_COMPANY_SUPPORT, DESCRIPTION_COMPANY_WEBSITE, DESCRIPTION_COPYRIGHT, DESCRIPTION_ICON, DESCRIPTION_SUMMARY, DESCRIPTION_TITLE, DESCRIPTION_VERSION, TYPE |
Constructor Summary | |
---|---|
VariableActionDescription(VariableAction action)
Instantiates a description. |
Method Summary | |
---|---|
void |
addElementDescriptionChangeListener(ElementDescriptionChangeListener listener)
Adds a element description change listener. |
void |
assignValueChange(VariableActionServiceEvent event)
Invocated when the assign value flag changes. |
int |
compareTo(ElementDescription<?> element)
|
void |
fireElementDescriptionChange(java.lang.String descriptionKey,
VariableDescription oldDescription)
Calls the elementDescriptionChange(ElementDescriptionChangeEvent) of all
listeners. |
void |
fireElementDescriptionChange(VariableDescription oldDescription)
Calls fireElementDescriptionChange(String, VariableDescription)
for all possible description key. |
Category[] |
getCategories()
Returns the categories associated to the element. |
java.lang.String |
getDescription(java.lang.String key)
Returns the information associated to the given key. |
javax.swing.ImageIcon |
getIcon()
Returns the icon associated to the element. |
java.lang.Object |
getSearchableValue(com.jbbres.lib.search.SearchField<?> field)
|
Element |
newElementInstance(Workflow workflow)
Creates and returns a new instance of the element described. |
void |
removeElementDescriptionChangeListener(ElementDescriptionChangeListener listener)
Removes a element description change listener. |
void |
variableChange(VariableActionServiceEvent event)
Invocated when the variable changes. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public VariableActionDescription(VariableAction action)
action
- - the actionMethod Detail |
---|
public java.lang.String getDescription(java.lang.String key)
ElementDescription
getDescription
in interface ElementDescription<Action>
key
- - the key
public javax.swing.ImageIcon getIcon()
ElementDescription
getIcon
in interface ElementDescription<Action>
public Category[] getCategories()
ElementDescription
getCategories
in interface ElementDescription<Action>
public Element newElementInstance(Workflow workflow)
ElementDescription
This methods should not add the new element to the given workflow.
Action(s) takes care of calling the appropried
Workflow.add(Element)
method.
newElementInstance
in interface ElementDescription<Action>
workflow
- - the workflow that will own the element
public java.lang.Object getSearchableValue(com.jbbres.lib.search.SearchField<?> field)
getSearchableValue
in interface com.jbbres.lib.search.Searchable
public int compareTo(ElementDescription<?> element)
compareTo
in interface java.lang.Comparable<ElementDescription<?>>
public void addElementDescriptionChangeListener(ElementDescriptionChangeListener listener)
ElementDescription
addElementDescriptionChangeListener
in interface ElementDescription<Action>
listener
- - the listenerElementDescriptionChangeListener
public void removeElementDescriptionChangeListener(ElementDescriptionChangeListener listener)
ElementDescription
removeElementDescriptionChangeListener
in interface ElementDescription<Action>
listener
- - the listenerElementDescriptionChangeListener
public void fireElementDescriptionChange(VariableDescription oldDescription)
fireElementDescriptionChange(String, VariableDescription)
for all possible description key.
oldDescription
- - the previous descriptionpublic void fireElementDescriptionChange(java.lang.String descriptionKey, VariableDescription oldDescription)
elementDescriptionChange(ElementDescriptionChangeEvent)
of all
listeners.
descriptionKey
- - the key associated to the description that changed.oldDescription
- - the old descriptionpublic void assignValueChange(VariableActionServiceEvent event)
VariableActionServiceListener
assignValueChange
in interface VariableActionServiceListener
event
- - the eventpublic void variableChange(VariableActionServiceEvent event)
VariableActionServiceListener
variableChange
in interface VariableActionServiceListener
event
- - the event
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |