com.autodesk.actions
Class Trigger

java.lang.Object
  com.autodesk.actions.Trigger

public abstract class Trigger
extends java.lang.Object

This class is used to represent triggers.

Constructor Summary

Trigger(java.lang.String id)
Create a Trigger.

Method Summary

java.lang.String	getID()
protected java.lang.String[]	getLocale()
abstract java.lang.String	getName()
abstract javax.swing.JPanel	getPanel()
abstract java.lang.String	getSectionID()
java.lang.String[]	getSectionNames()
java.util.Map<java.lang.String,java.lang.Object>	getValues(javax.swing.JPanel arg0)
void	initialize()
IOObject	run(java.util.Map<java.lang.String,java.lang.Object> vars, com.autodesk.actions.Workflow input) Run the Trigger.
protected abstract IOObject	runImpl(java.util.Map<java.lang.String,java.lang.Object> vars, com.autodesk.actions.Workflow input)
void	setValues(javax.swing.JPanel arg0, java.util.Map<java.lang.String,java.lang.Object> arg1)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Trigger

public Trigger(java.lang.String id)

Create a Trigger.

Parameters:

id - a unique id for the trigger. This id is not localized and need not be in English, just must be unique.

Method Detail

run

public IOObject run(java.util.Map<java.lang.String,java.lang.Object> vars,
                    com.autodesk.actions.Workflow input)

Run the Trigger. This implements Node.run() making sure that the input IOObject is correct and that the output IOObject is also correct according to the XML description of the Action.

Parameters:

vars - a Map containing the names and values of variables that will be inserted into the script's runtime environment.

input - a Workflow object used by the Trigger to learn of it's environment.

Returns:

an IOObject generated by the Action. This is defined by the output element of the XML. For Triggers this will almost always be null.

runImpl

protected abstract IOObject runImpl(java.util.Map<java.lang.String,java.lang.Object> vars,
                                    com.autodesk.actions.Workflow input)

initialize

public void initialize()

getName

public abstract java.lang.String getName()

getPanel

public abstract javax.swing.JPanel getPanel()

getID

public java.lang.String getID()

getSectionID

public abstract java.lang.String getSectionID()

getSectionNames

public java.lang.String[] getSectionNames()

getValues

public java.util.Map<java.lang.String,java.lang.Object> getValues(javax.swing.JPanel arg0)

setValues

public void setValues(javax.swing.JPanel arg0,
                      java.util.Map<java.lang.String,java.lang.Object> arg1)

getLocale

protected java.lang.String[] getLocale()