org.mdi.bootstrap

Interface MDIAction

All Known Implementing Classes:

AbstractMDIAction

public interface MDIAction

Interface that all MDIFramework Actions must implement.

Method Summary

Modifier and Type	Method and Description
void	endAction() Performed after the action has ended, if necessary.
MDIActionHandler	getActionHandler() Return the MDIActionHandler interface
default java.lang.Object	getActionResult() Return the action result.
java.lang.String	getLongDescription() Return a long description of the action.
java.lang.String	getMessage() Return a message that will be presented in the application Message area.
java.lang.String	getShortDescription() Return a short description of the action.
void	run() Run the action.
void	setActionHandler(MDIActionHandler handler) Set the MDIActionHandler interface which can be used when custom particular operations must be perform at the end of a MDIAction.

Method Detail

run

void run()
  throws java.lang.Exception

Run the action. As the action is meant to be run for example in a in a ThreadQueue, the exception will be swallowed by the framework, and presented in an error panel after. Note that this method will be performed in a background Thread.

Throws:

java.lang.Exception - if an Exception is encountered while running the Action

setActionHandler

void setActionHandler(MDIActionHandler handler)

Set the MDIActionHandler interface which can be used when custom particular operations must be perform at the end of a MDIAction. Contrary to the endAction() method, such action handlers can be associated to any action at will.

Parameters:

handler - the handler

getActionHandler

MDIActionHandler getActionHandler()

Return the MDIActionHandler interface

Returns:

the handler

See Also:

setActionHandler(MDIActionHandler)

endAction

void endAction()

Performed after the action has ended, if necessary. This code will be performed in the event dispatching thread after the action has finished.

getShortDescription

java.lang.String getShortDescription()

Return a short description of the action.

Returns:

a short description of the action

getLongDescription

java.lang.String getLongDescription()

Return a long description of the action.

Returns:

the long description of the action

getMessage

java.lang.String getMessage()

Return a message that will be presented in the application Message area.

Returns:

the message

getActionResult

default java.lang.Object getActionResult()

Return the action result. Return null by default.

Returns:

the action result