Package org.apache.hop.ui.core.dialog

Class BaseDialog

java.lang.Object

org.eclipse.swt.widgets.Dialog

org.apache.hop.ui.core.dialog.BaseDialog

Direct Known Subclasses:

BaseMessageDialog, FieldSelectionDialog

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

A base dialog class containing a body and a configurable button panel.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,org.eclipse.swt.widgets.Listener>	buttons
static int	ELEMENT_SPACING
static String	HOP_USE_NATIVE_FILE_DIALOG
static int	LABEL_SPACING
static int	MARGIN_SIZE
static int	MEDIUM_FIELD
static int	MEDIUM_SMALL_FIELD
static String	NO_DEFAULT_HANDLER
protected PropsUi	props
protected org.eclipse.swt.widgets.Shell	shell
static int	SHELL_WIDTH_OFFSET
static int	SMALL_FIELD
protected String	title
static int	VAR_ICON_HEIGHT	Deprecated.
static int	VAR_ICON_WIDTH	Deprecated.
protected int	width

Constructor Summary

Constructors

Constructor	Description
BaseDialog(org.eclipse.swt.widgets.Shell shell)
BaseDialog(org.eclipse.swt.widgets.Shell shell, String title, int width)

Method Summary

Modifier and Type	Method	Description
static void	addDefaultListeners(org.eclipse.swt.widgets.Composite composite, Consumer<Void> okConsumer)
protected abstract org.eclipse.swt.widgets.Control	buildBody()	Returns the last element in the body - the one to which the buttons should be attached.
protected void	buildFooter(org.eclipse.swt.widgets.Control anchorElement)
static void	defaultShellHandling(org.eclipse.swt.widgets.Shell shell, Consumer<Void> okConsumer, Consumer<Void> cancelConsumer)	Handle the shell specified until the OK (button) is consumed.
void	dispose()
int	open()
static int	openMessageBox(org.eclipse.swt.widgets.Shell parent, String title, String message, int flags)
static String	presentDirectoryDialog(org.eclipse.swt.widgets.Shell shell, IVariables variables)
static String	presentDirectoryDialog(org.eclipse.swt.widgets.Shell shell, TextVar textVar, String message, IVariables variables)
static String	presentDirectoryDialog(org.eclipse.swt.widgets.Shell shell, TextVar textVar, IVariables variables)
static String	presentFileDialog(boolean save, org.eclipse.swt.widgets.Shell shell, String[] filterExtensions, String[] filterNames, boolean folderAndFile)
static String	presentFileDialog(boolean save, org.eclipse.swt.widgets.Shell shell, TextVar textVar, org.apache.commons.vfs2.FileObject fileObject, String[] filterExtensions, String[] filterNames, boolean folderAndFile)
static String	presentFileDialog(boolean save, org.eclipse.swt.widgets.Shell shell, TextVar textVar, IVariables variables, String[] filterExtensions, String[] filterNames, boolean folderAndFile)
static String	presentFileDialog(boolean save, org.eclipse.swt.widgets.Shell shell, TextVar textVar, IVariables variables, org.apache.commons.vfs2.FileObject fileObject, String[] filterExtensions, String[] filterNames, boolean folderAndFile)
static String	presentFileDialog(org.eclipse.swt.widgets.Shell shell, String[] filterExtensions, String[] filterNames, boolean folderAndFile)
static String	presentFileDialog(org.eclipse.swt.widgets.Shell shell, TextVar textVar, org.apache.commons.vfs2.FileObject fileObject, String[] filterExtensions, String[] filterNames, boolean folderAndFile)
static String	presentFileDialog(org.eclipse.swt.widgets.Shell shell, TextVar textVar, IVariables variables, String[] filterExtensions, String[] filterNames, boolean folderAndFile)
static String	presentFileDialog(org.eclipse.swt.widgets.Shell shell, TextVar textVar, IVariables variables, org.apache.commons.vfs2.FileObject fileObject, String[] filterExtensions, String[] filterNames, boolean folderAndFile)
void	setButtons(Map<String,org.eclipse.swt.widgets.Listener> buttons)
static void	setDefaultIconsOnTabs(org.eclipse.swt.widgets.Composite composite)
void	setFooterTopPadding(int footerTopPadding)

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

NO_DEFAULT_HANDLER

public static final String NO_DEFAULT_HANDLER

See Also:

Constant Field Values

HOP_USE_NATIVE_FILE_DIALOG

@Variable(scope=APPLICATION,
          value="N",
          description="Set this value to \'Y\' if you want to use the system file open/save dialog when browsing files.")
public static final String HOP_USE_NATIVE_FILE_DIALOG

See Also:

Constant Field Values

MARGIN_SIZE

public static final int MARGIN_SIZE

See Also:

Constant Field Values

LABEL_SPACING

public static final int LABEL_SPACING

See Also:

Constant Field Values

ELEMENT_SPACING

public static final int ELEMENT_SPACING

See Also:

Constant Field Values

MEDIUM_FIELD

public static final int MEDIUM_FIELD

See Also:

Constant Field Values

MEDIUM_SMALL_FIELD

public static final int MEDIUM_SMALL_FIELD

See Also:

Constant Field Values

SMALL_FIELD

