Class EditorSettings

java.lang.Object
com.uc4.communication.EditorSettings

public class EditorSettings extends Object
This class represents the Script Editor settings. These settings can be found in the User Interface - Options - Settings - ScriptEditor
  • Method Details

    • isShowParameterInfo

      public boolean isShowParameterInfo()
      Returns:
      true if the parameter info should be shown, false if not.
    • setShowParameterInfo

      public void setShowParameterInfo(boolean showParameterInfo)
      Defines if the parameter info should be shown in the ScriptEditor.
      Parameters:
      showParameterInfo - true if the parameter info should be shown, false if not.
    • isShowHelpForParameterInfo

      public boolean isShowHelpForParameterInfo()
      Returns:
      true if a documentation of parameters should be shown, false if not.
    • setShowHelpForParameterInfo

      public void setShowHelpForParameterInfo(boolean showHelpForParameterInfo)
      Parameters:
      showHelpForParameterInfo - true if a documentation of parameters should be shown, false if not.
    • isAutoPrefix

      public boolean isAutoPrefix()
      Returns:
      true if the prefix of the previous line should be automatically added when a new line is created in the ScriptEditor, false otherwise
    • setAutoPrefix

      public void setAutoPrefix(boolean useFirstCharacterFromPreviousLine)
      Defines if the prefix of the previous line should be automatically added when a new line is created in the ScriptEditor.
      Parameters:
      useFirstCharacterFromPreviousLine - Add prefix to new lines
    • isSuggestKeepIndent

      public boolean isSuggestKeepIndent()
      For the purpose of keeping a clear structure, scripting lines in constructs such as :IF or :WHILE should be indented. The script editor can automatically indent such lines, pressing the tab key is not required.
      Returns:
      true if this feature is enabled, false if not
    • setSuggestKeepIndent

      public void setSuggestKeepIndent(boolean suggestKeepIndent)
      For the purpose of keeping a clear structure, scripting lines in constructs such as :IF or :WHILE should be indented. The script editor can automatically indent such lines, pressing the tab key is not required.
      Parameters:
      suggestKeepIndent - true if this feature should be enabled, false if not
    • isCloseConstructsAutomatically

      public boolean isCloseConstructsAutomatically()
      Constructs such as :IF or :WHILE can automatically be completed with the corresponding closing statement (:ENDIF, :ENDWHILE).
      Returns:
      true if this feature is enabled, false if not
    • setCloseConstructsAutomatically

      public void setCloseConstructsAutomatically(boolean closeConstructsAutomatically)
      Constructs such as :IF or :WHILE can automatically be completed with the corresponding closing statement (:ENDIF, :ENDWHILE).
      Parameters:
      closeConstructsAutomatically - true if this feature should be enabled, false if not