oracle.javatools.editor

Class BasicEditorKit.EmacsCaseWordAction

java.lang.Object

javax.swing.AbstractAction

javax.swing.text.TextAction

oracle.javatools.editor.BasicAction

oracle.javatools.editor.EmacsAction

oracle.javatools.editor.EmacsWriteAction

oracle.javatools.editor.BasicEditorKit.EmacsCaseWordAction

All Implemented Interfaces:

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

Direct Known Subclasses:

BasicEditorKit.EmacsCapitalizeWordAction, BasicEditorKit.EmacsDowncaseWordAction, BasicEditorKit.EmacsUpcaseWordAction

Enclosing class:

BasicEditorKit

public abstract static class BasicEditorKit.EmacsCaseWordAction
extends EmacsWriteAction

The EmacsCaseWordAction is a base action for Emacs word-case action implementations. It takes care of the common functionality, like starting an edit, finding the word boundary, replacing the text, and so on. Implementation of word-case Emacs actions contributed by Doug Bitting.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class oracle.javatools.editor.EmacsAction

EmacsAction.Tracker

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 Summary

Constructors

Constructor and Description
BasicEditorKit.EmacsCaseWordAction(java.lang.String actionName) Constructs this object with the appropriate action name.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent event, BasicEditorPane editor, BasicDocument document) The operation to perform when this action is triggered.
abstract EditDescriptor	getEditDescriptor() Fetch the edit descriptor to use for undo purposes.
abstract java.lang.String	performModification(java.lang.String wordText) Perform the case changes to the word text.

Methods inherited from class oracle.javatools.editor.EmacsWriteAction

lock, unlock

Methods inherited from class oracle.javatools.editor.EmacsAction

addKillRing, appendKillRing, getClipboardText, getMark, getSystemClipboard, popKillRing, prependKillRing, removeMark, setClipboardText, setMark, setSystemClipboard, showEndBufferMessage, showMarkNotSetMessage, showMarkSetMessage, showNextKillAppendMessage, showPreviousNotYankMessage, showReadOnlyMessage, yankKillRing

Methods inherited from class oracle.javatools.editor.BasicAction

actionPerformed, beep, buildIndent, getFontHeight, getIndentSizeProperty, getLastAction, getMagicCaretPosition, getName, getSmartIndentProvider, getSpaces, getTab, getTabs, getTabSizeProperty, getUseAutoIndentProperty, getUseTabsProperty, getVisibleRect, isEditable, setMagicCaretPosition, showMessage, skipLeadingIndent

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

Constructor Detail

BasicEditorKit.EmacsCaseWordAction

public BasicEditorKit.EmacsCaseWordAction(java.lang.String actionName)

Constructs this object with the appropriate action name.

Method Detail

actionPerformed

public final void actionPerformed(java.awt.event.ActionEvent event,
                   BasicEditorPane editor,
                   BasicDocument document)

The operation to perform when this action is triggered.

Specified by:

actionPerformed in class EmacsAction

Parameters:

event - the action event

editor - the editor his action was invoked in

document - the document associated with the editor

performModification

public abstract java.lang.String performModification(java.lang.String wordText)

Perform the case changes to the word text.

Parameters:

wordText - the word text to perform the case changes to

Returns:

the replacement word text with case changes made

getEditDescriptor

public abstract EditDescriptor getEditDescriptor()

Fetch the edit descriptor to use for undo purposes.

Returns:

the edit descriptor to use for undo purposes