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

Class EnterStringDialog

java.lang.Object

org.eclipse.swt.widgets.Dialog

org.apache.hop.ui.core.dialog.EnterStringDialog

public class EnterStringDialog
extends org.eclipse.swt.widgets.Dialog

This dialog allows you to enter a (single line) String.

Constructor Summary

Constructors

Constructor	Description
EnterStringDialog(org.eclipse.swt.widgets.Shell parent, String string, String shellText, String lineText)	This constructs without allowing for variable substitution.
EnterStringDialog(org.eclipse.swt.widgets.Shell parent, String string, String shellText, String lineText, boolean allowVariables, IVariables variables)	Constructs with the ability to use environmental variable substitution.

Method Summary

Modifier and Type	Method	Description
void	dispose()
void	getData()
char	getEchoChar()	Gets echoChar
boolean	isMandatory()
String	open()
void	setEchoChar(char echoChar)
protected void	setFlags()
void	setMandatory(boolean mandatory)

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

Constructor Detail

EnterStringDialog

public EnterStringDialog(org.eclipse.swt.widgets.Shell parent,
                         String string,
                         String shellText,
                         String lineText)

This constructs without allowing for variable substitution. This constructor allows for backwards compatibility for objects that wish to create this object without variable substitution.

Parameters:

parent - Parent gui object

string - The string to display in the dialog

shellText -

lineText -

EnterStringDialog

public EnterStringDialog(org.eclipse.swt.widgets.Shell parent,
                         String string,
                         String shellText,
                         String lineText,
                         boolean allowVariables,
                         IVariables variables)

Constructs with the ability to use environmental variable substitution.

Parameters:

parent - Parent gui object

string - The string to display in the dialog

shellText -

lineText -

allowVariables - Indicates to allow environmental substitution

variables - This object has the has the environmental variables

Method Detail

open

public String open()

setFlags

protected void setFlags()

dispose

public void dispose()

getData

public void getData()

isMandatory

public boolean isMandatory()

Returns:

the mandatory

setMandatory

public void setMandatory(boolean mandatory)

Parameters:

mandatory - the manditory to set

getEchoChar

public char getEchoChar()

Gets echoChar

Returns:

value of echoChar

setEchoChar

public void setEchoChar(char echoChar)

Parameters:

echoChar - The echoChar to set