Class ActionSaveTab

java.lang.Object
gov.nih.mipav.model.scripting.actions.ActionSaveTab
All Implemented Interfaces:
ScriptableActionInterface

public class ActionSaveTab extends Object implements ScriptableActionInterface
A script action which records saves the text contained in one of the output frame's tabs.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private static final String
    The (optional) label to use for the directory in which to save the tab contents.
    private String
    The name of the tab to record the saving of.
    private static final String
    The label to use for the tab name parameter.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Constructor for the dynamic instantiation and execution of the SaveTab script action.
    Constructor used to record the SaveTab script action line.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    If a script is being recorded and the action (read: algorithm) is done, add an entry for this action.
    void
    Sets up the action dialog state and then executes it.
    void
    setTabName(String tabName)
    Changes the name of the tab being saved.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • DIR_LABEL

      private static final String DIR_LABEL
      The (optional) label to use for the directory in which to save the tab contents.
      See Also:
    • TAB_NAME_LABEL

      private static final String TAB_NAME_LABEL
      The label to use for the tab name parameter.
      See Also:
    • recordingTabName

      private String recordingTabName
      The name of the tab to record the saving of.
  • Constructor Details

    • ActionSaveTab

      public ActionSaveTab()
      Constructor for the dynamic instantiation and execution of the SaveTab script action.
    • ActionSaveTab

      public ActionSaveTab(String tabName)
      Constructor used to record the SaveTab script action line.
      Parameters:
      tabName - The name of the tab being saved.
  • Method Details

    • insertScriptLine

      public void insertScriptLine()
      If a script is being recorded and the action (read: algorithm) is done, add an entry for this action.
      Specified by:
      insertScriptLine in interface ScriptableActionInterface
    • scriptRun

      public void scriptRun(ParameterTable parameters)
      Sets up the action dialog state and then executes it.
      Specified by:
      scriptRun in interface ScriptableActionInterface
      Parameters:
      parameters - Table of parameters for the script to use.
    • setTabName

      public void setTabName(String tabName)
      Changes the name of the tab being saved.
      Parameters:
      tabName - The name of the tab being saved.