ToggleCommentsAction

java.lang.Object
- javax.swing.AbstractAction
- - javax.swing.text.TextAction
  - - jsyntaxpane.actions.DefaultSyntaxAction
    - - jsyntaxpane.actions.ToggleCommentsAction

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action, SyntaxAction
```
public class ToggleCommentsAction
extends DefaultSyntaxAction
```
This action will toggle comments on or off on selected whole lines.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected java.util.regex.Pattern lineCommentPattern

protected java.lang.String lineCommentStart
- Fields inherited from class jsyntaxpane.actions.DefaultSyntaxAction
  ACTION_PREFIX, LARGE_ICONS_LOC_PREFIX, SMALL_ICONS_LOC_PREFIX
- 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 Summary

Constructors
Constructor Description

ToggleCommentsAction()
creates new JIndentAction.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`actionPerformed(javax.swing.text.JTextComponent target, SyntaxDocument sDoc, int dot, java.awt.event.ActionEvent e)`	Convenience method that will be called if the Action is performed on a JTextComponent.
`void`	`setLineComments(java.lang.String value)`

Methods inherited from class jsyntaxpane.actions.DefaultSyntaxAction
actionPerformed, config, setLargeIcon, setMenuText, setSmallIcon, setToolTip, toString

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

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.swing.Action
accept, addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

- Field Detail
  - lineCommentStart
```
protected java.lang.String lineCommentStart
```
  - lineCommentPattern
```
protected java.util.regex.Pattern lineCommentPattern
```
- Constructor Detail
  - ToggleCommentsAction
```
public ToggleCommentsAction()
```
    creates new JIndentAction. Initial Code contributed by ser... AT mail.ru
- Method Detail
  - actionPerformed
```
public void actionPerformed(javax.swing.text.JTextComponent target,
                            SyntaxDocument sDoc,
                            int dot,
                            java.awt.event.ActionEvent e)
```
    Convenience method that will be called if the Action is performed on a JTextComponent. SyntaxActions should generally override this method.
    
    Overrides:
    
    actionPerformed in class DefaultSyntaxAction
    
    Parameters:
    
    e -
    
    target - (non-null JTextComponent from Action.getSource
    
    sDoc - (SyntaxDOcument of the text component, could be null)
    
    dot - (position of caret at text document)
  - setLineComments
```
public void setLineComments(java.lang.String value)
```