OMUPROMPT

Purpose

To construct a custom UI in order to prompt for some information from the end user.

Prerequisites

None.

Syntax

parsePromptCommand =  OMUPROMPT "type" "name" [ "setPropertiesClause" ] { 
          "addComponentClause" }
     type =  "UNQUOTED_STRING"
     name =  "QUOTED_STRING"
     setPropertiesClause =  SET PROPERTIES "(" "propertyNameList" ")" VALUES "("
           "propertyValueList" ")"
     addComponentClause =  ADD "type" "name" [ "setPropertiesClause" ]
     propertyNameList =  PROPERTY_NAME { "," PROPERTY_NAME }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )

Parameters

parsePromptCommand

Construct a custom UI to prompt for information. This clause specifies the name of the dialog and the properties for the dialog.

type

The type of custom dialog or its component.  Currently only DIALOG is valid custom UI type.  For the type of a component UI, the valid types include CHECK_BOX, CHOICE_BOX, COMBO_BOX, FILE_CHOOSER, HYPERLINK, LABEL, LIST_BOX, PASSWORD_FIELD, RADIO_BUTTONS, SEPARATOR, TEXT_FIELD.

name

The name of the custom UI or UI component.

setPropertiesClause

This clause sets the properties for the custom UI or the UI component. 

Basic properties for CHECK_BOX :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The text to be displayed by the side of the check box.

Name: SELECTION
Type: BOOLEAN
Valid Values: true, false
Default: false
Whether the check box should be selected by default.


Basic properties for CHOICE_BOX :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: MESSAGE_TEXT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The message text to be displayed by the side of the choice box that describes what the selection is about.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The different choices shown in the choice box.  Needs to be a comma-separated list.

Name: SELECTION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The default selection of the choices.


Basic properties for COMBO_BOX :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: MESSAGE_TEXT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The message text to be displayed by the side of the combo box that describes what the selection is about.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The different choices shown in the combo box.  Needs to be a comma-separated list.

Name: SELECTION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The default selection of the choices.


Basic properties for DIALOG :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: TITLE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Title of the custom dialog.

Name: WIDTH
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: Empty string
The width of the custom dialog.  If either the height or the width is unspecified or set to 0, then the dialog will be auto-sized.

Name: HEIGHT
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: Empty string
The height of the custom dialog.  If either the height or the width is unspecified or set to 0, then the dialog will be auto-sized.

Name: LINE_WRAP
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: 2
CUSTOMUI_DIALOG_LINE_WRAP_DESC??

Name: OPTIONS
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The options for the dialog.  These translate into buttons at the bottom of the dialog.  A comma-separated list of values is expected here.  For example, a dialog with a YES and No button will need an OPTION of 'YES,NO'.

Name: DEFAULT_OPTION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The default option of the dialog.  This means the default button that will be pressed when the ENTER key is pressed.

Name: CANCEL_OPTION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The option that represents cancellation of the dialog.


Basic properties for FILE_CHOOSER :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: .
The default directory to be shown in the file chooser.

Name: SELECTION
Type: STRING
Valid Values: DIRECTORIES_ONLY, FILES_ONLY, FILES_AND_DIRECTORIES
Default: FILES_AND_DIRECTORIES
Tells whether the file chooser should allow selection of files only, directories only, or both files and directories.


Basic properties for HYPERLINK :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: MESSAGE_TEXT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The message text to be displayed as text for the link.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The URL of the link target location.


Basic properties for LABEL :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The content of the label.  This can be HTML-formatted text.


Basic properties for LIST_BOX :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: MESSAGE_TEXT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The message text to be displayed on top of the list box that describes what the selection is about.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The different choices shown in the list box.  Needs to be a comma-separated list.

Name: SELECTION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The default selection of the choices.


Basic properties for PASSWORD_FIELD :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: MESSAGE_TEXT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The message text to be displayed by the side of the password field that describes what the field is about.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The default content of the password field.


Basic properties for RADIO_BUTTONS :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: MESSAGE_TEXT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The message text to be displayed on top of the radio buttons that describes what the selection is about.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The different choices shown for the radio buttons.  Needs to be a comma-separated list.

Name: SELECTION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The default selection of the choices.


Basic properties for SEPARATOR :


Basic properties for TEXT_FIELD :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: MESSAGE_TEXT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The message text to be displayed by the side of the text field that describes what the field is about.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The default content of the text field.

addComponentClause

Add a UI component to the custom UI.

propertyNameList

The list of property names.

propertyValueList

The list of property values to set.

propertyValue

The value of the property.