Package org.apache.hop.workflow.action
Interface IActionDialog
-
public interface IActionDialogIActionDialog is the Java interface that implements the settings dialog of a action plugin. The responsibilities of the implementing class are listed below.
This method should return only after the dialog has been confirmed or cancelled. The method must conform to the following rules:
If the dialog is confirmed:
- The IAction object must be updated to reflect the new settings
- If the user changed any settings, the IAction object's "changed" flag must be set to true
- open() must return the IAction object
If the dialog is cancelled:
- The IAction object must not be changed
- The IAction object's "changed" flag must be set to the value it had at the time the dialog opened
- open() must return null
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanisDisposed()IActionopen()Opens a ActionDialog and waits for the dialog to be confirmed or cancelled.voidsetActive()Brings the dialog to the front if the dialog is already open.voidsetMetadataProvider(IHopMetadataProvider metadataProvider)The Metadata provider to pass
-
-
-
Method Detail
-
open
IAction open()
Opens a ActionDialog and waits for the dialog to be confirmed or cancelled.- Returns:
- the action interface if the dialog is confirmed, null otherwise
-
setActive
void setActive()
Brings the dialog to the front if the dialog is already open.
-
setMetadataProvider
void setMetadataProvider(IHopMetadataProvider metadataProvider)
The Metadata provider to pass- Parameters:
metadataProvider-
-
isDisposed
boolean isDisposed()
- Returns:
- true if the dialog is disposed.
-
-