Package org.apache.hop.ui.workflow.action

Class ActionDialog

java.lang.Object

org.eclipse.swt.widgets.Dialog

org.apache.hop.ui.workflow.action.ActionDialog

Direct Known Subclasses:

ActionBaseDialog, ActionDummyDialog, ActionStartDialog, MissingActionDialog

public abstract class ActionDialog
extends org.eclipse.swt.widgets.Dialog

The ActionDialog class is responsible for constructing and opening the settings dialog for the action. Whenever the user opens the action settings in HopGui, it will instantiate the dialog class passing in the IAction object and call the

 open()
 

method on the dialog. SWT is the native windowing environment of HopGui, and it is typically the framework used for implementing action dialogs.

Field Summary

Fields

Modifier and Type	Field	Description
static ILoggingObject	loggingObject	The loggingObject for the dialog
protected IHopMetadataProvider	metadataProvider	The Metadata provider
protected PropsUi	props	A reference to the properties user interface
protected org.eclipse.swt.widgets.Shell	shell	A reference to the shell
protected IVariables	variables	The variables for the action dialogs
protected WorkflowMeta	workflowMeta	The workflow metadata object.

Constructor Summary

Constructors

Constructor	Description
ActionDialog(org.eclipse.swt.widgets.Shell parent, WorkflowMeta workflowMeta, IVariables variables)	Instantiates a new action dialog.

Method Summary

Modifier and Type	Method	Description
MetaSelectionLine<DatabaseMeta>	addConnectionLine(org.eclipse.swt.widgets.Composite parent, org.eclipse.swt.widgets.Control previous, String connection, org.eclipse.swt.events.ModifyListener lsMod)	Adds the connection line for the given parent and previous control, and returns a meta selection manager control
MetaSelectionLine<DatabaseMeta>	addConnectionLine(org.eclipse.swt.widgets.Composite parent, org.eclipse.swt.widgets.Control previous, DatabaseMeta selected, org.eclipse.swt.events.ModifyListener lsMod)	Adds the connection line for the given parent and previous control, and returns a meta selection manager control
void	dispose()
IHopMetadataProvider	getMetadataProvider()
WorkflowMeta	getWorkflowMeta()
boolean	isDisposed()
void	setActive()
void	setMetadataProvider(IHopMetadataProvider metadataProvider)

Methods inherited from class org.eclipse.swt.widgets.Dialog

checkSubclass, getParent, getStyle, getText, setText

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

loggingObject

public static final ILoggingObject loggingObject

The loggingObject for the dialog

metadataProvider

protected IHopMetadataProvider metadataProvider

The Metadata provider

variables

protected IVariables variables

The variables for the action dialogs

workflowMeta

protected WorkflowMeta workflowMeta

The workflow metadata object.

props

protected PropsUi props

A reference to the properties user interface

shell

protected org.eclipse.swt.widgets.Shell shell

A reference to the shell

Constructor Detail

ActionDialog

public ActionDialog(org.eclipse.swt.widgets.Shell parent,
                    WorkflowMeta workflowMeta,
                    IVariables variables)

Instantiates a new action dialog.

Parameters:

parent - the parent shell

workflowMeta - the workflow metadata object

Method Detail

setActive

public void setActive()

dispose

public void dispose()

isDisposed

public boolean isDisposed()

addConnectionLine

public MetaSelectionLine<DatabaseMeta> addConnectionLine(org.eclipse.swt.widgets.Composite parent,
                                                         org.eclipse.swt.widgets.Control previous,
                                                         DatabaseMeta selected,
                                                         org.eclipse.swt.events.ModifyListener lsMod)

Adds the connection line for the given parent and previous control, and returns a meta selection manager control

Parameters:

parent - the parent composite object

previous - the previous control

Returns:

the combo box UI component

addConnectionLine

public MetaSelectionLine<DatabaseMeta> addConnectionLine(org.eclipse.swt.widgets.Composite parent,
                                                         org.eclipse.swt.widgets.Control previous,
                                                         String connection,
                                                         org.eclipse.swt.events.ModifyListener lsMod)

Adds the connection line for the given parent and previous control, and returns a meta selection manager control

Parameters:

parent - the parent composite object

previous - the previous control

connection -

lsMod -

Returns:

the combo box UI component

getMetadataProvider

public IHopMetadataProvider getMetadataProvider()

setMetadataProvider

public void setMetadataProvider(IHopMetadataProvider metadataProvider)

getWorkflowMeta

public WorkflowMeta getWorkflowMeta()