Class ActionSaveTab

    • Field Summary

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

      Constructors 
      Constructor Description
      ActionSaveTab()
      Constructor for the dynamic instantiation and execution of the SaveTab script action.
      ActionSaveTab​(java.lang.String tabName)
      Constructor used to record the SaveTab script action line.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void insertScriptLine()
      If a script is being recorded and the action (read: algorithm) is done, add an entry for this action.
      void scriptRun​(ParameterTable parameters)
      Sets up the action dialog state and then executes it.
      void setTabName​(java.lang.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 Detail

      • DIR_LABEL

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

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

        private java.lang.String recordingTabName
        The name of the tab to record the saving of.
    • Constructor Detail

      • ActionSaveTab

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

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

      • 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​(java.lang.String tabName)
        Changes the name of the tab being saved.
        Parameters:
        tabName - The name of the tab being saved.