Interface IEditorActionActorSettings

All Superinterfaces:
IActionActorSettings, IAdaptable, IGProp<GProp<?>[]>, IPropCnr, IPropDesigner
All Known Implementing Classes:
EditorDatabaseActionActor.Settings, EditorHistoryBackward.Settings, EditorHistoryForward.Settings, EditorJavaActionActor.Settings, EditorSetFocus.Settings, EditorSetSourceFieldValue.Settings, EditorSetTargetFieldValue.Settings, EditorTerminalActionActor.Settings, EditorTransportField.Settings, EditorWebServiceActionActor.Settings

public interface IEditorActionActorSettings extends IPropDesigner, IActionActorSettings
Editor interface for the Settings containers for Actions in the Designer.
Author:
Christopher Mindus
  • Method Details

    • getDesigner

      Gets the Designer Extension for Properties.
      Specified by:
      getDesigner in interface IPropDesigner
      Returns:
      The instance of the Designer Extension.
    • getActorImage

      Image getActorImage()
      Gets the image to use.
    • canGoto

      default boolean canGoto()
      Returns if the actor settings provides a way to go to the element in question.
      Returns:
      true if this is possible.
    • getGotoText

      default String getGotoText()
      Gets the go to text that will be displayed in the UI.
      Returns:
      A text to be used, null for default.
    • gotoActionActorDefinition

      default void gotoActionActorDefinition(Shell shell)
      Goes to the actor definition. Override to provide functionality. This method will only be called if canGoto() returns true.
      Parameters:
      shell - A shell instance of the requestor.
    • doEditActorSettings

      default boolean doEditActorSettings()
      Returns the Designer editability of the settings in the properties dialog box as provided by default for the Action Actors. A data connector being an action actor could provide its own settings editor.
      Returns:
      true if the default Action Actors Edit settings should be provided or not. Override to return false.
    • getPropertyEditorSetup

      default PropertyEditorSetup getPropertyEditorSetup()
      Gets the Setup used for iiziGo, subclasses must override and provide their instance.
      Returns:
      The PropertyEditor setup data, or null to use the one from VirtualSpaceEditor.
    • getDetails

      String getDetails()
      Gets details for this action actor.
      Returns:
      A string used in Eclipse details column for the Action Actors table.
    • needsRefreshButton

      default boolean needsRefreshButton(Control control, Runnable refresh)
      Checks if fixed settings can be provided or not. If e.g. a class name is entered, the properties that is shown in the dialog box are taken from the Java code, and in this case, a refresh is needed.
      Parameters:
      control - Shell to listen to when destroyed.
      refresh - Method to call to enable refresh button.
      Returns:
      true in order to show the button "Refresh properties" (will appear in the dialog box), false not to do so.

      Default is to return false.

    • getFixedSettings

      default ArrayList<PropertyEditorInfo> getFixedSettings()
      Gets fixed settings for the container.
      Returns:
      null (default) for property based, otherwise an array of the editable properties.