iaction.java

jfa2ce 源码帮助开发人员更好的理解运用

    public String getText();

    /**
     * Returns the tool tip text for this action.
     * <p>
     * This method is associated with the <code>TOOL_TIP_TEXT</code> property;
     * property change events are reported when its value changes.
     * </p>
     *
     * @return the tool tip text, or <code>null</code> if none
     * @see #TOOL_TIP_TEXT
     */
    public String getToolTipText();

    /**
     * Returns the checked status of this action. Applicable only if the style is
     * <code>AS_CHECK_BOX</code> or <code>AS_RADIO_BUTTON</code>.
     * <p>
     * This method is associated with the <code>CHECKED</code> property;
     * property change events are reported when its value changes.
     * </p>
     *
     * @return the checked status
     * @see #CHECKED
     */
    public boolean isChecked();

    /**
     * Returns whether this action is enabled.
     * <p>
     * This method is associated with the <code>ENABLED</code> property;
     * property change events are reported when its value changes.
     * </p>
     *
     * @return <code>true</code> if enabled, and
     *   <code>false</code> if disabled
     * @see #ENABLED
     */
    public boolean isEnabled();

    /**
	 * Returns whether this action is handled. In the default case, this is
	 * always <code>true</code>. However, if the action delegates some of its
	 * behaviour to some other object, then this method should answer whether
	 * such an object is currently available.
	 * 
	 * @return <code>true</code> if all of the action's behaviour is
	 *         available; <code>false</code> otherwise.
	 * @since 3.1
	 */
	public boolean isHandled();

    /**
     * Removes the given listener from this action.
     * Has no effect if an identical listener is not registered.
     *
     * @param listener a property change listener
     */
    public void removePropertyChangeListener(IPropertyChangeListener listener);

    /**
     * Runs this action.
     * Each action implementation must define the steps needed to carry out this action.
     * The default implementation of this method in <code>Action</code>
     * does nothing.
     */
    public void run();

    /**
     * Runs this action, passing the triggering SWT event.
     * As of 2.0, <code>ActionContributionItem</code> calls this method
     * instead of <code>run()</code>.  
     * The default implementation of this method in <code>Action</code>
     * simply calls <code>run()</code> for backwards compatibility.
     * 
     * @param event the SWT event which triggered this action being run 
     * @since 2.0
     */
    public void runWithEvent(Event event);

    /**
     * Sets the action definition id of this action.
     * 
     * @param id the action definition id
     * @since 2.0
     */
    public void setActionDefinitionId(String id);

    /**
     * Sets the checked status of this action. Applicable for the styles
     * <code>AS_CHECK_BOX</code> or <code>AS_RADIO_BUTTON</code>.
     * <p>
     * Fires a property change event for the <code>CHECKED</code> property
     * if the checked status actually changes as a consequence.
     * </p>
     *
     * @param checked the new checked status
     * @see #CHECKED
     */
    public void setChecked(boolean checked);

    /**
     * Sets this action's description.
     * Typically the description is shown as a (longer) help text in the status line.
     * <p>
     * Fires a property change event for the <code>DESCRIPTION</code> property
     * if the description actually changes as a consequence.
     * </p>
     *
     * @param text the description, or <code>null</code> to clear the description
     * @see #DESCRIPTION
     */
    public void setDescription(String text);

    /**
     * Sets the disabled image for this action, as an image descriptor.
     * <p>
     * Disabled images will be used on platforms that support changing the image
     * when the item is disabled.Fires a property change event for 
     * the <code>IMAGE</code> property
     * if the image actually changes as a consequence.
     * </p>
     *
     * @param newImage the image, or <code>null</code> if this 
     *   action should not have an image
     * @see #IMAGE
     */
    public void setDisabledImageDescriptor(ImageDescriptor newImage);

    /**
     * Sets the enabled state of this action.
     * <p>
     * When an action is in the enabled state, the control associated with 
     * it is active; triggering it will end up inkoking this action's 
     * <code>run</code> method.
     * </p>
     * <p>
     * Fires a property change event for the <code>ENABLED</code> property
     * if the enabled state actually changes as a consequence.
     * </p>
     *
     * @param enabled <code>true</code> to enable, and
     *   <code>false</code> to disable
     * @see #ENABLED
     */
    public void setEnabled(boolean enabled);

    /**
     * Sets a help listener for this action. 
     *
     * @param listener a help listener for this action
     */
    public void setHelpListener(HelpListener listener);

    /**
     * Sets the hover image for this action, as an image descriptor.
     * <p>
     * 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 <code>IMAGE</code> property
     * if the image actually changes as a consequence.
     * </p>
     *
     * @param newImage the image, or <code>null</code> if this 
     *   action should not have an image
     * @see #IMAGE
     */
    public void setHoverImageDescriptor(ImageDescriptor newImage);

    /**
     * Sets the unique identifier for this action. This is used to identify actions
     * when added to a contribution manager.
     * It should be set when the action is created.  It should not be modified once
     * the action is part of an action contribution item.
     *
     * @param id the action id
     *
     * @see ActionContributionItem
     * @see IContributionItem#getId
     */
    public void setId(String id);

    /**
     * Sets the image for this action, as an image descriptor.
     * <p>
     * Fires a property change event for the <code>IMAGE</code> property
     * if the image actually changes as a consequence.
     * </p>
     *
     * @param newImage the image, or <code>null</code> if this 
     *   action should not have an image
     * @see #IMAGE
     */
    public void setImageDescriptor(ImageDescriptor newImage);

    /**
     * Sets the menu creator for this action. Applicable for style
     * <code>AS_DROP_DOWN_MENU</code>.
     *
     * @param creator the menu creator, or <code>null</code> if none
     */
    public void setMenuCreator(IMenuCreator creator);

    /**
     * Sets the text for this action.
     * <p>
     * An accelerator specification may follow the actual text, separated from it by
     * an '@' or a '\t' character.  An accelerator specification consists of zero or more 
     * modifier tokens followed by a key code token.  The tokens are separated by a '+' character.
     * </p>
     * <p>
     * Fires a property change event for the <code>TEXT</code> property
     * if the text actually changes as a consequence.
     * </p>
     *
     * @param text the text, or <code>null</code> if none
     * @see #TEXT
     * @see Action#findModifier
     * @see Action#findKeyCode
     */
    public void setText(String text);

    /**
     * Sets the tool tip text for this action.
     * <p>
     * Fires a property change event for the <code>TOOL_TIP_TEXT</code> property
     * if the tool tip text actually changes as a consequence.
     * </p>
     *
     * @param text the tool tip text, or <code>null</code> if none
     * @see #TOOL_TIP_TEXT
     */
    public void setToolTipText(String text);

    /**
     * <p>
     * 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 <code>SWT.CTRL | 'Z'</code>.
     * Use 0 for no accelerator.
     * </p>
     * <p>
     * This method should no longer be used for actions in the Eclipse workbench.
     * <code>IWorkbenchCommandSupport</code> and
     * <code>IWorkbenchContextSupport</code> 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.
     * </p>
     * 
     * @param keycode
     *            the keycode to be accepted.
     */
    public void setAccelerator(int keycode);
}