Class AbstractPredefinedSettings

All Implemented Interfaces:
EventListener, IGProp<GProp<?>[]>, IPropCnr, IActionActorSettings, Cloneable
Direct Known Subclasses:
HistoryBackward.Settings, HistoryForward.Settings, SetFocus.Settings, SetSourceFieldValue.Settings, SetTargetFieldValue.Settings, TransportField.Settings, TransportGroup.Settings, TransportSelectedTableRows.Settings, TransportSingleSelectedTableRow.Settings, TransportSingleSelectedTableRowAndColumnToField.Settings, TransportSingleSelectedTableRowToFields.Settings, TransportTableColumn.Settings, TransportTableRows.Settings

public abstract class AbstractPredefinedSettings extends AbstractSettings
The predefined actions actors settings container that checks if the VSReference is for the target VirtualSpace.
Author:
Christopher Mindus
  • Constructor Details

    • AbstractPredefinedSettings

      public AbstractPredefinedSettings()
      Creates the settings without name.
    • AbstractPredefinedSettings

      public AbstractPredefinedSettings(Atom propertyAtom)
      Creates the settings with specified name.
      Parameters:
      propertyAtom - the property atom.
  • Method Details

    • getVSReference

      public VSReference getVSReference(Atom refAtom)
      Gets a VSReference instance from the container or any parent containers. The method is used by VSRelativeReference to look up the VSReference instance in order to resolve the relative path to the target property.

      If the refAtom name contains the text "target" (case insensitive), then the VSAction target VirtualSpace reference is returned.

      Specified by:
      getVSReference in interface IGProp<GProp<?>[]>
      Overrides:
      getVSReference in class PropCnr
      Parameters:
      refAtom - The property asking for the VSReference.
      Returns:
      The instance of the VSReference or null if unassigned.
    • createVSReference

      public VSReference createVSReference(Atom refAtom, PropCnr[] returnParent)
      Creates a VSReference instance from the container or any parent containers. The method is used in the Designer to create a VirtualSpace connection for VSRelativeReference to look up the VSReference instance in order to resolve the relative path to the target property.

      This method needs to be overridden by subclasses of PropCnr that has a VSReference as property, and *SHOULD* match getVSReference(Atom).

      The default is to re-target the call to the parent container, and if the root, a folder or a file property is reached, null is returned.

      Overrides:
      createVSReference in class PropCnr
      Parameters:
      refAtom - The property asking for the VSReference.
      returnParent - An array of PropCnr [1] that will be filled in with the parent property of the VSRefernce.
      Returns:
      The instance of the VSReference or null if unassigned. The returned instance could also be a VSParticipant and should therefore be processed accordingly.

      For this method, it's always null!