de.tif.jacob.screen.dialogs.form
Interface IFormDialog

All Superinterfaces:

IDialog

public interface IFormDialog
extends IDialog

Field Summary

Fields inherited from interface de.tif.jacob.screen.dialogs.IDialog

RCS_ID, RCS_REV

Method Summary

void	addCheckBox(java.lang.String name, boolean checked, CellConstraints constraint)
void	addComboBox(IFormActionEmitter buttonCallback, java.lang.String name, java.lang.String[] values, int selectIndex, CellConstraints constraint) Add a ComboBox to the dialog.
void	addComboBox(java.lang.String name, java.lang.String[] values, int selectIndex, CellConstraints constraint) Add a ComboBox to the dialog.
void	addFileUpload(java.lang.String name, CellConstraints constraint) Add a file upload field to the dialog.
void	addFormButton(IFormActionEmitter callback, java.lang.String buttonLabel, CellConstraints constraint) Add a Form action button to the dialog.
void	addHeader(java.lang.String label, CellConstraints constraint) Add a header text to the dialog.
void	addLabel(java.lang.String label, CellConstraints constraint) Add a generic Label/Caption to the dialog
void	addListBox(java.lang.String name, java.lang.String[] values, int selectIndex, CellConstraints constraint) Add a list box component to the dialog.
void	addPasswordField(java.lang.String name, java.lang.String value, CellConstraints constraint) Add a password field to the dialog.
void	addSubmitButton(java.lang.String buttonId, java.lang.String buttonLabel) The label of the cancel button.
void	addTextArea(java.lang.String name, java.lang.String value, boolean readonly, boolean autowordwrap, CellConstraints constraint) Add a TextArea to the dialog.
void	addTextArea(java.lang.String name, java.lang.String value, boolean readonly, CellConstraints constraint) Add a TextArea to the dialog.
void	addTextArea(java.lang.String name, java.lang.String value, CellConstraints constraint) Add a TextArea to the dialog.
void	addTextField(java.lang.String name, java.lang.String value, boolean readonly, CellConstraints constraint) Add a TextField to the dialog.
void	addTextField(java.lang.String name, java.lang.String value, CellConstraints constraint) Add a TextField to the dialog.
void	addTextField(java.lang.String name, java.lang.String value, IAutosuggestProvider autosuggest, CellConstraints constraint) Add a TextField to the dialog.
java.lang.String	getCancelButton() Returns the label of the cancel button of null if no cancel button defined.
java.lang.String	getTitle() Returns the title of the dialog.
void	setCancelButton(java.lang.String cancelButton) The the label of the cancel button.
void	setDebug(boolean debugFlag) Enable/Disable the debug options of the dialog.

Methods inherited from interface de.tif.jacob.screen.dialogs.IDialog

show, show

Method Detail

addHeader

void addHeader(java.lang.String label,
               CellConstraints constraint)

Add a header text to the dialog. A header has a label and a right hand side line.

Example:
label -------------------------------

addLabel

void addLabel(java.lang.String label,
              CellConstraints constraint)

Add a generic Label/Caption to the dialog

addCheckBox

void addCheckBox(java.lang.String name,
                 boolean checked,
                 CellConstraints constraint)

addPasswordField

void addPasswordField(java.lang.String name,
                      java.lang.String value,
                      CellConstraints constraint)

Add a password field to the dialog. The name of the PasswordField represents the returned parameter if the user press [ok] in the dialog.

Parameters:

name - The name of the parameter which will be returned, if the user press [ok] in the dialog

value - The start value of the field.

constraint - The layout constraint of the element.

addTextField

void addTextField(java.lang.String name,
                  java.lang.String value,
                  CellConstraints constraint)

Add a TextField to the dialog. The name of the TextField represents the returned parameter if the user press [ok] in the dialog.

Parameters:

name - The name of the parameter which will be returned, if the user press [ok] in the dialog

value - The start value of the field.

constraint - The layout constraint of the element.

addTextField

void addTextField(java.lang.String name,
                  java.lang.String value,
                  IAutosuggestProvider autosuggest,
                  CellConstraints constraint)

Add a TextField to the dialog. The name of the TextField represents the returned parameter if the user press [ok] in the dialog.
The user get input support from the IAutosuggestProvider.

Parameters:

name - The name of the parameter which will be returned, if the user press [ok] in the dialog

value - The start value of the field.

autosuggest - The provider for the textfield autosuggest.

constraint - The layout constraint of the element.

addTextField

void addTextField(java.lang.String name,
                  java.lang.String value,
                  boolean readonly,
                  CellConstraints constraint)

Add a TextField to the dialog. The name of the TextField represents the returned parameter if the user press [ok] in the dialog. You can set the text field to readonly with the 'readonly' parameter.

