Class TextNavigationAction
- java.lang.Object
-
- org.eclipse.core.commands.common.EventManager
-
- org.eclipse.jface.action.AbstractAction
-
- org.eclipse.jface.action.Action
-
- org.eclipse.ui.texteditor.TextNavigationAction
-
- All Implemented Interfaces:
IAction
- Direct Known Subclasses:
AbstractTextEditor.LineEndAction,AbstractTextEditor.LineStartAction
public class TextNavigationAction extends Action
AnActionwrapper for text widget navigation and selection actions.- Since:
- 2.0
-
-
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
Constructors Constructor Description TextNavigationAction(StyledText textWidget, int action)Creates a newTextNavigationAction.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddPropertyChangeListener(IPropertyChangeListener listener)Adds a property change listener to this action.protected voidfireSelectionChanged()Sends a selection event with the current selection to all selection listeners of the action's text widgetprotected voidfireSelectionChanged(Point oldSelection)Fires a selection event to all selection listener of the action's text widget if the current selection differs from the given selection.intgetAccelerator()Returns the accelerator keycode for this action.StringgetDescription()Returns the action's description if it has one.ImageDescriptorgetDisabledImageDescriptor()Returns the disabled image for this action as an image descriptor.HelpListenergetHelpListener()Returns a help listener for this action.ImageDescriptorgetHoverImageDescriptor()Returns the hover image for this action as an image descriptor.ImageDescriptorgetImageDescriptor()Returns the image for this action as an image descriptor.IMenuCreatorgetMenuCreator()Returns the menu creator for this action.intgetStyle()Return this action's style.StringgetText()Returns the text for this action.protected StyledTextgetTextWidget()Returns the text widget this actions is bound to.StringgetToolTipText()Returns the tool tip text for this action.booleanisChecked()Returns the checked status of this action.booleanisEnabled()Returns whether this action is enabled.voidremovePropertyChangeListener(IPropertyChangeListener listener)Removes the given listener from this action.voidrun()The default implementation of thisIActionmethod does nothing.voidrunWithEvent(Event event)The default implementation of thisIActionmethod ignores the event argument, and simply callsrun().voidsetAccelerator(int keycode)Sets the accelerator keycode that this action maps to.voidsetChecked(boolean checked)Sets the checked status of this action.voidsetDescription(String text)Sets this action's description.voidsetDisabledImageDescriptor(ImageDescriptor newImage)Sets the disabled image for this action, as an image descriptor.voidsetEnabled(boolean enabled)Sets the enabled state of this action.voidsetHelpListener(HelpListener listener)Sets a help listener for this action.voidsetHoverImageDescriptor(ImageDescriptor newImage)Sets the hover image for this action, as an image descriptor.voidsetImageDescriptor(ImageDescriptor newImage)Sets the image for this action, as an image descriptor.voidsetMenuCreator(IMenuCreator creator)Sets the menu creator for this action.voidsetText(String text)Sets the text for this action.voidsetToolTipText(String text)Sets the tool tip text for this action.-
Methods inherited from class org.eclipse.jface.action.Action
convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getActionDefinitionId, getId, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, setActionDefinitionId, setId
-
Methods inherited from class org.eclipse.jface.action.AbstractAction
firePropertyChange, firePropertyChange
-
Methods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
-
-
-
-
Constructor Detail
-
TextNavigationAction
public TextNavigationAction(StyledText textWidget, int action)
Creates a newTextNavigationAction.- Parameters:
textWidget- the text widgetaction- the styled text widget action
-
-
Method Detail
-
getTextWidget
protected StyledText getTextWidget()
Returns the text widget this actions is bound to.- Returns:
- returns the text widget this actions is bound to
-
run
public void run()
Description copied from class:ActionThe default implementation of thisIActionmethod does nothing. Subclasses should override this method if they do not need information from the triggering event, or overriderunWithEvent(Event)if they do.- Specified by:
runin interfaceIAction- Overrides:
runin classAction- See Also:
How radio buttons are handled,How check boxes are handled
-
fireSelectionChanged
protected void fireSelectionChanged()
Sends a selection event with the current selection to all selection listeners of the action's text widget- Since:
- 3.0
-
fireSelectionChanged
protected void fireSelectionChanged(Point oldSelection)
Fires a selection event to all selection listener of the action's text widget if the current selection differs from the given selection.- Parameters:
oldSelection- the old selection- Since:
- 3.0
-
runWithEvent
public void runWithEvent(Event event)
Description copied from class:ActionThe default implementation of thisIActionmethod ignores the event argument, and simply callsrun(). Subclasses should override this method if they need information from the triggering event, or overriderun()if not.- Specified by:
runWithEventin interfaceIAction- Overrides:
runWithEventin classAction- Parameters:
event- the SWT event which triggered this action being run- See Also:
How radio buttons are handled,How check boxes are handled
-
addPropertyChangeListener
public void addPropertyChangeListener(IPropertyChangeListener listener)
Description copied from interface:IActionAdds a property change listener to this action. Has no effect if an identical listener is already registered.- Specified by:
addPropertyChangeListenerin interfaceIAction- Overrides:
addPropertyChangeListenerin classAbstractAction- Parameters:
listener- a property change listener
-
getAccelerator
public int getAccelerator()
Description copied from interface:IActionReturns the accelerator keycode for this action. The result is the bit-wise OR of zero or more modifier masks and a key, as explained inMenuItem.getAccelerator.- Specified by:
getAcceleratorin interfaceIAction- Overrides:
getAcceleratorin classAction- Returns:
- the accelerator keycode
- See Also:
MenuItem.getAccelerator()
-
getDescription
public String getDescription()
Description copied from interface:IActionReturns the action's description if it has one. Otherwise it returnsgetToolTipText().- Specified by:
getDescriptionin interfaceIAction- Overrides:
getDescriptionin classAction- Returns:
- a description for the action; may be
null
-
getDisabledImageDescriptor
public ImageDescriptor getDisabledImageDescriptor()
Description copied from interface:IActionReturns the disabled image for this action as an image descriptor.This method is associated with the
IMAGEproperty; property change events are reported when its value changes.- Specified by:
getDisabledImageDescriptorin interfaceIAction- Overrides:
getDisabledImageDescriptorin classAction- Returns:
- the image, or
nullif this action has no image - See Also:
IAction.IMAGE
-
getHelpListener
public HelpListener getHelpListener()
Description copied from interface:IActionReturns a help listener for this action.- Specified by:
getHelpListenerin interfaceIAction- Overrides:
getHelpListenerin classAction- Returns:
- a help listener for this action
-
getHoverImageDescriptor
public ImageDescriptor getHoverImageDescriptor()
Description copied from interface:IActionReturns the hover image for this action as an image descriptor.Hover images will be used on platforms that support changing the image when the user hovers over the item. This method is associated with the
IMAGEproperty; property change events are reported when its value changes.- Specified by:
getHoverImageDescriptorin interfaceIAction- Overrides:
getHoverImageDescriptorin classAction- Returns:
- the image, or
nullif this action has no image - See Also:
IAction.IMAGE
-
getImageDescriptor
public ImageDescriptor getImageDescriptor()
Description copied from interface:IActionReturns the image for this action as an image descriptor.This method is associated with the
IMAGEproperty; property change events are reported when its value changes.- Specified by:
getImageDescriptorin interfaceIAction- Overrides:
getImageDescriptorin classAction- Returns:
- the image, or
nullif this action has no image - See Also:
IAction.IMAGE
-
getMenuCreator
public IMenuCreator getMenuCreator()
Description copied from interface:IActionReturns the menu creator for this action.- Specified by:
getMenuCreatorin interfaceIAction- Overrides:
getMenuCreatorin classAction- Returns:
- the menu creator, or
nullif none
-
getStyle
public int getStyle()
Description copied from interface:IActionReturn this action's style.
-
getText
public String getText()
Description copied from interface:IActionReturns the text for this action.This method is associated with the
TEXTproperty; property change events are reported when its value changes.- Specified by:
getTextin interfaceIAction- Overrides:
getTextin classAction- Returns:
- the text, or
nullif none - See Also:
IAction.TEXT
-
getToolTipText
public String getToolTipText()
Description copied from interface:IActionReturns the tool tip text for this action.This method is associated with the
TOOL_TIP_TEXTproperty; property change events are reported when its value changes.- Specified by:
getToolTipTextin interfaceIAction- Overrides:
getToolTipTextin classAction- Returns:
- the tool tip text, or
nullif none - See Also:
IAction.TOOL_TIP_TEXT
-
isChecked
public boolean isChecked()
Description copied from interface:IActionReturns the checked status of this action. Applicable only if the style isAS_CHECK_BOXorAS_RADIO_BUTTON.This method is associated with the
CHECKEDproperty; property change events are reported when its value changes.- Specified by:
isCheckedin interfaceIAction- Overrides:
isCheckedin classAction- Returns:
- the checked status
- See Also:
IAction.CHECKED
-
isEnabled
public boolean isEnabled()
Description copied from interface:IActionReturns whether this action is enabled.This method is associated with the
ENABLEDproperty; property change events are reported when its value changes.- Specified by:
isEnabledin interfaceIAction- Overrides:
isEnabledin classAction- Returns:
trueif enabled, andfalseif disabled- See Also:
IAction.ENABLED
-
removePropertyChangeListener
public void removePropertyChangeListener(IPropertyChangeListener listener)
Description copied from interface:IActionRemoves the given listener from this action. Has no effect if an identical listener is not registered.- Specified by:
removePropertyChangeListenerin interfaceIAction- Overrides:
removePropertyChangeListenerin classAbstractAction- Parameters:
listener- a property change listener
-
setAccelerator
public void setAccelerator(int keycode)
Description copied from interface:IActionSets the accelerator keycode that this action maps to. This is a bitwise OR of zero or more SWT key modifier masks (i.e. SWT.CTRL or SWT.ALT) and a character code. For example, for Ctrl+Z, use
SWT.CTRL | 'Z'. Use 0 for no accelerator.This method should no longer be used for actions in the Eclipse workbench.
IWorkbenchCommandSupportandIWorkbenchContextSupportprovide all the functionality required for key bindings. If you set an accelerator using this method, then it will not work in the workbench if it conflicts any existing key binding, or if there is a different key binding defined for this action's definition id. The definition id should be used instead -- referring to the command in the workbench from which the key binding should be retrieved.- Specified by:
setAcceleratorin interfaceIAction- Overrides:
setAcceleratorin classAction- Parameters:
keycode- the keycode to be accepted.
-
setChecked
public void setChecked(boolean checked)
Description copied from interface:IActionSets the checked status of this action. Applicable for the stylesAS_CHECK_BOXorAS_RADIO_BUTTON.Fires a property change event for the
CHECKEDproperty if the checked status actually changes as a consequence.- Specified by:
setCheckedin interfaceIAction- Overrides:
setCheckedin classAction- Parameters:
checked- the new checked status- See Also:
IAction.CHECKED
-
setDescription
public void setDescription(String text)
Description copied from interface:IActionSets this action's description. Typically the description is shown as a (longer) help text in the status line.Fires a property change event for the
DESCRIPTIONproperty if the description actually changes as a consequence.- Specified by:
setDescriptionin interfaceIAction- Overrides:
setDescriptionin classAction- Parameters:
text- the description, ornullto clear the description- See Also:
IAction.DESCRIPTION
-
setDisabledImageDescriptor
public void setDisabledImageDescriptor(ImageDescriptor newImage)
Description copied from interface:IActionSets the disabled image for this action, as an image descriptor.Disabled images will be used on platforms that support changing the image when the item is disabled.Fires a property change event for the
IMAGEproperty if the image actually changes as a consequence.- Specified by:
setDisabledImageDescriptorin interfaceIAction- Overrides:
setDisabledImageDescriptorin classAction- Parameters:
newImage- the image, ornullif this action should not have an image- See Also:
IAction.IMAGE
-
setEnabled
public void setEnabled(boolean enabled)
Description copied from interface:IActionSets the enabled state of this action.When an action is in the enabled state, the control associated with it is active; triggering it will end up inkoking this action's
runmethod.Fires a property change event for the
ENABLEDproperty if the enabled state actually changes as a consequence.- Specified by:
setEnabledin interfaceIAction- Overrides:
setEnabledin classAction- Parameters:
enabled-trueto enable, andfalseto disable- See Also:
IAction.ENABLED
-
setHelpListener
public void setHelpListener(HelpListener listener)
Description copied from interface:IActionSets a help listener for this action.- Specified by:
setHelpListenerin interfaceIAction- Overrides:
setHelpListenerin classAction- Parameters:
listener- a help listener for this action
-
setHoverImageDescriptor
public void setHoverImageDescriptor(ImageDescriptor newImage)
Description copied from interface:IActionSets the hover image for this action, as an image descriptor.Hover images will be used on platforms that support changing the image when the user hovers over the item.Fires a property change event for the
IMAGEproperty if the image actually changes as a consequence.- Specified by:
setHoverImageDescriptorin interfaceIAction- Overrides:
setHoverImageDescriptorin classAction- Parameters:
newImage- the image, ornullif this action should not have an image- See Also:
IAction.IMAGE
-
setImageDescriptor
public void setImageDescriptor(ImageDescriptor newImage)
Description copied from interface:IActionSets the image for this action, as an image descriptor.Fires a property change event for the
IMAGEproperty if the image actually changes as a consequence.Note: This operation is a hint and is not supported in all contexts on platforms that do not have this concept (for example, Windows NT). Furthermore, some platforms (such as GTK), cannot display both a check box and an image at the same time. Instead, they hide the image and display the check box.
- Specified by:
setImageDescriptorin interfaceIAction- Overrides:
setImageDescriptorin classAction- Parameters:
newImage- the image, ornullif this action should not have an image- See Also:
IAction.IMAGE
-
setMenuCreator
public void setMenuCreator(IMenuCreator creator)
Description copied from class:ActionSets the menu creator for this action.Note that if this method is called, it overrides the check status.
- Specified by:
setMenuCreatorin interfaceIAction- Overrides:
setMenuCreatorin classAction- Parameters:
creator- the menu creator, ornullif none
-
setText
public void setText(String text)
Description copied from interface:IActionSets the text for this action.An accelerator is identified by the last index of a '\t' character. If there are no '\t' characters, then it is identified by the last index of an '@' character. If neither, then there is no accelerator text. Note that if you want to insert an '@' character into the text (but no accelerator), then you can simply insert an '@' or a '\t' at the end of the text.
An accelerator specification consists of zero or more modifier tokens followed by a key code token. The tokens are separated by a '+' character.Fires a property change event for the
TEXTproperty if the text actually changes as a consequence.- Specified by:
setTextin interfaceIAction- Overrides:
setTextin classAction- Parameters:
text- the text, ornullif none- See Also:
IAction.TEXT,Action.findModifier(java.lang.String),Action.findKeyCode(java.lang.String)
-
setToolTipText
public void setToolTipText(String text)
Description copied from class:ActionSets the tool tip text for this action.Fires a property change event for the
TOOL_TIP_TEXTproperty if the tool tip text actually changes as a consequence.- Specified by:
setToolTipTextin interfaceIAction- Overrides:
setToolTipTextin classAction- Parameters:
text- the tool tip text, ornullif none- See Also:
IAction.TOOL_TIP_TEXT
-
-