public class TextNavigationAction extends Action
Action
wrapper for text widget navigation and selection actions.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 and Description |
---|
TextNavigationAction(StyledText textWidget,
int action)
Creates a new
TextNavigationAction . |
Modifier and Type | Method and Description |
---|---|
void |
addPropertyChangeListener(IPropertyChangeListener listener)
Adds a property change listener to this action.
|
protected void |
fireSelectionChanged()
Sends a selection event with the current selection to all
selection listeners of the action's text widget
|
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.
|
int |
getAccelerator()
Returns the accelerator keycode for this action.
|
String |
getDescription()
Returns the action's description if it has one.
|
ImageDescriptor |
getDisabledImageDescriptor()
Returns the disabled image for this action as an image descriptor.
|
HelpListener |
getHelpListener()
Returns a help listener for this action.
|
ImageDescriptor |
getHoverImageDescriptor()
Returns the hover image for this action as an image descriptor.
|
ImageDescriptor |
getImageDescriptor()
Returns the image for this action as an image descriptor.
|
IMenuCreator |
getMenuCreator()
Returns the menu creator for this action.
|
int |
getStyle()
Return this action's style.
|
String |
getText()
Returns the text for this action.
|
protected StyledText |
getTextWidget()
Returns the text widget this actions is bound to.
|
String |
getToolTipText()
Returns the tool tip text for this action.
|
boolean |
isChecked()
Returns the checked status of this action.
|
boolean |
isEnabled()
Returns whether this action is enabled.
|
void |
removePropertyChangeListener(IPropertyChangeListener listener)
Removes the given listener from this action.
|
void |
run()
The default implementation of this
IAction method does
nothing. |
void |
runWithEvent(Event event)
The default implementation of this
IAction method ignores
the event argument, and simply calls run() . |
void |
setAccelerator(int keycode)
Sets the accelerator keycode that this action maps to.
|
void |
setChecked(boolean checked)
Sets the checked status of this action.
|
void |
setDescription(String text)
Sets this action's description.
|
void |
setDisabledImageDescriptor(ImageDescriptor newImage)
Sets the disabled image for this action, as an image descriptor.
|
void |
setEnabled(boolean enabled)
Sets the enabled state of this action.
|
void |
setHelpListener(HelpListener listener)
Sets a help listener for this action.
|
void |
setHoverImageDescriptor(ImageDescriptor newImage)
Sets the hover image for this action, as an image descriptor.
|
void |
setImageDescriptor(ImageDescriptor newImage)
Sets the image for this action, as an image descriptor.
|
void |
setMenuCreator(IMenuCreator creator)
Sets the menu creator for this action.
|
void |
setText(String text)
Sets the text for this action.
|
void |
setToolTipText(String text)
Sets the tool tip text for this action.
|
convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getActionDefinitionId, getId, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, setActionDefinitionId, setId
firePropertyChange, firePropertyChange
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
public TextNavigationAction(StyledText textWidget, int action)
TextNavigationAction
.textWidget
- the text widgetaction
- the styled text widget actionprotected StyledText getTextWidget()
public void run()
Action
IAction
method does
nothing. Subclasses should override this method if they do not need
information from the triggering event, or override
runWithEvent(Event)
if they do.run
in interface IAction
run
in class Action
How radio buttons are handled
,
How check boxes are handled
protected void fireSelectionChanged()
protected void fireSelectionChanged(Point oldSelection)
oldSelection
- the old selectionpublic void runWithEvent(Event event)
Action
IAction
method ignores
the event argument, and simply calls run()
. Subclasses
should override this method if they need information from the triggering
event, or override run()
if not.runWithEvent
in interface IAction
runWithEvent
in class Action
event
- the SWT event which triggered this action being runHow radio buttons are handled
,
How check boxes are handled
public void addPropertyChangeListener(IPropertyChangeListener listener)
IAction
addPropertyChangeListener
in interface IAction
addPropertyChangeListener
in class AbstractAction
listener
- a property change listenerpublic int getAccelerator()
IAction
MenuItem.getAccelerator
.getAccelerator
in interface IAction
getAccelerator
in class Action
MenuItem.getAccelerator()
public String getDescription()
IAction
getToolTipText()
.getDescription
in interface IAction
getDescription
in class Action
null
public ImageDescriptor getDisabledImageDescriptor()
IAction
This method is associated with the IMAGE
property;
property change events are reported when its value changes.
getDisabledImageDescriptor
in interface IAction
getDisabledImageDescriptor
in class Action
null
if this action has no imageIAction.IMAGE
public HelpListener getHelpListener()
IAction
getHelpListener
in interface IAction
getHelpListener
in class Action
public ImageDescriptor getHoverImageDescriptor()
IAction
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 IMAGE
property;
property change events are reported when its value changes.
getHoverImageDescriptor
in interface IAction
getHoverImageDescriptor
in class Action
null
if this action has no imageIAction.IMAGE
public ImageDescriptor getImageDescriptor()
IAction
This method is associated with the IMAGE
property;
property change events are reported when its value changes.
getImageDescriptor
in interface IAction
getImageDescriptor
in class Action
null
if this action has no imageIAction.IMAGE
public IMenuCreator getMenuCreator()
IAction
getMenuCreator
in interface IAction
getMenuCreator
in class Action
null
if nonepublic int getStyle()
IAction
public String getText()
IAction
This method is associated with the TEXT
property;
property change events are reported when its value changes.
getText
in interface IAction
getText
in class Action
null
if noneIAction.TEXT
public String getToolTipText()
IAction
This method is associated with the TOOL_TIP_TEXT
property;
property change events are reported when its value changes.
getToolTipText
in interface IAction
getToolTipText
in class Action
null
if noneIAction.TOOL_TIP_TEXT
public boolean isChecked()
IAction
AS_CHECK_BOX
or AS_RADIO_BUTTON
.
This method is associated with the CHECKED
property;
property change events are reported when its value changes.
isChecked
in interface IAction
isChecked
in class Action
IAction.CHECKED
public boolean isEnabled()
IAction
This method is associated with the ENABLED
property;
property change events are reported when its value changes.
isEnabled
in interface IAction
isEnabled
in class Action
true
if enabled, and
false
if disabledIAction.ENABLED
public void removePropertyChangeListener(IPropertyChangeListener listener)
IAction
removePropertyChangeListener
in interface IAction
removePropertyChangeListener
in class AbstractAction
listener
- a property change listenerpublic void setAccelerator(int keycode)
IAction
Sets 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.
IWorkbenchCommandSupport
and
IWorkbenchContextSupport
provide 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.
setAccelerator
in interface IAction
setAccelerator
in class Action
keycode
- the keycode to be accepted.public void setChecked(boolean checked)
IAction
AS_CHECK_BOX
or AS_RADIO_BUTTON
.
Fires a property change event for the CHECKED
property
if the checked status actually changes as a consequence.
setChecked
in interface IAction
setChecked
in class Action
checked
- the new checked statusIAction.CHECKED
public void setDescription(String text)
IAction
Fires a property change event for the DESCRIPTION
property
if the description actually changes as a consequence.
setDescription
in interface IAction
setDescription
in class Action
text
- the description, or null
to clear the descriptionIAction.DESCRIPTION
public void setDisabledImageDescriptor(ImageDescriptor newImage)
IAction
Disabled images will be used on platforms that support changing the image
when the item is disabled.Fires a property change event for
the IMAGE
property
if the image actually changes as a consequence.
setDisabledImageDescriptor
in interface IAction
setDisabledImageDescriptor
in class Action
newImage
- the image, or null
if this
action should not have an imageIAction.IMAGE
public void setEnabled(boolean enabled)
IAction
When an action is in the enabled state, the control associated with
it is active; triggering it will end up inkoking this action's
run
method.
Fires a property change event for the ENABLED
property
if the enabled state actually changes as a consequence.
setEnabled
in interface IAction
setEnabled
in class Action
enabled
- true
to enable, and
false
to disableIAction.ENABLED
public void setHelpListener(HelpListener listener)
IAction
setHelpListener
in interface IAction
setHelpListener
in class Action
listener
- a help listener for this actionpublic void setHoverImageDescriptor(ImageDescriptor newImage)
IAction
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 IMAGE
property
if the image actually changes as a consequence.
setHoverImageDescriptor
in interface IAction
setHoverImageDescriptor
in class Action
newImage
- the image, or null
if this
action should not have an imageIAction.IMAGE
public void setImageDescriptor(ImageDescriptor newImage)
IAction
Fires a property change event for the IMAGE
property 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.
setImageDescriptor
in interface IAction
setImageDescriptor
in class Action
newImage
- the image, or null
if this action should not have
an imageIAction.IMAGE
public void setMenuCreator(IMenuCreator creator)
Action
Note that if this method is called, it overrides the check status.
setMenuCreator
in interface IAction
setMenuCreator
in class Action
creator
- the menu creator, or null
if nonepublic void setText(String text)
IAction
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 TEXT
property
if the text actually changes as a consequence.
setText
in interface IAction
setText
in class Action
text
- the text, or null
if noneIAction.TEXT
,
Action.findModifier(java.lang.String)
,
Action.findKeyCode(java.lang.String)
public void setToolTipText(String text)
Action
Fires a property change event for the TOOL_TIP_TEXT
property if the tool tip text actually changes as a consequence.
setToolTipText
in interface IAction
setToolTipText
in class Action
text
- the tool tip text, or null
if noneIAction.TOOL_TIP_TEXT
Copyright (c) 2000, 2018 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.