Parameters:

name - The name of the parameter which will be returned, if the user press [ok] in the dialog

value - The start value of the field.

readonly - Toggle the readonly behaviour of the input field.

constraint - The layout constraint of the element.

addFileUpload

void addFileUpload(java.lang.String name,
                   CellConstraints constraint)

Add a file upload field to the dialog. The name represents the returned parameter if the user press [ok] in the dialog.

Parameters:

name - The name of the parameter which will be returned, if the user press [ok] in the dialog

constraint - The layout constraint of the element.

addTextArea

void addTextArea(java.lang.String name,
                 java.lang.String value,
                 CellConstraints constraint)

Add a TextArea to the dialog. The name of the TextField represents the returned parameter if the user press [ok] in the dialog.

Parameters:

name - The name of the parameter which will be returned, if the user press [ok] in the dialog

value - The start value of the field.

constraint - The layout constraint of the element.

addTextArea

void addTextArea(java.lang.String name,
                 java.lang.String value,
                 boolean readonly,
                 CellConstraints constraint)

Add a TextArea to the dialog. The name of the TextField represents the returned parameter if the user press [ok] in the dialog.

Parameters:

name - The name of the parameter which will be returned, if the user press [ok] in the dialog

value - The start value of the field.

readonly - Toggle the readonly behaviour of the input field.

constraint - The layout constraint of the element.

addTextArea

void addTextArea(java.lang.String name,
                 java.lang.String value,
                 boolean readonly,
                 boolean autowordwrap,
                 CellConstraints constraint)

Add a TextArea to the dialog. The name of the TextField represents the returned parameter if the user press [ok] in the dialog.

Parameters:

name - The name of the parameter which will be returned, if the user press [ok] in the dialog

value - The start value of the field.

readonly - Toggle the readonly behaviour of the input field.

autowordwrap - Toggle the word wrap behaviour of the input field. Default is [false].

constraint - The layout constraint of the element.

addComboBox

void addComboBox(java.lang.String name,
                 java.lang.String[] values,
                 int selectIndex,
                 CellConstraints constraint)

Add a ComboBox to the dialog. A ComboBox can't span more than one row.

Parameters:

name - The name of the parameter which will be returned, if the user press [ok] in the dialog

constraint - The layout constraint of the element.

addComboBox

void addComboBox(IFormActionEmitter buttonCallback,
                 java.lang.String name,
                 java.lang.String[] values,
                 int selectIndex,
                 CellConstraints constraint)

Add a ComboBox to the dialog. A ComboBox can't span more than one row.

Parameters:

buttonCallback - The callback which will be called if the user changed the selection in the opend dialog. The dialog will not be closed.

name - The name of the field/parameter

values - The values to select

selectIndex - The pre selected index

constraint - The position constraint of the element

addListBox

void addListBox(java.lang.String name,
                java.lang.String[] values,
                int selectIndex,
                CellConstraints constraint)

Add a list box component to the dialog.

Parameters:

name - the name of the parameter which will be returned, if the user press [ok] in the dialog

values - the list box entries

selectIndex - the index of the initially selected entry or -1, if no entry should be initially selected.

constraint - the layout constraint of the element.

setDebug

void setDebug(boolean debugFlag)

Enable/Disable the debug options of the dialog. The debug flag is useful to verify the form layout. In the debug modus the form dialog shows the FormLayout grid.

Parameters:

debugFlag - true to enable the debug feature.

setCancelButton

void setCancelButton(java.lang.String cancelButton)

The the label of the cancel button. If you set null the cancel button will be hidden.

Parameters:

cancelButton - The label of the cancel button or null to hide the button.

getCancelButton

java.lang.String getCancelButton()

Returns the label of the cancel button of null if no cancel button defined.

Returns:

Returns the label of the cancel button or null if no button visible

addSubmitButton

void addSubmitButton(java.lang.String buttonId,
                     java.lang.String buttonLabel)

The label of the cancel button. If you set null the ok button will be hidden.

Parameters:

buttonLabel - The label of the ok button or null to hide the button.

getTitle

java.lang.String getTitle()

Returns the title of the dialog. The title will be displayed in the top of the dialog.

Returns:

The title of the dialog.

addFormButton

void addFormButton(IFormActionEmitter callback,
                   java.lang.String buttonLabel,
                   CellConstraints constraint)

Add a Form action button to the dialog. The button does appear in the form dialog and not in the toolbar button bar.

The does not close if the user press the button. This is useful if you want make a server request to update dialog data.

Parameters:

callback - The callback object if the user has clicked the button

buttonLabel - The label of the button

constraint - The layout constraint of the element.