jsyntaxpane.actions
Class DefaultSyntaxAction

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

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action, SyntaxAction

Direct Known Subclasses:

ComboCompletionAction, CompleteWordAction, DeleteLinesAction, DuplicateLinesAction, FindNextAction, FindReplaceAction, GotoLineAction, HTMLPreviewAction, IndentAction, JIndentAction, JumpToPairAction, JUnindentAction, KreatorSwitchToConsoleViewAction, KreatorSwitchToReportViewAction, MapCompletionAction, PairAction, PythonIndentAction, QuickFindAction, RedoAction, ReflectCompletionAction, ScriptAction, ScriptRunnerAction, ShowAbbsAction, SmartHomeAction, SmartHomeSelectAction, TemplateAction, ToggleCommentsAction, ToggleComponentAction, UndoAction, UnindentAction, XmlPrettifyAction, XmlTagCompleteAction

public abstract class DefaultSyntaxAction
extends javax.swing.text.TextAction
implements SyntaxAction

The DefaultSyntaxAction. You can extend this class or implement the interface SyntaxAction to create your own actions.

Author:

Ayman Al-Sairafi

See Also:

Serialized Form

Field Summary

static java.lang.String	ACTION_PREFIX
static java.lang.String	LARGE_ICONS_LOC_PREFIX
static java.lang.String	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

DefaultSyntaxAction(java.lang.String actionName)

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e)
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	config(Configuration config, java.lang.String name) Configure the actions in this class
void	setLargeIcon(java.lang.String url) Sets the Large Icon for this action from given url
void	setMenuText(java.lang.String text) Configure the MenuText for the Action
void	setSmallIcon(java.lang.String url) Configure the SmallIcon for the Action
void	setToolTip(java.lang.String text) Configure the ToolTip for the Action
java.lang.String	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

addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Field Detail

ACTION_PREFIX

public static final java.lang.String ACTION_PREFIX

See Also:

Constant Field Values

SMALL_ICONS_LOC_PREFIX

public static final java.lang.String SMALL_ICONS_LOC_PREFIX

See Also:

Constant Field Values

LARGE_ICONS_LOC_PREFIX

public static final java.lang.String LARGE_ICONS_LOC_PREFIX

See Also:

Constant Field Values

Constructor Detail

DefaultSyntaxAction

public DefaultSyntaxAction(java.lang.String actionName)

Method Detail

config

public void config(Configuration config,
                   java.lang.String name)

Description copied from interface: SyntaxAction

Configure the actions in this class

Specified by:

config in interface SyntaxAction

name - Name of the action, (prefixed by Action.) will be obtained from the property Key as the text following the Action.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

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.

Parameters:

target - (non-null JTextComponent from Action.getSource

sDoc - (SyntaxDOcument of the text component, could be null)

dot - (position of caret at text document)

e - actual ActionEvent passed to actionPerformed

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setMenuText

public final void setMenuText(java.lang.String text)

Configure the MenuText for the Action

Parameters:

text -

setToolTip

public final void setToolTip(java.lang.String text)

Configure the ToolTip for the Action

Parameters:

text -

setLargeIcon

public final void setLargeIcon(java.lang.String url)

Sets the Large Icon for this action from given url

Parameters:

url -

setSmallIcon

public final void setSmallIcon(java.lang.String url)

Configure the SmallIcon for the Action

Parameters:

url -