|
Eclipse Platform Release 3.3 |
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||
java.lang.Objectorg.eclipse.core.commands.common.EventManager
org.eclipse.jface.action.AbstractAction
org.eclipse.jface.action.Action
org.eclipse.ui.actions.PartEventAction
org.eclipse.ui.actions.RetargetAction
org.eclipse.ui.actions.LabelRetargetAction
A LabelRetargetAction extends the behavior of
RetargetAction. It will track the enable state, label, and
tool tip text of the target action..
This class may be instantiated. It is not intented to be subclassed.
| 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 | |
|---|---|
LabelRetargetAction(String actionID,
String text)
Constructs a LabelRetargetAction with the given action id and text. |
|
LabelRetargetAction(String actionID,
String text,
int style)
Constructs a RetargetAction with the given action id, text and style. |
|
| Method Summary | |
|---|---|
protected void |
propagateChange(PropertyChangeEvent event)
The action handler has changed. |
protected void |
setActionHandler(IAction handler)
Sets the action handler. |
void |
setDisabledImageDescriptor(ImageDescriptor image)
Sets the disabled image for this action, as an image descriptor. |
void |
setHoverImageDescriptor(ImageDescriptor image)
Sets the hover image for this action, as an image descriptor. |
void |
setImageDescriptor(ImageDescriptor image)
Sets the image for this action, as an image descriptor. |
void |
setText(String text)
Sets the action's label text to the given value. |
void |
setToolTipText(String text)
Sets the tooltip text to the given text. |
| Methods inherited from class org.eclipse.ui.actions.RetargetAction |
|---|
dispose, enableAccelerator, getAccelerator, getActionHandler, isHandled, partActivated, partClosed, partDeactivated, run, runWithEvent, setChecked, setHelpListener, toString |
| Methods inherited from class org.eclipse.ui.actions.PartEventAction |
|---|
getActivePart, partBroughtToTop, partOpened |
| Methods inherited from class org.eclipse.jface.action.Action |
|---|
convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, notifyResult, removeAcceleratorText, removeMnemonics, setAccelerator, setActionDefinitionId, setDescription, setEnabled, setId, setMenuCreator |
| 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 |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.eclipse.jface.action.IAction |
|---|
addPropertyChangeListener, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, removePropertyChangeListener, setAccelerator, setActionDefinitionId, setDescription, setEnabled, setId, setMenuCreator |
| Constructor Detail |
public LabelRetargetAction(String actionID,
String text)
actionID - the retargetable action idtext - the action's text, or null if there is no text
public LabelRetargetAction(String actionID,
String text,
int style)
actionID - the retargetable action idtext - the action's text, or null if there is no textstyle - one of AS_PUSH_BUTTON, AS_CHECK_BOX,
AS_DROP_DOWN_MENU, AS_RADIO_BUTTON, and
AS_UNSPECIFIED.| Method Detail |
protected void propagateChange(PropertyChangeEvent event)
propagateChange in class RetargetActionprotected void setActionHandler(IAction handler)
setActionHandler in class RetargetActionpublic void setDisabledImageDescriptor(ImageDescriptor image)
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 IActionsetDisabledImageDescriptor in class Actionpublic void setHoverImageDescriptor(ImageDescriptor image)
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 IActionsetHoverImageDescriptor in class Actionpublic void setImageDescriptor(ImageDescriptor image)
IAction
Fires a property change event for the IMAGE property
if the image actually changes as a consequence.
setImageDescriptor in interface IActionsetImageDescriptor in class Actionpublic void setText(String text)
setText in interface IActionsetText in class Actiontext - the text, or null if nonepublic void setToolTipText(String text)
null clears the tooltip text.
setToolTipText in interface IActionsetToolTipText in class Actiontext - the tool tip text, or null if none
|
Eclipse Platform Release 3.3 |
|||||||||||
| 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, 2007. All rights reserved.