org.fife.ui.rtextarea
Class RTextAreaEditorKit.SetReadOnlyAction

java.lang.Object
  extended by javax.swing.AbstractAction
      extended by javax.swing.text.TextAction
          extended by org.fife.ui.rtextarea.RecordableTextAction
              extended by org.fife.ui.rtextarea.RTextAreaEditorKit.SetReadOnlyAction
All Implemented Interfaces:
java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action
Enclosing class:
RTextAreaEditorKit

public static class RTextAreaEditorKit.SetReadOnlyAction
extends RecordableTextAction

Puts the text area into read-only mode.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.swing.AbstractAction
changeSupport, enabled
 
Fields inherited from interface javax.swing.Action
ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON
 
Constructor Summary
RTextAreaEditorKit.SetReadOnlyAction()
           
 
Method Summary
 void actionPerformedImpl(java.awt.event.ActionEvent e, RTextArea textArea)
          The actual meat of the action.
 java.lang.String getMacroID()
          Returns the identifier for this macro.
 boolean isRecordable()
          Returns whether or not this action will be recorded and replayed in a macro.
 
Methods inherited from class org.fife.ui.rtextarea.RecordableTextAction
actionPerformed, getAccelerator, getDescription, getIcon, getMnemonic, getName, 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
 

Constructor Detail

RTextAreaEditorKit.SetReadOnlyAction

public RTextAreaEditorKit.SetReadOnlyAction()
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)

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.

isRecordable

public boolean isRecordable()
Description copied from class: RecordableTextAction
Returns whether or not this action will be recorded and replayed in a macro.

Overrides:
isRecordable in class RecordableTextAction
Returns:
Whether or not this action will be recorded and replayed.
See Also:
RecordableTextAction.setRecordable(boolean)