public static final int SMALL_FIELD

See Also:

Constant Field Values

SHELL_WIDTH_OFFSET

public static final int SHELL_WIDTH_OFFSET

See Also:

Constant Field Values

VAR_ICON_WIDTH

@Deprecated
public static final int VAR_ICON_WIDTH

Deprecated.

VAR_ICON_HEIGHT

@Deprecated
public static final int VAR_ICON_HEIGHT

Deprecated.

buttons

protected Map<String,org.eclipse.swt.widgets.Listener> buttons

shell

protected org.eclipse.swt.widgets.Shell shell

props

protected PropsUi props

width

protected int width

title

protected String title

Constructor Detail

BaseDialog

public BaseDialog(org.eclipse.swt.widgets.Shell shell)

BaseDialog

public BaseDialog(org.eclipse.swt.widgets.Shell shell,
                  String title,
                  int width)

Method Detail

presentFileDialog

public static final String presentFileDialog(org.eclipse.swt.widgets.Shell shell,
                                             String[] filterExtensions,
                                             String[] filterNames,
                                             boolean folderAndFile)

presentFileDialog

public static final String presentFileDialog(boolean save,
                                             org.eclipse.swt.widgets.Shell shell,
                                             String[] filterExtensions,
                                             String[] filterNames,
                                             boolean folderAndFile)

presentFileDialog

public static final String presentFileDialog(org.eclipse.swt.widgets.Shell shell,
                                             TextVar textVar,
                                             org.apache.commons.vfs2.FileObject fileObject,
                                             String[] filterExtensions,
                                             String[] filterNames,
                                             boolean folderAndFile)

presentFileDialog

public static final String presentFileDialog(boolean save,
                                             org.eclipse.swt.widgets.Shell shell,
                                             TextVar textVar,
                                             org.apache.commons.vfs2.FileObject fileObject,
                                             String[] filterExtensions,
                                             String[] filterNames,
                                             boolean folderAndFile)

presentFileDialog

public static final String presentFileDialog(org.eclipse.swt.widgets.Shell shell,
                                             TextVar textVar,
                                             IVariables variables,
                                             String[] filterExtensions,
                                             String[] filterNames,
                                             boolean folderAndFile)

presentFileDialog

public static final String presentFileDialog(boolean save,
                                             org.eclipse.swt.widgets.Shell shell,
                                             TextVar textVar,
                                             IVariables variables,
                                             String[] filterExtensions,
                                             String[] filterNames,
                                             boolean folderAndFile)

presentFileDialog

public static final String presentFileDialog(org.eclipse.swt.widgets.Shell shell,
                                             TextVar textVar,
                                             IVariables variables,
                                             org.apache.commons.vfs2.FileObject fileObject,
                                             String[] filterExtensions,
                                             String[] filterNames,
                                             boolean folderAndFile)

presentFileDialog

public static final String presentFileDialog(boolean save,
                                             org.eclipse.swt.widgets.Shell shell,
                                             TextVar textVar,
                                             IVariables variables,
                                             org.apache.commons.vfs2.FileObject fileObject,
                                             String[] filterExtensions,
                                             String[] filterNames,
                                             boolean folderAndFile)

presentDirectoryDialog

public static String presentDirectoryDialog(org.eclipse.swt.widgets.Shell shell,
                                            IVariables variables)

presentDirectoryDialog

public static String presentDirectoryDialog(org.eclipse.swt.widgets.Shell shell,
                                            TextVar textVar,
                                            IVariables variables)

presentDirectoryDialog

public static String presentDirectoryDialog(org.eclipse.swt.widgets.Shell shell,
                                            TextVar textVar,
                                            String message,
                                            IVariables variables)

buildBody

protected abstract org.eclipse.swt.widgets.Control buildBody()

Returns the last element in the body - the one to which the buttons should be attached.

Returns:

open

public int open()

buildFooter

protected void buildFooter(org.eclipse.swt.widgets.Control anchorElement)

setFooterTopPadding

public void setFooterTopPadding(int footerTopPadding)

dispose

public void dispose()

setButtons

public void setButtons(Map<String,org.eclipse.swt.widgets.Listener> buttons)

defaultShellHandling

public static void defaultShellHandling(org.eclipse.swt.widgets.Shell shell,
                                        Consumer<Void> okConsumer,
                                        Consumer<Void> cancelConsumer)

Handle the shell specified until the OK (button) is consumed. Set a default icon on the shell, add default selection handlers on fields. Set the appropriate size for the shell. If you have widgets on which you don't want to have this default selection handler to okConsumer, do:

widget.setData(NO_DEFAULT_HANDLER, true)

Parameters:

shell - The shell to handle.

okConsumer - What to do when the dialog information needs to be retained after closing.

cancelConsumer - What to do when the dialog is cancelled.

setDefaultIconsOnTabs

public static void setDefaultIconsOnTabs(org.eclipse.swt.widgets.Composite composite)

addDefaultListeners

public static void addDefaultListeners(org.eclipse.swt.widgets.Composite composite,
                                       Consumer<Void> okConsumer)

openMessageBox

public static final int openMessageBox(org.eclipse.swt.widgets.Shell parent,
                                       String title,
                                       String message,
                                       int flags)