Defining the User Interface (DEFUI)
This section is divided into three parts:
- Design criteria for the Definition UI
- UI manipulation functions
- UI naming conventions
Design Criteria for the Definition UI
The definition user interface is put into a layer when the corresponding mail object is selected.
UI Boundaries
Maximum width 500 pixels
Maximum height 300 pixels
Form Elements
You may declare as many form elements as you like, as long as they are not in the list of defined form objects found in the following section.
Including Files
The Universal Email UI is contained in the "Configuration/Commands/" folder of the Dreamweaver platform you are developing on. Therefore, any media used (images, etc…) should be referred to with a relative path from this folder.
UI manipulation functions
There are three functions defined for use with the DEFUI:
-
openFileBrowse()
Argument: Form element to set as a string
Returns: Nothing
Typically used with input buttons that open file browse windows for a defn field.
Example: On click of the button, open a file browser and set the def2 form element to the resulting selection.
<input type="button" value="Browse..." name="d2browse" onClick="openFileBrowse('def2');">
-
openDataBinding()
Argument: Form element to set as a string
Returns: Nothing
Used with the lightning bolt image to open the dynamic data dialogue box.
Example:
On click of the button, open the dynamic data dialogue and set the def2 form element to the resulting selection.
<input type="image" src="../shared/UltraDev/images/Boltup.gif" onClick="openDynamicBinding('def2');">
-
setRadioButton()
Arguments: Radiobutton form element to set as a string, index of selection
Returns: Nothing
Example:
If the user's input to the BCCEV field is not blank, set the first instance of the BCCOp radio button group to checked.
<input type="text" name="BCCEV" style="width:240px" onBlur="if (findObject('BCCEV').value != '') setRadioButton('BCCOp',0)">
UI Naming Conventions
There are only two conventions that must be followed when naming your DEFUI form elements.
- Do not repeat form elements listed in the section Available defined form elements.
- Any elements you would like to send to the definition function must be named "defn" where n is a numeric index starting from 1 that corresponds to the entries property of the DEFUI tag.
|