Eclipse Plug-in Developer Guide (Galileo) - ExternalActionManager.IExecuteCallback (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.action
Interface ExternalActionManager.IExecuteCallback

All Known Implementing Classes:: ExternalActionManager.CommandCallback

Enclosing class:: ExternalActionManager

public static interface ExternalActionManager.IExecuteCallback

A callback for executing execution events. Allows ActionContributionItems to fire useful events.

Clients must not implement this interface and must not extend.

Since:: 3.4

Method Summary

void notDefined ( IAction action, NotDefinedException exception)
          Fires a NotDefinedException because the action was not defined.

void notEnabled ( IAction action, NotEnabledException exception)
          Fires a NotEnabledException because the action was not enabled.

void postExecuteFailure ( IAction action, ExecutionException exception)
          Creates an ExecutionException when the action returned a failure.

void postExecuteSuccess ( IAction action, Object returnValue)
          Fires an execution event when the action returned a success.

void preExecute ( IAction action, Event e)
          Fires an execution event before an action is run.

Method Detail

notEnabled

void notEnabled(
IAction action,
                
NotEnabledException exception)

Fires a NotEnabledException because the action was not enabled.

Parameters:: action - The action contribution that caused the exception, never null.; exception - The NotEnabledException, never null.

notDefined

void notDefined(
IAction action,
                
NotDefinedException exception)

Fires a NotDefinedException because the action was not defined.

Parameters:: action - The action contribution that caused the exception, never null.; exception - The NotDefinedException, never null.

preExecute

void preExecute(
IAction action,
                
Event e)

Fires an execution event before an action is run.

Parameters:: action - The action contribution that requires an execution event to be fired. Cannot be null.; e - The SWT Event, may be null.

postExecuteSuccess

void postExecuteSuccess(
IAction action,
                        
Object returnValue)

Fires an execution event when the action returned a success.

Parameters:: action - The action contribution that requires an execution event to be fired. Cannot be null.; returnValue - The command's result, may be null.

postExecuteFailure

void postExecuteFailure(
IAction action,
                        
ExecutionException exception)

Creates an ExecutionException when the action returned a failure.

Parameters:: action - The action contribution that caused the exception, never null.; exception - The ExecutionException, never null.