Class RSyntaxTextAreaEditorKit.ToggleCommentAction

  • All Implemented Interfaces:
    java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action
    Enclosing class:
    RSyntaxTextAreaEditorKit

    public static class RSyntaxTextAreaEditorKit.ToggleCommentAction
    extends RecordableTextAction
    Action that toggles whether the currently selected lines are commented.
    See Also:
    Serialized Form
    • Field Summary

      • Fields inherited from class javax.swing.AbstractAction

        changeSupport, enabled
      • Fields inherited from interface javax.swing.Action

        ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON
    • Constructor Detail

      • ToggleCommentAction

        public ToggleCommentAction()
    • Method Detail

      • getDoAdd

        private boolean getDoAdd​(javax.swing.text.Document doc,
                                 javax.swing.text.Element map,
                                 int startLine,
                                 int endLine,
                                 java.lang.String[] startEnd)
                          throws javax.swing.text.BadLocationException
        Throws:
        javax.swing.text.BadLocationException
      • handleToggleComment

        private void handleToggleComment​(javax.swing.text.Element elem,
                                         javax.swing.text.Document doc,
                                         java.lang.String[] startEnd,
                                         boolean add)
                                  throws javax.swing.text.BadLocationException
        Throws:
        javax.swing.text.BadLocationException
      • getMacroID

        public final java.lang.String getMacroID()
        Description copied from class: RecordableTextAction
        Returns the identifier for this macro. This method makes it so that you can create an instance of the RTextAreaEditorKit.CutAction action, for example, rename it to "Remove", and it will still be recorded as a "cut" action. Subclasses should return a unique string from this method; preferably the name of the action.

        If you subclass a RecordableTextAction, you should NOT override this method; if you do, the action may not be properly recorded in a macro.

        Specified by:
        getMacroID in class RecordableTextAction
        Returns:
        The internally-used macro ID.