Field Detail

• ACTOR_CLASS

  public static final java.lang.String ACTOR_CLASS

  Property for the actor class name.

  See Also:

  Constant Field Values

Constructor Detail

• JavaActionActorBase

  public JavaActionActorBase​(VSAction action,
                             JavaActionActorBase.Settings settings)

  Creates a new instance.

  Parameters:

  action - The action initiator.

  settings - The settings to use, null in the Designer instance.

Method Detail

• newTXPNode

  public AbstractJavaActionActor newTXPNode​(VSActionTXProcess actionProcess,
                                            VSAction action,
                                            JavaActionActorBase.Settings settings)
                                     throws java.lang.ClassNotFoundException,
                                            ActionActorException

  Creates a new TXP Node instance to be used for a TXP process.

  Specified by:

  newTXPNode in interface IActionActor<JavaActionActorBase.Settings>

  Parameters:

  actionProcess - The action process.

  action - The VirtualSpace Action instance that initiates the actor.

  settings - The settings for the action actor implementation.

  Returns:

  A new TXP node implementation ready to be added to a TXP process.

  Throws:

  java.lang.ClassNotFoundException - If the Action Actor class is not found.

  ActionActorException - If a new node could not be created.

• getDefaultDescription

  public java.lang.String getDefaultDescription()

  Gets a description of the Action Actor to be used for the Designer or logging.

  Specified by:

  getDefaultDescription in interface IActionActor<JavaActionActorBase.Settings>

  Returns:

  A short description.

• getDescription

  public java.lang.String getDescription()

  Gets a description of the Action Actor to be used for the Designer or logging.

  Specified by:

  getDescription in interface IActionActor<JavaActionActorBase.Settings>

  Returns:

  A short description.

• getEnabledState

  public java.lang.String getEnabledState​(IAppSessionGyro appGyro,
                                          VSAction action)

  Checks if the runnable is enabled for the current VirtualSpace. This method is checked to see if the action is enabled and also in the Designer.

  Specified by:

  getEnabledState in interface IActionActor<JavaActionActorBase.Settings>

  Parameters:

  appGyro - The application session gyro instance.

  action - The action calling the action actor.

  Returns:

  null If enabled, otherwise an message why it's not enabled.

• doesModifyVirtualSpace

  public boolean doesModifyVirtualSpace()

  Checks if the VirtualSpace is modified by the Action Actor.

  Specified by:

  doesModifyVirtualSpace in interface IActionActor<JavaActionActorBase.Settings>

  Returns:

  true if any field in the VS is modified (excludes focus).