de.ipcon.schema

Interface FormattedChoiceDialogI

All Superinterfaces:

BasicDialogI, java.io.Serializable

All Known Subinterfaces:

BasicClientContextI, ClientContextI

All Known Implementing Classes:

BasicClient

public interface FormattedChoiceDialogI
extends BasicDialogI

Extends BasicDialogI} to provide advanced methods for showing dialogs that present a list of options, with a primary focus on enabling explicit formatting for Business Objects (BOs) via the cboFormat parameter.

Field Summary

Fields inherited from interface de.ipcon.tools.BasicDialogI

CANCELED, CONFIRMED, DENIED, TYPE_ERROR, TYPE_INFO, TYPE_PLAIN, TYPE_QUESTION, TYPE_WARNING

Method Summary

Modifier and Type	Method and Description
default java.lang.Object	showListChoiceDialog(java.lang.String title, java.lang.Object[] options) Shows a simple list choice dialog with no default selection.
default java.lang.Object	showListChoiceDialog(java.lang.String title, java.lang.Object[] options, int defaultIndex) Shows a simple list choice dialog with a default choice index.
default java.lang.Object	showListChoiceDialog(java.lang.String title, java.lang.Object[] options, int defaultIndex, java.lang.String cboFormat)
java.lang.Object	showListChoiceDialog(java.lang.String title, java.lang.Object[] options, int defaultIndex, java.lang.String cboFormat, boolean multiple) Shows a dialog window that allows the user to select one or more from the provided options.
default java.lang.Object	showListChoiceDialog(java.lang.String title, java.lang.Object[] options, java.lang.Object defaultChoice) Shows a simple list choice dialog with a default choice object.
default java.lang.Object	showListChoiceDialog(java.lang.String title, java.lang.Object[] options, java.lang.Object defaultChoice, java.lang.String cboFormat)
java.lang.Object	showListChoiceDialog(java.lang.String title, java.lang.Object[] options, java.lang.Object defaultChoice, java.lang.String cboFormat, boolean multiple) Shows a dialog window that allows the user to select one or more from the provided options.
default java.lang.Object[]	showMultiListChoiceDialog(java.lang.String title, java.lang.Object[] options)
default java.lang.Object[]	showMultiListChoiceDialog(java.lang.String title, java.lang.Object[] options, java.lang.Object[] defaultChoices)
java.lang.Object[]	showMultiListChoiceDialog(java.lang.String title, java.lang.Object[] options, java.lang.Object[] defaultChoices, java.lang.String cboFormat) Shows a dialog window that allows the user to select one or more from the provided options.

Methods inherited from interface de.ipcon.tools.BasicDialogI

showBigDecimalInputDialog, showBigDecimalInputDialog, showBigDecimalInputDialog, showBigDecimalInputDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showDateInputDialog, showDateInputDialog, showDateInputDialog, showDateInputDialog, showDateInputDialog, showError, showError, showError, showError, showError, showError, showError, showError, showException, showException, showException, showFileChooser, showFileChooser, showFileChooser, showFileChooser, showFileChooser, showFileChooser, showFileChooser, showFileChooser, showFilesChooser, showFilesChooser, showFilesChooser, showFilesChooser, showFilesChooser, showFilesChooser, showIntegerInputDialog, showIntegerInputDialog, showIntegerInputDialog, showIntegerInputDialog, showLongInputDialog, showLongInputDialog, showLongInputDialog, showLongInputDialog, showMessageDialog, showMessageDialog, showMessageDialog, showMessageDialogNonModal, showMessageDialogNonModal, showMessageDialogNonModal, showMultipleChoiceDialog, showMultipleChoiceDialog, showPasswordInputDialog, showPasswordInputDialog, showStringInputDialog, showStringInputDialog, showStringInputDialog, showStringInputDialog, showStringInputDialog, showTimespanInputDialog, showTimespanInputDialog, showTimespanInputDialog, showTimespanInputDialog, showTimespanInputDialog, showTimespanInputDialog, showTimespanInputDialog, showUserLoginDialog, showUserLoginDialog, showYesNoDialog

Method Detail

showListChoiceDialog

java.lang.Object showListChoiceDialog(java.lang.String title,
                                      java.lang.Object[] options,
                                      java.lang.Object defaultChoice,
                                      java.lang.String cboFormat,
                                      boolean multiple)

