Package org.fife.ui.rsyntaxtextarea

Class RSyntaxTextAreaEditorKit.PossiblyInsertTemplateAction

java.lang.Object

javax.swing.AbstractAction

javax.swing.text.TextAction

org.fife.ui.rtextarea.RecordableTextAction

org.fife.ui.rsyntaxtextarea.RSyntaxTextAreaEditorKit.PossiblyInsertTemplateAction

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.PossiblyInsertTemplateAction
extends RecordableTextAction

Action for when the user tries to insert a template (that is, they've typed a template ID and pressed the trigger character (a space) in an attempt to do the substitution).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static long	serialVersionUID

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
PossiblyInsertTemplateAction()

Method Summary

Modifier and Type	Method	Description
void	actionPerformedImpl(java.awt.event.ActionEvent e, RTextArea textArea)	The actual meat of the action.
private void	doDefaultInsert(RTextArea textArea)
java.lang.String	getMacroID()	Returns the identifier for this macro.

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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.swing.Action

accept

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

PossiblyInsertTemplateAction

public PossiblyInsertTemplateAction()

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 class RecordableTextAction

Parameters:

e - The action being performed.

textArea - The text area "receiving" the action.

See Also:

RecordableTextAction.actionPerformed(java.awt.event.ActionEvent)

doDefaultInsert

private void doDefaultInsert(RTextArea textArea)

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.