Table of Contents

How to Use These Specifications

Each dynamic element specification that follows is divided into two sections: a synopsis and a description. The synopsis is designed to give you ready reference to the element's attributes, showing which ones are mandatory and which ones optional. The description explains the purpose of the element and each of its attributes.

The element synopses use several conventions that you should be aware of, for example: WOSubmitButton { action=submitForm; value=aString; [disabled=YES|NO;] [name=aName;] ... };

• Bold denotes words or characters that are to be taken literally (typed as they appear). For example, the action and value attributes are to be take literally in the synopsis above.
  

• Italic denotes words that represent something else or that can be varied. For example, submitForm represents a method in your script---the exact name of the method is your choice.
  

• Square brackets ([ ]) mean that the enclosed attribute or attributes are optional. The name attribute and its value are optional in the synopsis above.
  

• A vertical bar (|) separates two options that are mutually exclusive, as in "disabled=YES|NO" where the attribute's value must be either YES or NO.
  

• Ellipsis (...) represents additional attributes and values that you might add but that aren't part of the element's specification. When a dynamic element is asked to produce its HTML representation, these additional attributes and values are simply copied into the HTML stream. The values for these additional attributes can be derived dynamically, just as with the built-in attributes.
  

Another point to note concerns the capitalization of attribute names (action, value, disabled above). In the specifications that follow, compound attribute names are shown with the first letter of each embedded word capitalized. For example, WOActiveImage has an imageMapFile attribute. You can capitalize attributes exactly as shown in these specifications, or you can use all lowercase letters (imagemapfile). No other capitalization is allowed.

Table of Contents Next Section