com.arcway.cockpit.docgen.provider.interfaces

Interface IUserInputRequester

public interface IUserInputRequester

The IUserInputRequester provides methods to request input from the user via special dialogs. The IUserInputRequester can be referenced directly within a document template by its name userInputRequester.

Method Summary

Modifier and Type	Method and Description
java.lang.String	requestStringInput(java.lang.String title, java.lang.String message, java.lang.String lable) Opens a dialog with a text field and requests the user to enter a text.
java.lang.String	requestStringInput(java.lang.String title, java.lang.String message, java.lang.String lable, java.lang.String defaultValue) Opens a dialog with a text field and requests the user to enter a text.
int	requestStringSelectionFromList(java.lang.String title, java.lang.String message, java.lang.String lable, java.util.List<java.lang.String> selectionList) Opens a dialog and requests the user to select a text from a list of text values.
int	requestStringSelectionFromList(java.lang.String title, java.lang.String message, java.lang.String lable, java.util.List<java.lang.String> selectionList, int indexOfDefaultValue) Opens a dialog and requests the user to select a text from a list of text values.

Method Detail

requestStringInput

java.lang.String requestStringInput(java.lang.String title,
                                    java.lang.String message,
                                    java.lang.String lable)

Opens a dialog with a text field and requests the user to enter a text.

Parameters:

title - Title of the dialog

message - Message dispalyed in the dialogs header

lable - Label of the requested text value

Returns:

entered text value (HTML encoded)

requestStringInput

java.lang.String requestStringInput(java.lang.String title,
                                    java.lang.String message,
                                    java.lang.String lable,
                                    java.lang.String defaultValue)

Opens a dialog with a text field and requests the user to enter a text.

Parameters:

title - Title of the dialog

message - Message dispalyed in the dialogs header

lable - Label of the requested text value

defaultValue - default value for input field

Returns:

entered text value (HTML encoded)

requestStringSelectionFromList

int requestStringSelectionFromList(java.lang.String title,
                                   java.lang.String message,
                                   java.lang.String lable,
                                   java.util.List<java.lang.String> selectionList)

Opens a dialog and requests the user to select a text from a list of text values. Opens a dialog with a text field and requests the user to enter a text.

Parameters:

title - Title of the dialog

message - Message dispalyed in the dialogs header

lable - Label of the requested text value

selectionList - List of text values

Returns:

selected text value (HTML encoded)

requestStringSelectionFromList

int requestStringSelectionFromList(java.lang.String title,
                                   java.lang.String message,
                                   java.lang.String lable,
                                   java.util.List<java.lang.String> selectionList,
                                   int indexOfDefaultValue)

Opens a dialog and requests the user to select a text from a list of text values. Opens a dialog with a text field and requests the user to enter a text.

Parameters:

title - Title of the dialog

message - Message dispalyed in the dialogs header

lable - Label of the requested text value

selectionList - List of text values

indexOfDefaultValue -

Returns:

selected text value (HTML encoded)