Package org.fife.ui.rsyntaxtextarea
Class RSyntaxTextAreaEditorKit.ToggleCommentAction
- java.lang.Object
-
- javax.swing.AbstractAction
-
- javax.swing.text.TextAction
-
- org.fife.ui.rtextarea.RecordableTextAction
-
- org.fife.ui.rsyntaxtextarea.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
-
-
Constructor Summary
Constructors Constructor Description ToggleCommentAction()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
actionPerformedImpl(java.awt.event.ActionEvent e, RTextArea textArea)
The actual meat of the action.private boolean
getDoAdd(javax.swing.text.Document doc, javax.swing.text.Element map, int startLine, int endLine, java.lang.String[] startEnd)
java.lang.String
getMacroID()
Returns the identifier for this macro.private void
handleToggleComment(javax.swing.text.Element elem, javax.swing.text.Document doc, java.lang.String[] startEnd, boolean add)
-
Methods inherited from class org.fife.ui.rtextarea.RecordableTextAction
actionPerformed, getAccelerator, getDescription, getIcon, getMnemonic, getName, getShortDescription, isRecordable, setAccelerator, setMnemonic, setMnemonic, setName, setProperties, setRecordable, setShortDescription
-
Methods inherited from class javax.swing.text.TextAction
augmentList, getFocusedComponent, getTextComponent
-
Methods inherited from class javax.swing.AbstractAction
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled
-
-
-
-
Method Detail
-
actionPerformedImpl
public void actionPerformedImpl(java.awt.event.ActionEvent e, RTextArea textArea)
Description copied from class:RecordableTextAction
The actual meat of the action. If you wish to subclass this action and modify its behavior, this is the method to override.- Specified by:
actionPerformedImpl
in classRecordableTextAction
- Parameters:
e
- The action being performed.textArea
- The text area "receiving" the action.- See Also:
RecordableTextAction.actionPerformed(java.awt.event.ActionEvent)
-
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 theRTextAreaEditorKit.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 classRecordableTextAction
- Returns:
- The internally-used macro ID.
-
-