Package org.eclipse.ui.texteditor
Class ShowWhitespaceCharactersAction
java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.jface.action.AbstractAction
org.eclipse.jface.action.Action
org.eclipse.ui.texteditor.ResourceAction
org.eclipse.ui.texteditor.TextEditorAction
org.eclipse.ui.texteditor.ShowWhitespaceCharactersAction
This action toggles the display of whitespace characters by
attaching/detaching an
WhitespaceCharacterPainter
to the
associated text editor.
Note: Currently this action only works if the given
editor inherits from AbstractTextEditor
.
- Since:
- 3.3
-
Field Summary
Fields inherited from interface org.eclipse.jface.action.IAction
AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, HANDLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT
-
Constructor Summary
ConstructorDescriptionShowWhitespaceCharactersAction
(ResourceBundle resourceBundle, String prefix, ITextEditor editor, IPreferenceStore store) Construct the action and initialize its state. -
Method Summary
Methods inherited from class org.eclipse.ui.texteditor.TextEditorAction
canModifyEditor, getTextEditor, setEditor, validateEditorInputState
Methods inherited from class org.eclipse.ui.texteditor.ResourceAction
getString, initialize, setHelpContextId
Methods inherited from class org.eclipse.jface.action.Action
convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
Methods inherited from class org.eclipse.jface.action.AbstractAction
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener
Methods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
-
Constructor Details
-
ShowWhitespaceCharactersAction
public ShowWhitespaceCharactersAction(ResourceBundle resourceBundle, String prefix, ITextEditor editor, IPreferenceStore store) Construct the action and initialize its state.- Parameters:
resourceBundle
- the resource bundle to construct label and tooltip fromprefix
- the prefix to use for constructing resource bundle keyseditor
- the editor this action is associated withstore
- the preference store (may benull
)
-
-
Method Details
-
setPreferenceStore
Sets the preference store of this action.- Parameters:
store
- the preference store
-
run
public void run()Description copied from class:Action
The default implementation of thisIAction
method does nothing. Subclasses should override this method if they do not need information from the triggering event, or overriderunWithEvent(Event)
if they do. -
update
public void update()Description copied from class:TextEditorAction
Always enables this action if it is connected to a text editor. If the associated editor isnull
, the action is disabled. Subclasses may override.- Specified by:
update
in interfaceIUpdate
- Overrides:
update
in classTextEditorAction
-