Package com.iizix.prop.vs.actor

Class ActionActors

java.lang.Object
com.iizix.prop.GProp<GProp<?>[]>
com.iizix.prop.PropCnr
com.iizix.prop.vs.actor.ActionActors
All Implemented Interfaces:
EventListener, IGProp<GProp<?>[]>, IPropCnr, Cloneable
Direct Known Subclasses:
EditorActionActors
public class ActionActors extends PropCnr
Class container for associated action actors of a VSAction.
Author:
Christopher Mindus

  • Constructor Details

    • ActionActors

      public ActionActors()
      Creates a VSAction Actors container property with no name and with a null value.

    • ActionActors

      public ActionActors(Atom propertyAtom)
      Creates a VSAction Actors container with the specified name with a null value.
      Parameters:
      propertyAtom - the property atom.

  • Method Details

    • usesPropIndex

      public final boolean usesPropIndex()
      Use of index for the property container is enabled.
      Specified by:
      usesPropIndex in interface IPropCnr
      Overrides:
      usesPropIndex in class PropCnr
      Returns:
      true for this container.

    • isPropPrivateAtCreation

      protected boolean isPropPrivateAtCreation()
      This property container is private and not transported to remote party.
      Overrides:
      isPropPrivateAtCreation in class GProp<GProp<?>[]>
      Returns:
      true if the property should be set to private at creation, false for default.

    • clone

      public ActionActors clone()
      Clones the instance.
      Overrides:
      clone in class PropCnr

    • getVSAction

      public VSAction getVSAction()
      Gets the VSAction instance.
      Returns:
      The instance, or null if this container is orphan.

    • shouldSerializeToXML

      protected boolean shouldSerializeToXML(int programType)
      Method used to check for serialization to XML. Override this method and return false to avoid writing the property to XML. The default is to write all properties.
      Overrides:
      shouldSerializeToXML in class GProp<GProp<?>[]>
      Parameters:
      programType - From PropFactory.getProgramType(): 0=PropFactory.CLIENT, 1=PropFactory.SERVER or 2=PropFactory.EDITOR.
      Returns:
      true (default if not VOLATILE) to save to XML, false to avoid writing the property to XML.

    • onPropInvalidateCache

      protected void onPropInvalidateCache()
      Description copied from class: GProp
      Invalidates a potential cache in this property. This method is called during a synchronized state of the property. Subclasses override this method to provide a robust caching mechanism.
      Overrides:
      onPropInvalidateCache in class GProp<GProp<?>[]>

    • getActionActorsSettings

      public AbstractSettings[] getActionActorsSettings()
      Gets the abstract settings for the action actor. This value is cached and is not allowed to be modified.
      Returns:
      The array of settings for the action actors.