|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.action.Action
org.eclipse.ui.texteditor.TextNavigationAction
An Action
wrapper for text widget navigational and selection actions.
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, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT |
Constructor Summary | |
TextNavigationAction(StyledText textWidget,
int action)
Creates a new TextNavigationAction . |
Method Summary | |
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 |
getActionDefinitionId()
Returns the action definition id of 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. |
String |
getId()
Returns a unique identifier for this action, or null if it has
none. |
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 |
setActionDefinitionId(String id)
Sets the action definition id of this action. |
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 |
setId(String id)
Sets the unique identifier for this action. |
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. |
Methods inherited from class org.eclipse.jface.action.Action |
convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, firePropertyChange, firePropertyChange, notifyResult, removeAcceleratorText, removeMnemonics |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public TextNavigationAction(StyledText textWidget, int action)
TextNavigationAction
.
textWidget
- the text widgetaction
- the styled text widget actionMethod Detail |
protected 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
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
public void setActionDefinitionId(String id)
IAction
setActionDefinitionId
in interface IAction
setActionDefinitionId
in class Action
public String getActionDefinitionId()
IAction
getActionDefinitionId
in interface IAction
getActionDefinitionId
in class Action
public void setId(String id)
IAction
setId
in interface IAction
setId
in class Action
public String getId()
IAction
null
if it has
none.
getId
in interface IAction
getId
in class Action
public void addPropertyChangeListener(IPropertyChangeListener listener)
IAction
addPropertyChangeListener
in interface IAction
addPropertyChangeListener
in class Action
public int getAccelerator()
IAction
MenuItem.getAccelerator
.
getAccelerator
in interface IAction
getAccelerator
in class Action
public String getDescription()
IAction
getToolTipText()
.
getDescription
in interface IAction
getDescription
in class Action
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
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
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
public IMenuCreator getMenuCreator()
IAction
getMenuCreator
in interface IAction
getMenuCreator
in class Action
public int getStyle()
IAction
getStyle
in interface IAction
getStyle
in class Action
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
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
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
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
public void removePropertyChangeListener(IPropertyChangeListener listener)
IAction
removePropertyChangeListener
in interface IAction
removePropertyChangeListener
in class Action
public 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
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
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
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
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
public void setHelpListener(HelpListener listener)
IAction
setHelpListener
in interface IAction
setHelpListener
in class Action
public 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
public void setImageDescriptor(ImageDescriptor newImage)
IAction
Fires a property change event for the IMAGE
property
if the image actually changes as a consequence.
setImageDescriptor
in interface IAction
setImageDescriptor
in class Action
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)
Action
Fires a property change event for the TEXT
property
if the text actually changes as a consequence.
The accelerator is identified by the last index of a tab character. If there are no tab characters, then it is identified by the last index of a '@' character. If neither, then there is no accelerator text. Note that if you want to insert a '@' character into the text (but no accelerator, you can simply insert a '@' or a tab at the end of the text.
setText
in interface IAction
setText
in class Action
text
- the text, or null
if nonepublic 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 none
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.