Shows a dialog window that allows the user to select one or more from the provided options. The default choice is specified by an Object, and explicit CBO formatting is allowed.

Parameters:

title - The title of the dialog window.

options - A non-empty array of options.

defaultChoice - The object to select by default.

cboFormat - Optional. An explicit formatting string used to render Business Objects (BOs) in the list. If null, the default BO formatting logic will be used.

multiple - If true, multiple options can be selected.

Returns:

The selected option(s) or null.

showMultiListChoiceDialog

java.lang.Object[] showMultiListChoiceDialog(java.lang.String title,
                                             java.lang.Object[] options,
                                             java.lang.Object[] defaultChoices,
                                             java.lang.String cboFormat)

Shows a dialog window that allows the user to select one or more from the provided options. The default choice is specified by an array of objects, and explicit CBO formatting is allowed.

Parameters:

title - The title of the dialog window.

options - A non-empty array of options.

defaultChoices - An array of objects to select by default.

cboFormat - Optional. An explicit formatting string used to render Business Objects (BOs) in the list. If null, the default BO formatting logic will be used.

Returns:

An array of the selected options, or null.

showListChoiceDialog

java.lang.Object showListChoiceDialog(java.lang.String title,
                                      java.lang.Object[] options,
                                      int defaultIndex,
                                      java.lang.String cboFormat,
                                      boolean multiple)

Shows a dialog window that allows the user to select one or more from the provided options. The default choice is specified by an index, and explicit CBO formatting is allowed.

Parameters:

title - The title of the dialog window.

options - A non-empty array of options.

defaultIndex - The index of the object to be selected by default.

cboFormat - Optional. An explicit formatting string used to render Business Objects (BOs) in the list. If null, the default BO formatting logic will be used.

multiple - If true, multiple options can be selected.

Returns:

The selected option(s) or null.

showListChoiceDialog

default java.lang.Object showListChoiceDialog(java.lang.String title,
                                              java.lang.Object[] options,
                                              java.lang.Object defaultChoice,
                                              java.lang.String cboFormat)

See Also:

(multiple=false)

showListChoiceDialog

default java.lang.Object showListChoiceDialog(java.lang.String title,
                                              java.lang.Object[] options,
                                              java.lang.Object defaultChoice)

Description copied from interface: BasicDialogI

Shows a simple list choice dialog with a default choice object.

Specified by:

showListChoiceDialog in interface BasicDialogI

Parameters:

title - The title of the dialog window.

options - A non-empty array of options.

defaultChoice - The object to select by default.

Returns:

The selected option or null.

See Also:

(multiple=false, cboFormat=null)

showMultiListChoiceDialog

default java.lang.Object[] showMultiListChoiceDialog(java.lang.String title,
                                                     java.lang.Object[] options,
                                                     java.lang.Object[] defaultChoices)

See Also:

(cboFormat=null)

showMultiListChoiceDialog

default java.lang.Object[] showMultiListChoiceDialog(java.lang.String title,
                                                     java.lang.Object[] options)

See Also:

(defaultChoices=null, cboFormat=null)

showListChoiceDialog

default java.lang.Object showListChoiceDialog(java.lang.String title,
                                              java.lang.Object[] options,
                                              int defaultIndex,
                                              java.lang.String cboFormat)

See Also:

(multiple=false)

showListChoiceDialog

default java.lang.Object showListChoiceDialog(java.lang.String title,
                                              java.lang.Object[] options,
                                              int defaultIndex)

Description copied from interface: BasicDialogI

Shows a simple list choice dialog with a default choice index.

Specified by:

showListChoiceDialog in interface BasicDialogI

Parameters:

title - The title of the dialog window.

options - A non-empty array of options.

defaultIndex - The index of the object to be selected by default.

Returns:

The selected option or null.

See Also:

(multiple=false, cboFormat=null)

showListChoiceDialog

default java.lang.Object showListChoiceDialog(java.lang.String title,
                                              java.lang.Object[] options)

Description copied from interface: BasicDialogI

Shows a simple list choice dialog with no default selection.

Specified by:

showListChoiceDialog in interface BasicDialogI

Parameters:

title - The title of the dialog window.

options - A non-empty array of options.

Returns:

The selected option or null.

See Also:

(multiple=false, defaultIndex=-1, cboFormat=null)