Apple

Notes About This Reference

The component descriptions and the binding descriptions are taken directly from Apple's Dynamic Element Reference. This document exists to clarify and expand that document and make it more usable.

In/Out:
The "in/out" column indicates how a binding is used - for input or output.
Output bindings (or in/out bindings) CANNOT be bound to literals values, they must be bound to a variable, key-path, or method.

Required:
The "required" column has the values "Yes", "No", and "Conditionally". If a binding is "conditionally" required that means that there are several alternative ways to bind the component and each of these bindings are exclusive. Each alternative is separated by an empty table row.
For example, for WORepitition you may bind either "count" OR both "list" and "item". These are always exclusive.
The required bindings are listed first, followed by the conditional bindings, and lastly the optional bindings are listed in a separate group.

WOD Syntax

String Literal:
     someKey = "value";

Number Literal:
     someKey = 5;

Java Variable:
     someKey = somePublicVariable; // must be public or have public getter & setter methods

Java Method:
     someKey = somePublicMethodWithNoArgs; // note there are no parantheses here

Key-path for an EO:
     someKey = someEO.someAttribute;
OR
     someKey = someEO.someRelationship.someAttribute;

WOActionURL

WOActionURL enables the creation of URLs to invoke methods or specify pages to return. You can use this element for a variety of purposes, but it is primarily intended to support _javascript_ within a WebObjects application.

Binding Name	Binding Type	In/Out	Required	Description
action	action method	in	Conditionally	Action method to invoke when the URL is accessed. This method must return a an object that conforms to the WOActionResults interface such as WOComponent or WOResponse.

pageName	String	in	Conditionally	The name of a WebObjects page to display when the URL is accessed.

directActionName	String	in	Conditionally	The direct action method to invoke when the URL is accessed (minus the "Action" suffix). Defaults to “default”.
actionClass	String	in	No	The name of the class in which the directActionName can be found. Defaults to “DirectAction”.

fragmentIdentifier	String	in	No	Named location to display in the destination page (that is, an anchor in the destination page).
queryDictionary	NSDictionary	in	No	Takes a dictionary that should be appended to the hyperlink’s URL after a question mark character. The dictionary must be correctly encoded and will be merged with any existing query dictionary for a particular session ID. This will look like "?key=value"
secure	Boolean	in	No	Changes the URL prefix from http to https when WebObjects generates URLs for component actions and direct actions for this element. For this attribute to have any effect, you must provide bindings either for the action, directAction, actionClass, or pageName attribute (respecting the valid combinations).
?key	Object	in	No	Adds a key-value pair to the specified queryDictionary (or replaces an existing key) by prefixing the key with a "?". For example: ?x = y; puts the key "x" into the query dictionary with the value of the keypath y.

WOActiveImage

A WOActiveImage displays an image within the HTML page. If the WOActiveImage is disabled, it simply displays its image as a passive element in the page. If enabled, the image is active; that is, clicking the image generates a request.

WOActiveImages are intended to be used outside of an HTML form. WOActiveImage functions as a mapped, active image. When the user clicks in a WOActiveImage, the coordinates of the click are sent back to the server. Depending on where the user clicks, different actions are invoked. An image map file associates actions with each of the defined areas of the image. If an image map file is not specified, the method specified by the action attribute is performed when the image is clicked, or if the href attribute is specified, the image acts as a hyperlink and takes you to that destination.

Within an HTML form, a WOActiveImage functions as a graphical submit button. However, it is better to use a WOImageButton instead of WOActiveImage to create a graphic submit button or a mapped image within a form.

Binding Name	Binding Type	In/Out	Required	Description
Action to take: choose either "action", "directActionName", or "href"
action	action method	in	Conditionally	Method to invoke when this element is clicked. If imageMapFile is specified, action is only invoked if the click is outside any mapped area. In other words, action defines the default action of the active image.

directActionName	String	in	Conditionally	The direct action method to invoke when the URL is accessed (minus the "Action" suffix). Defaults to “default”.
actionClass	String	in	No	The name of the class in which the directActionName can be found. Defaults to “DirectAction”.

href	String	in	Conditionally	URL to direct the browser to as a default when the image is clicked and no hot zones are hit.

Image source: choose either "filename", "src", "value", or "data"
filename	String	in	Conditionally	Path to the image relative to the WebServerResources directory.
framework	String	in	No	Framework that contains the image file. This attribute is only necessary if the image file is in a different location from the component. That is, if the component and the image file are both in the application or if the component and the image file are both in the same framework, this attribute isn’t necessary. If the image file is in a framework and the component is in the application, specify the framework’s name here (minus the .framework extension). If the image file should be in the application but the component is in a framework, specify the "app" keyword in place of the framework name.

src	String	in	Conditionally	URL containing the image data. Use this attribute for complete URLs; for relative URLs use filename instead.

value	WOElement	in	Conditionally	Image data in the form of a WOElement object. This data can come from a database, a file, or memory.

data	NSData	in	Conditionally	Specifies an image resource in the form of an NSData; this data can come from a database, a file, or memory. If you specify resource data, you must specify a MIME type.
mimeType	String	in	Conditionally	A string designating a MIME resource type, such as “image/gif”, to be put in the content-type header field; this type tells the client what to do with data. If you provide data but no MIME type, an exception is thrown.
key		in	No	A string that the application uses as a key for caching the data specified in data. If you do not provide a key, the data object must be fetched each time it is needed. For further information, see the reference documentation for the WOResourceManager class, (in particular, see the flushDataCache method).

Optional bindings
imageMapFile	String	in	No	Name of the image map file. See “The Image Map File” for more details.
name	String	in	No	If name is specified then the hit point is specified as name.x=value; name.y=value; in the form. This is useful when you need to use this element to submit a form to an external URL that expects the hit point to be expressed in a certain format.
x	int	out	No	If specified, returns the coordinates of the user’s click within the image.
y	int	out	No	If specified, returns the coordinates of the user’s click within the image.
target	String	in	No	Frame in a frameset that will receive the page returned as a result of the user’s click.
disabled	boolean	in	No	If disabled evaluates to true, a regular image element (<IMG>) is generated rather than an active image.
secure	boolean	in	No	Changes the URL prefix from http to https when WebObjects generates URLs for component actions and direct actions for this element. For this attribute to have any effect, you must provide bindings either for the action, directAction, actionClass, or pageName attribute (respecting the valid combinations).

WOApplet

WOApplet is a dynamic element that generates HTML to specify a Java applet. The applet’s parameters are passed by one or more WOParam elements.

Binding Name	Binding Type	In/Out	Required	Description
code	String	in	Yes	Name of the Java class.
width	int	in	Yes	Width, in pixels, of the area to allocate for the applet.
height	int	in	Yes	Height, in pixels, of the area to allocate for the applet.
associationClass	String	in	No	Name of the Java subclass of WOAssociation that aids in communication between client applet and the server.
codeBase	String	in	No	Directory that contains the applet code. If this attribute is omitted, the applet code is assumed to be in the same directory as the template HTML file.
archive	String	in	No	Comma-separated list of URLs for jar archive files containing classes and other resources that will be preloaded. (Note: Currently, most browsers do not support a comma-separated list, so only a single archive file may be used.) Use this attribute for archive files that you have generated outside of a WebObjects application or framework. The value for this attribute is appended to the archiveNames attribute value.
archiveNames	String	in	No	Comma-separated list of archive files containing classes and other resources that will be preloaded. (Note: Currently, most browsers do not support a comma-separated list, so only a single archive file may be used.) Use this attribute for archive files that are built as part of a WebObjects application or framework project.
object	Object	in	No	File containing serialized representation of the applet.
hspace	int	in	No	Amount of whitespace (in pixels) to the left and right of the applet.
vspace	in	in	No	Amount of whitespace (in pixels) at the top and bottom of the applet.
align	String	in	No	Alignment of the applet. Possible values are top, bottom, left, right, and middle.

WOBody

WOBody specifies the background image to display for the HTML page. All bindings for this element are related to the background image.

Binding Name	Binding Type	In/Out	Required	Description
src	String	in	Conditionally	URL containing the image data. Use this attribute for complete URLs; for relative URLs use filename instead.

filename	String	in	Conditionally	Path to the image relative to the WebServerResources directory.
framework	String	in	No	Framework that contains the image file. This attribute is only necessary if the image file is in a different location from the component. That is, if the component and the image file are both in the application or if the component and the image file are both in the same framework, this attribute isn’t necessary. If the image file is in a framework and the component is in an application, specify the framework’s name here (minus the .framework extension). If the image file should be in the application but the component is in a framework, specify the "app" keyword in place of the framework name.

data	NSData	in	Conditionally	Specifies any resource in the form of an NSData object; this data can come from a database, a file, or memory. If you specify resource data, you must specify a MIME type.
mimeType	String	in	Conditionally	A string designating a MIME resource type, such as “image/gif”; this type tells the client what to do with data. If you provide data but no MIME type, WebObjects throws an exception.
key	String	in	No	A string that functions as a key for caching the data specified in data. If you do not provide a key, the data object must be fetched each time it is needed. For further information, see the reference documentation for the WOResourceManager class (pay particular attention to the flushDataCache method).

WOBrowser

WOBrowser displays itself as a selection list that displays multiple items at a time. The related element WOPopUpButton is similar to WOBrowser except that it restricts the display to only one item at a time.

You should provide the title of an item in displayString rather than in value. If there is no binding for displayString, the string assigned to value is used for the item.

Binding Name	Binding Type	In/Out	Required	Description
list	NSArray<T>	in	Yes	Array of objects from which the browser derives its values. For example, colleges could name the list containing objects that represent individual schools.
item	T (type of the array elements)	out	Yes	Identifier for the elements of the list. For example, aCollege could represent an object in the colleges array.
displayString	String	in	No	Value to display in the selection list; for example, aCollege.name for each college object in the list.
value	String	in	No	For each OPTION tag within the selection, this is the value attribute (that is, <OPTION value=someValue>). This value can be used as an identifier of an item in the list.
escapeHTML	boolean	in	No	If escapeHTML evaluates to true , the string rendered by displayString is converted so that characters which would be interpreted as HTML control characters become their escaped equivalent (this is the default). Thus, if a your displayString is “a <b>bold</b> idea”, the string passed to the client browser would be “a <B>bold</B> idea”, but it would display in the browser as “a <b>bold</b> idea”. If escapeHTML evaluates to false , WebObjects simply passes your data to the client browser “as is.” In this case, the above example would display in the client browser as “a bold idea”. If you are certain that your strings have no characters in them which might be interpreted as HTML control characters, you get better performance if you set escapeHTML to false .
selections	NSArray<T>	out	No	Array of objects that the user chose from list. For the college example, selections would hold college objects.
selectedValues	NSArray<String>	out	No	Array of values that is used with Direct Actions to specify which options in a list are selected.
name	String	in	No	Name that uniquely identifies this element within the form. You can specify a name or let WebObjects automatically assign one at runtime.
disabled	boolean	in	No	If disabled evaluates to true , this element appears in the page but is not active. That is, selections won’t contain the user’s selection when the page is submitted.
multiple	boolean	in	No	If multiple evaluates to true , the user can select multiple items from the list. Otherwise, the user can select only one item from the list. The default is false .
size	int	in	No	How many items to display at one time. The default is 5. size must be greater than 1.

WOCheckBox

A WOCheckBox object displays itself in the HTML page as its namesake, a check box user interface control. It corresponds to the HTML element <INPUT TYPE="CHECKBOX"...>.

If you want to create a list of check boxes, use the WXCheckBoxList dynamic element in the WebObjects examples.

Binding Name	Binding Type	In/Out	Required	Description
checked	boolean	in/out	Conditionally	During page generation, if checked evaluates to true, the check box appears in the checked state. During request handling, checked reflects the state the user left the check box in: true if checked; false if not.

value	boolean	in	Conditionally	Value of this input element. If not specified, WebObjects provides a default value.
selection	boolean	out	No	If selection and value are equal when the page is generated, the check box is checked. When the page is submitted, selection is assigned the value of the check box.

name	String	in	No	Name that uniquely identifies this element within the form. You may specify a name or let WebObjects automatically assign one at runtime.
disabled	boolean	in	No	If disabled evaluates to true, this element appears in the page but is not active. That is, selection won’t contain the user’s selection when the page is submitted.

WOCheckBoxList

WOCheckBoxList displays a list of check boxes. The user may select several of the objects in the list, and this sublist is returned as selections. You should provide the title of a checkbox in displayString rather than in value. If there is no binding for displayString, the string assigned to value is used to identify the checkbox.

Note: This dynamic element is deprecated. Use the WXCheckBoxList dynamic element in the WebObjects examples.

Binding Name	Binding Type	In/Out	Required	Description

WOComponentContent

WOComponentContent allows you to write nested components as HTML container elements: Elements that can include text and other elements between their opening and closing tags. Using WOComponentContent you can, for example, write a component that defines the header and footer for all of your application’s pages.

The WOComponentContent dynamic element doesn’t have any attributes. It’s simply a marker that specifies where the contents wrapped by the component’s <WEBOBJECT> tag should go.

Note: You can only have one WOComponentContent element in a given component.

Example

Binding Name	Binding Type	In/Out	Required	Description

WOConditional

A WOConditional object controls whether a portion of the HTML page will be generated, based on the evaluation of its assigned condition.

Example

Binding Name	Binding Type	In/Out	Required	Description
condition	boolean	in	Yes	If condition evaluates to true, and assuming that negate is false, the contents of the WOConditional are displayed (the portion of the component within the WOConditional is generated).
negate	boolean	in	No	Inverts the sense of the condition. By default, negate is assumed to be false.

WOEmbeddedObject

A WOEmbeddedObject provides support for Netscape plug-ins. It corresponds to the HTML element <EMBED SRC = "" If the embedded object’s content comes from outside the WebObjects application, use the src attribute. If the embedded object’s content is returned by a method within the WebObjects application, use the filename attribute or the data and mimeType attributes.

Binding Name	Binding Type	In/Out	Required	Description
value	WOElement	in	Conditionally	The content for this embedded object in the form of a WOElement object. This data can come from a database, a file, or memory.

src	String	in	Conditionally	URL containing the embedded object. Use this attribute for complete URLs; for relative URLs use filename instead.

filename	String	in	Conditionally	Path to the embedded object relative to the WebServerResources directory.
framework	String	in	No	Framework that contains the embedded object. This attribute is only necessary if the object is in a different location from the component. That is, if the component and the embedded object are both in the application or if the component and the embedded object are both in the same framework, this attribute isn’t necessary. If the embedded object is in a framework and the component is in an application, specify the framework’s name here minus the .framework extension. If the embedded object should be in the application but the component is in a framework, specify the "app" keyword in place of the framework name.

data	NSData	in	Conditionally	Specifies any resource in the form of an NSData; this data can come from a database, a file, or memory. If you specify resource data, you must specify a MIME type.
mimeType	String	in	Conditionally	A string designating a MIME resource type, such as “image/gif”; this type tells the client what to do with data. If you provide data but no MIME type, WebObjects will raise.
key	String	in	No	A string that functions as a key for caching the data specified in data. If you do not provide a key, the data object is fetched each time it is needed. For further information, see the reference documentation for WOResourceManager, particularly that for the flushDataCache method.

WOFileUpload

A WOFileUpload element displays a form element in which a client browser can specify a file to be uploaded to the server. It corresponds to the HTML: <INPUT type=file>.

WOFileUpload elements inside of a WOForm require that the WOForm have the attribute’s encoding type set as follows:

enctype = "multipart/form-data"

For further information on the file upload specification, see RFC1867: http://www.w3.org/RT/REC-html32.html#rfc1867.

If you want to process a file upload in a direct action, use WORequest’s formValueForKey method to get the contents of the file that has been uploaded. This method is declared as follows:

public java.lang.Object formValueForKey(java.lang.String aKey)

In WebObjects 5.2, support for streaming file uploads was added. To support this, these bindings were added: inputStream; bufferSize; outputStream; streamToFilePath; overwrite; finalFilePath.

Binding Name	Binding Type	In/Out	Required	Description
filePath	String	in	Yes	The full file path and name of the file uploaded is sent by the browser and returned as a string to the variable or method bound to this attribute.
data	NSData	out	Yes	The file that is uploaded will be returned as an NSData object to the variable or method bound to this attribute.
inputStream	String	in	No	WebObjects sets this attribute to an InputStream representing the contents of the file upload. This binding can be used only when it is the only WOFileUpload element on the page. Also, within a form with other input elements, it has to be the last element. This implies that the form’s multipleSubmit attribute must not be set to true when it contains a WOFileUpload with the InputStream attribute. Otherwise, the WOFileUpload element raises an exception. This attribute is bound by the end of the file content data.
bufferSize	int	in	No	Sets the size (in bytes) of the buffer used by the outputStream and streamToFilePath attributes. The default buffer size is 512KB. There is no reasonable restriction on the buffer size.
outputStream	String	out	No	WebObjects copies the file upload data from the content to the outputStream specified by this attribute.
streamToFilePath	String	in	No	WebObjects writes the file upload data from the content directly to the file path specified in this attribute. This is an atomic operation—the data is written to a temporary file, which is renamed when the process is complete.
overwrite	boolean	in	No	When streamToFilePath is specified, this binding determines whether WebObjects should overwrite an existing file. Defaults to false.
finalFilePath	String	out	No	When streamToFilePath is specified, its value is set to the actual file location (it may differ from the streamToFilePath value if there is a problem renaming the file).

WOForm

A WOForm is a container element that generates a fill-in form. It gathers the input from the input elements it contains and sends it to the server for processing. WOForm corresponds to the HTML element <FORM ... > ... </FORM>.

Binding Name	Binding Type	In/Out	Required	Description
action	action method	in	Conditionally	Action method that’s invoked when the form is submitted. If the form contains a dynamic element that has its own action (such as a WOSubmitButton or a WOActiveImage), that action is invoked instead of the WOForm’s.

href	String	in	Conditionally	URL specifying where the form will be submitted.

multipleSubmit	boolean	in	No	If multipleSubmit evaluates to true , the form can have more than one WOSubmitButton, each with its own action. By default, WOForm supports only a single WOSubmitButton. Note: Some older browsers support only a single submit button in a form.

WOFrame

WOFrame represents itself as a dynamically generated Netscape frame element.

Binding Name	Binding Type	In/Out	Required	Description
value	WOElement?	in	Conditionally	Method that will supply the content for this frame.

src	String	in	Conditionally	External source that will supply the content for this frame.

pageName	String	in	Conditionally	Name of WebObjects page that will supply the content for this frame.

directActionName	String	in	Conditionally	The name of the direct action method (minus the "Action" suffix) that will supply the content for the frame.
actionClass	String	in	No	The name of the class in which the method designated in directActionName can be found. Defaults to “DirectAction”.

WOGenericContainer

WOGenericContainer supports development of reusable components that closely model the behavior of common HTML elements. For example, along with WOComponentContent, you can use WOGenericContainer to implement your own hyperlink element as a reusable component. WOGenericContainer has attributes that support the takeValuesFromRequest and invokeAction phases of the component-action request-response loop.

Binding Name	Binding Type	In/Out	Required	Description
elemetName	String	in	Yes	Name of the HTML tag. This name (for example “TEXTAREA”) will be used to generate the container’s opening and closing tags (<TEXTAREA>...</TEXTAREA>). elementName can either be a constant or a variable, such as a key path. You can also set the value of this attribute to or null, which effectively shuts off this element (that is, WebObjects doesn’t generate HTML tags for this element). Alternatively, you can use the omitTags attribute to achieve the same effect.
omitTags	boolean	in	No	Specifies whether the element's tags should be displayed. This attribute is useful for defining an element that conditionally wraps HTML in a container tag. The default value is false. If omitTags is true, the contents of the tag are rendered but not the tags themselves. Using omitTags for a container makes the container itself optional.
elementID	String	in	No	Allows programmatic access to the element's element ID. This is a read-only attribute.
otherTagString	String	in	No	Enables any string to be part of the opening tag. This permits standalone attributes such as "checked" or "selected" to be part of a tag.
formValue	String	out	No	Enables implementation of input-type elements (for example, WOTextField). Bind these attributes to a variable that can contain the component’s input value. During the takeValuesFromRequest phase, if the element ID of the current generic container matches an element ID of a form value in the request, the form value is pushed into the component using this attribute. The formValue attribute corresponds to WORequest’s formValueForKey. In other words, formValue pushes a single attribute .
formValues	NSArray	out	No	Enables implementation of input-type elements (for example, WOTextField). Bind these attributes to a variable that can contain the component’s input value. During the takeValuesFromRequest phase, if the element ID of the current generic container matches an element ID of a form value in the request, the form value is pushed into the component using this attribute. The formValue attribute corresponds to WORequest’s formValuesForKey method. In other words, formValues pushes an array of attributes.
invokeAction	action method	in	No	Enables implementation of action elements (for example, WOHyperlink). During the invokeAction phase, if the element ID of the current generic container matches the sender ID of the URL, the method bound to this attribute is evaluated. Just as with any action method, it must return an object that conforms to the WOActionResults interface, such as WOComponent or WOResponse.

WOGenericElement

WOGenericElement supports development of reusable components that closely model the behavior of common HTML elements. For example, you can use WOGenericElement to implement your own image (IMG) element as a reusable component. WOGenericElement has attributes that support the takeValuesFromRequest and invokeAction phases of the component-action request-response loop.

Binding Name	Binding Type	In/Out	Required	Description
elementName	String	in	Yes	Name of the HTML tag. This name (for example “HR”) will be used to generate the element’s tag (<HR>). elementName can either be a constant or a variable, such as a key path. You can also set the value of this attribute to null, which effectively shuts off this element (that is, WebObjects doesn’t generate HTML tags for this element). Alternatively, you can use the omitTags attribute to achieve the same effect.
omitTags	boolean	in	No	Specifies whether the element's tag should be displayed. The default value is false . If omitTags is true , the entire element is not rendered.
elementID	String	in	No	Allows access to the element's element ID. This is a read-only attribute.
otherTagString	String	in	No	Enables any string to be part of the opening tag. This permits standalone attributes such as "checked" or "selected" to be part of a tag.
formValue	String	out	No	Enables implementation of input-type elements (for example, WOTextField). Bind these attributes to a variable that can contain the component’s input value. During the takeValuesFromRequest phase, if the element ID of the current generic container matches an element ID of a form value in the request, the form value is pushed into the component using this attribute. The formValue attribute corresponds to WORequest’s formValueForKey. In other words, formValue pushes a single attribute .
formValues	NSArray	out	No	Enables implementation of input-type elements (for example, WOTextField). Bind these attributes to a variable that can contain the component’s input value. During the takeValuesFromRequest phase, if the element ID of the current generic container matches an element ID of a form value in the request, the form value is pushed into the component using this attribute. The formValue attribute corresponds to WORequest’s formValuesForKey method. In other words, formValues pushes an array of attributes.
invokeAction	action method	in	No	Enables implementation of action elements (for example, WOHyperlink). During the invokeAction phase, if the element ID of the current generic element matches the sender ID of the URL, the method bound to this attribute is evaluated. Just as with any action method, it must return an object that conforms to the WOActionResults interface, such as WOComponent or WOResponse.

WOHiddenField

A WOHiddenField adds hidden text to the HTML page. It corresponds to the HTML element <INPUT TYPE="HIDDEN"...>. Hidden fields are sometimes used to store application state data in the HTML page.

Binding Name	Binding Type	In/Out	Required	Description
value	String	in/out	Yes	Value for the hidden text field.
name	String	in	No	Name that uniquely identifies this element within the form. You may specify a name or let WebObjects automatically assign one at runtime.
disabled	boolean	in	No	If disabled evaluates to true, the element appears in the page but is not active.

WOHyperlink

WOHyperlink generates a hypertext link in an HTML document.

Binding Name	Binding Type	In/Out	Required	Description
action	action method	in	Conditionally	Action method to invoke when this element is activated. The method must return a WOElement.

href	String	in	Conditionally	URL to direct the browser to when the link is clicked.

pageName	String	in	Conditionally	Name of WebObjects page to display when the link is clicked.

directActionName	String	in	Conditionally	The name of the direct action method (minus the "Action" suffix) to invoke when this element is activated. Defaults to “default”.
actionClass	String	in	No	The name of the class in which the method designated in directActionName can be found. Defaults to DirectAction.

fragmentIdentifier	String	in	No	Named location to display in the destination page.
string	String	in	No	Text displayed to the user as the link. If you include any text between the <WEBOBJECT ...> and </WEBOBJECT> tags for this element, the contents of string is appended to that text.
target	String	in	No	Frame in a frameset that will receive the page returned as a result of the user’s click.
disabled	boolean	in	No	If evaluates to true , the content string is displayed, but the hyperlink is not active.
secure	boolean	in	No	Changes the URL prefix from http to https when WebObjects generates URLs for component actions and direct actions for this element. For this attribute to have any effect, you must provide bindings either for the action, directAction, actionClass, or pageName attribute (respecting the valid combinations).
queryDictionary	NSDictionary	in	No	Takes a dictionary that should be appended to the hyperlink’s URL after a question mark character. The dictionary must be correctly encoded and will be merged with any existing query dictionary for a particular session ID.

WOImage

A WOImage displays an image in the HTML. It corresponds to the HTML element <IMG SRC="">

Binding Name	Binding Type	In/Out	Required	Description
filename	String	in	Conditionally	Path to the image relative to the WebServerResources directory.
framework	String	in	No	Framework that contains the image file. This attribute is only necessary if the image file is in a different location from the component. That is, if the component and the image file are both in the application or if the component and the image file are both in the same framework, this attribute isn’t necessary. If the image file is in a framework and the component is in an application, specify the framework’s name here (minus the .framework extension). If the image file should be in the application but the component is in a framework, specify the "app" keyword in place of the framework name.

src	String	in	Conditionally	URL containing the image data. Use this attribute for complete URLs; for relative URLs use filename instead.

value	String	in	Conditionally	Image data in the form of a WOElement object. This data can come from a database, a file, or memory.

data	NSData	in	Conditionally	Specifies an image resource in the form of an NSData; this data can come from a database, a file, or memory. If you specify resource data, you must specify a MIME type.
mimeType	String	in	Conditionally	A string designating a MIME resource type, such as "image/gif", to be put in the content-type header; this type tells the client what to do with data. If you provide data but no MIME type, WebObjects throws an exception.
key	String	in	No	A string that the application uses as a key for caching the data specified in data. If you do not provide a key, the data object must be fetched each time it is needed. For further information, see the reference documentation for the WOResourceManager class, particularly that for the flushDataCache method.

width	int	in	No	The width of the image. If you don’t specify a width, WebObjects loads and analyzes the image resource to determine its dimensions.
height	int	in	No	The height of the image. If you don’t specify a height, WebObjects loads and analyzes the image resource to determine its dimensions.

WOImageButton

WOImageButton is a graphical submit button. Clicking the image generates a request and submits the enclosing form’s values. You often use WOImageButton when you need more than one submit button within a form.

Binding Name	Binding Type	In/Out	Required	Description
action	action method	in	Yes	Action method to invoke when this element is clicked.

filename	String	in	Conditionally	Path to the image relative to the WebServerResources directory.
framework	String	in	No	Framework that contains the image file. This attribute is only necessary if the image file is in a different location from the component. That is, if the component and the image file are both in the application or if the component and the image file are both in the same framework, this attribute isn’t necessary. If the image file is in a framework and the component is in an application, specify the framework’s name here (minus the .framework extension). If the image file should be in the application but the component is in a framework, specify the "app" keyword in place of the framework name.

src	String	in	Conditionally	URL containing the image data. Use this attribute for complete URLs; for relative URLs use filename instead.

value	WOElement	in	Conditionally	Image data in the form of a WOElement object. This data can come from a database, a file, or memory.

data	NSData	in	Conditionally	Specifies an image resource in the form of an NSData; this data can come from a database, a file, or memory. If you specify resource data, you must specify a MIME type.
mimeType	String	in	Conditionally	A string designating a MIME resource type, such as "image/gif", to be put in the content-type header; this type tells the client what to do with data. If you provide data but no MIME type, WebObjects throws an exception.
key	String	in	No	A string that the application uses as a key for caching the data specified in data. If you do not provide a key, the data object must be reloaded each time it is needed. For further information, see the reference documentation for the WOResourceManager class, particularly that for the flushDataCache method.

imageMapFile	String	in	No	Name of the image map file. See the WOActiveImage description for more information.
name	String	in	No	Name that uniquely identifies this element within the form. You may specify a name or let WebObjects automatically assign one at runtime.
x	int	out	No	If specified, returns the coordinates of the user’s click within the image.
y	int	out	No	If specified, returns the coordinates of the user’s click within the image.
disabled	boolean	in	No	If disabled evaluates to true , the element generates a static image (<IMG>) instead of an active image.

WOJavaScript

WOJavaScript lets you embed a script written in _javascript_ in a dynamically generated page.

Binding Name	Binding Type	In/Out	Required	Description
scriptFile	String	in	Conditionally	Path to the file containing the script. The path can be statically specified in the declaration file or it can be a java.lang.String, an object that responds to a description message by returning a java.lang.String, or a method that returns a java.lang.String.
scriptString	String	in	Conditionally	String containing the script. Typically, scriptString is n java.lang.String object, an object that responds to a description message by returning ajava.lang.String, or a method that returns an java.lang.String.
scriptSource	String	in	Conditionally	URL specifying the location of the script.
hideInCommit	boolean	in	No	If hideInComment evaluates to true (or YES), the script will be enclosed in an HTML comment (<!-- script //-->). Since scripts can generate errors in some older browsers that weren’t designed to execute them, you may want to enclose your script in an HTML comment. Browsers designed to run these scripts will still be able to execute them despite the surrounding comment tags.

WONestedList

WONestedList recursively displays a hierarchical, ordered (numbered) or unordered (bulleted) list of hyperlinks. This element is useful when you want to display hierarchical lists. When the user clicks one of the objects in the list, it is returned in selection and the action method is invoked.

At any point during iteration of the list, the method specified by the sublist attribute returns the current list’s sublist (if any), level specifies the current nesting level (where the topmost level is zero), index gives index of the current item within that nesting level (item returns the actual item), and isOrdered specifies whether the current sublist should be a numbered list or a bulleted list.

Note: This dynamic element is deprecated. Use the WXNestedList dynamic element in the WebObjects examples.

Binding Name	Binding Type	In/Out	Required	Description

WOParam

WOParam elements are used for passing WOApplet parameters.

Binding Name	Binding Type	In/Out	Required	Description
name	String	in	Yes	Symbolic name associated with this element’s value.

value	String	in	Conditionally	Value of this parameter.

action	action method	in	Conditionally	Method that sets the parameter’s value. Use this attribute instead of value if you want the parameter to be a WebObjects component.

WOPasswordField

A WOPasswordField represents itself as a text field that doesn’t echo the characters that a user enters. It corresponds to the HTML element <INPUT TYPE="PASSWORD"...>.

Binding Name	Binding Type	In/Out	Required	Description
value	String	in/out	Yes	During page generation, value sets the default value of the text field. This value is not displayed to the user. During request handling, value holds the value the user entered into the field, or the default value if the user left the field untouched.
name	String	in	No	This name uniquely identifies this element within the form. You may specify a name or let WebObjects automatically assign one at runtime.
disabled	boolean	in	No	If disabled evaluates to true, the element appears in the page but is not active. That is, value does not contain the user’s input when the page is submitted.

WOPopUpButton

WOPopUpButton, when clicked, displays itself as a selection list that allows the user to select only one item at a time. The related element WOBrowser is similar to WOPopUpButton except that it allows the user to select more than one item at a time.

You should provide the title of an item in displayString rather than in value. If there is no binding for displayString, the string assigned to value is used for the item.

Binding Name	Binding Type	In/Out	Required	Description
list	NSArray<T>	in	Yes	Array of objects from which the WOPopUpButton derives its values.
item	T (type of the array elements)	out	Yes	Identifier for the elements of the list. For example, aCollege could represent an object in a colleges array.
displayString	String	in	Yes	Value to display in the selection list; for example, aCollege.name for each college object in the list.
value	String	in	No	For each OPTION tag within the selection, this is the “value” attribute (that is, <OPTION value="someValue">). You can use this binding to specify additional identifiers of each item in the menu.
selection	T (type of the array elements)	out	No	Object that the user chose from the selection list. For the college example, selection would be a college object.
selectedValue	String	out	No	Value that is used with direct actions to specify which option in the list is selected.
name	String	in	No	Name that uniquely identifies this element within the form. You can specify a name or let WebObjects automatically assign one at runtime.
disabled	boolean	in	No	If disabled evaluates to true, this element appears in the page but is not active. That is, selection does not contain the user’s selection when the page is submitted.
escapeHTML	boolean	in	No	If escapeHTML evaluates to true, the string rendered by displayString is converted so that characters which would be interpreted as HTML control characters become their escaped equivalent (this is the default). Thus, if a your displayString is “a <b>bold</b> idea”, the string passed to the client browser would be “a <B>bold</B> idea”, but it would display in the browser as “a <b>bold</b> idea”. If escapeHTML evaluates to false , WebObjects simply passes your data to the client browser “as is.” In this case, the above example would display in the client browser as “a bold idea”. If you are certain that your strings have no characters in them which might be interpreted as HTML control characters, you get better performance if you set escapeHTML to false.
noSelectionString	String	in	No	Enables the first item to be “empty.” Bind this attribute to a string (such as an empty string) that, if chosen, represents an empty selection. When this item is selected, the selection attribute is set to null.

WOQuickTime

WOQuickTime is a dynamic element that you can use to incorporate QuickTime objects (movie, sound, VR, ...) into your WebObjects applications. The WOQuickTime API is essentially based on the QuickTime plug-ins API.

WOQuickTime supports QuickTime VR with hotspots. If you specify a list of hotspots and the user clicks inside the QuickTime VR object, the method specified by the action attribute is performed and the selection attribute is set to the value of the selected hotspot.

You should use WOQuickTime components outside of an HTML form.

Note: This dynamic element is deprecated. Use the JavaWOSMIL framework and its classes instead.

Binding Name	Binding Type	In/Out	Required	Description

WORadioButton

WORadioButton represents itself as an on-off switch. Radio buttons are normally grouped, since the most important aspect of their behavior is that they allow the user to select no more than one of several choices. If the user selects one button, the previously selected button (if any) becomes deselected.

Since radio buttons normally appear as a group, WORadioButton is commonly found within a WORepetition. Alternatively, you can use the WORadioButtonList element.

Binding Name	Binding Type	In/Out	Required	Description
checked	boolean	in/out	Conditionally	During page generation, if checked evaluates to true, the radio button appears in the selected state. During request handling, checked reflects the state the user left the radio button in: true if checked; false if not.

value	boolean	in	Conditionally	Value of this input element. If not specified, WebObjects provides a default value.
selection	boolean	out	No	If selection and value are equal when the page is generated, the radio button is selected. When the page is submitted, selection is assigned the value of the radio button.

name	String	in	No	Name that identifies the radio button’s group. Only one radio button at a time can be selected within a group.
disabled	boolean	in	No	If disabled evaluates to true , this element appears in the page but is not active. That is, selection does not contain the user’s selection when the page is submitted.

WORadioButtonList

WORadioButtonList displays a list of radio buttons. The user may select one of the objects in the list, and this object is returned as selection.

Note: This dynamic element is deprecated. Use the WXRadioButtonList dynamic element in the WebObjects examples.

Binding Name	Binding Type	In/Out	Required	Description

WORepetition

A WORepetition is a container element that repeats its contents (that is, everything between the <WEBOBJECT...> and </WEBOBJECT...> tags in the template file) a given number of times. You can use a WORepetition to create dynamically generated ordered and unordered lists or banks of check boxes or radio buttons.

Binding Name	Binding Type	In/Out	Required	Description
list	NSArray<T>	in	Conditionally	Array of objects that the WORepetition will iterate through. Ideally, this should be an immutable array. If you must pass a mutable array, your code must not alter the array while the WORepetition is iterating through it.
item	T (type of the array elements)	out	Conditionally	Current item in the list array. (This attribute’s value is updated with each iteration.)

count	int	in	Conditionally	Number of times this element will repeat its contents.

index	int	out	No	Index of the current iteration of the WORepetition. (This attribute’s value is updated with each iteration.

WOResetButton

A WOResetButton element generates a reset button in an HTML page. This element is used within HTML forms.

Binding Name	Binding Type	In/Out	Required	Description
value	String	in	Yes	Title of the button.
disabled	boolean	in	No	If disabled evaluates to true, the element appears in the page but is not active. That is, clicking the button does not actually reset the form.

WOResourceURL

WOResourceURL enables the creation of URLs to return resources, such as images and sounds. You can use this element for a variety of purposes, but it is primarily intended to support _javascript_ within a WebObjects application.

Binding Name	Binding Type	In/Out	Required	Description
filename	String	in	Conditionally	Path to the resource relative to the WebServerResources directory.
framework	String	in	No	Framework that contains the resource file. This attribute is only necessary if the file is in a different location from the component. That is, if the component and the file are both in the application or if the component and the file are both in the same framework, this attribute isn’t necessary. If the resource file is in a framework and the component is in an application, specify the framework’s name here (minus the .framework extension). If the resource file should be in the application but the component is in a framework, specify the "app" keyword in place of the framework name.

data	NSData	in	Conditionally	Specifies any resource in the form of an NSData; this data can come from a database, a file, or memory. If you specify resource data, you must specify a MIME type.
mimeType	String	in	Conditionally	A string designating a MIME resource type, such as "image/gif"; this type tells the client what to do with data. If you provide data but no MIME type, WebObjects throws an exception.
key	String	in	No	A string that functions as a key for caching the data specified in data. If you do not provide a key, the data object must be fetched each time it is needed. For further information, see the reference documentation for the WOResourceManager class, particularly that for the flushDataCache method.

WOString

A WOString represents itself in the HTML page as a dynamically generated string.

Binding Name	Binding Type	In/Out	Required	Description
value	String	in	Yes	Text to display in the HTML page. value is typically assigned an java.lang.String object, an object that responds to a description message by returning an java.lang.String, or a method that returns an java.lang.String. The java.lang.String’s contents are substituted into the HTML in the place occupied by this dynamic element.
formatter	NSFormatter	in	No	An instance of an NSFormatter subclass to be used to format object values for display as strings. This attribute should specify a variable containing (or method returning) a preconfigured formatter object.If a user enters an “unformattable” value, WOString passes the invalid value through, allowing you to send back an error page that shows the invalid value.
escapeHTML	boolean	in	No	If escapeHTML evaluates to true, the string rendered by value is converted so that characters which would be interpreted as HTML control characters become their escaped equivalent (this is the default). Thus, if your value is “a <b>bold</b> idea”, the string passed to the client browser would be “a <B>bold</B> idea”, but it would display in the browser as “a <b>bold</b> idea”. If escapeHTML evaluates to false, WebObjects simply passes your data to the client browser “as is.” In this case, the above example would display in the client browser as “a bold idea”. If you are certain that your strings have no characters in them which might be interpreted as HTML control characters, you get better performance if you set escapeHTML to false.
dateFormat	String	in	No	A format string that specifies how value should be formatted as a date. If a date format is used, value can be assigned an NSTimestamp object (if it is assigned an java.lang.String object, it is stored as the string representation of an NSTimestamp object). If the element’s value can’t be interpreted according to the format you specify, value is set to null. See the NSTimestamp class specification for a description of the date format syntax.
numberFormatString	String	in	No	A format string that specifies how value should be formatted as a number. If the element’s value can’t be interpreted according to the format you specify, value is set to null. See the NSNumberFormatter class specification for a description of the number format syntax.
valueWhenEmpty	String	in	No	A string that is substituted for value when value is the empty string.

WOSubmitButton

A WOSubmitButton element generates a submit button in an HTML page. This element is used within HTML forms.

Binding Name	Binding Type	In/Out	Required	Description
action	action method	in	Conditionally	Action method to invoke when the form is submitted.

directActionName	String	in	Conditionally	The name of the direct action method (minus the "Action" suffix) to invoke when this element is activated. Defaults to “default”.
actionClass	String	in	No	The name of the class in which the method designated in directActionName can be found. Defaults to DirectAction.

value	String	in	No	Title of the button.
disabled	boolean	in	No	If disabled evaluates to true, the element appears in the page but is not active. That is, clicking the button does not actually submit the form.
name	String	in	No	Name that uniquely identifies this element within the form. You may specify a name or let WebObjects automatically assign one at runtime.

WOSwitchComponent

WOSwitchComponent provides a way to determine at runtime which nested component should be displayed. This component is useful when you want to decide how to display information based on the state of the application.

Binding Name	Binding Type	In/Out	Required	Description
WOComponentName	String	in	Yes	Name of the component to display. This attribute can be a string or a method that returns the name of a component. If the component specified in WOComponentName takes attributes, pass these attributes along to WOSwitchComponent following the WOComponentName attribute. Note that this means that all components that can be displayed by this WOSwitchComponent must use the same API.

WOText

WOText generates a multi-line field for text input and display. It corresponds to the HTML element <TEXTAREA>.

Binding Name	Binding Type	In/Out	Required	Description
value	String	in/out	Yes	value contains the text as the user left it.
name	String	in	No	The name that uniquely identifies this element within the form. You may specify a name or let WebObjects automatically assign one at runtime.
disabled	boolean	in	No	If disabled evaluates to true, the text area appears in the page but is not active. That is, value does not contain the user’s input when the page is submitted.

WOTextField

A WOTextField represents itself as a text input field. It corresponds to the HTML element <INPUT TYPE="TEXT"...>.

Binding Name	Binding Type	In/Out	Required	Description
value	String	in/out	Yes	During page generation, value sets the default value displayed in the single-line text field. During request handling, it holds the value the user entered into the field, or the default value if the user left the field untouched.
formatter	NSFormatter	in	No	An instance of a java.text.Format subclass to be used to format object values for display as strings, and format user-entered strings back into object values. This attribute should specify a variable containing (or method returning) a preconfigured formatter object. If a user enters an “unformattable” value, WOTextField passes the invalid value through, allowing you to send back an error page that shows the invalid value.
dateFormat	String	in	No	A format string that specifies how value should be formatted as a date. If a date format is used, value can be assigned an NSTimestamp object (if it is assigned a java.langString object, it will be stored as the string representation of an NSTimestamp object). If the element’s value can’t be interpreted according to the format you specify, it is set to null. See the NSTimestamp class specification for a description of the date format syntax.
numberFormat	String	in	No	A format string that specifies how value should be formatted as a number. If the element’s value can’t be interpreted according to the format you specify, value is set to null. See the NSNumberFormatter class specification for a description of the number format syntax.
name	String	in	No	Name that uniquely identifies this element within the form. You may specify a name or let WebObjects automatically assign one at runtime.
disabled	boolean	in	No	If disabled evaluates to true, the element appears in the page but is not active. That is, value does not contain the user’s input when the page is submitted.

WOVBScript

WOVBScript lets you embed a script written in Visual Basic in a dynamically generated page.

Binding Name	Binding Type	In/Out	Required	Description
scriptFile	String	in	Conditionally	Path to the file containing the script. The path can be statically specified in the declaration file or it can be a java.lang.String, an object that responds to a description message by returning an java.lang.String, or a method that returns an java.lang.String.

scriptString	String	in	Conditionally	String containing the script. Typically, scriptString is an java.lang.String object, an object that responds to a description message by returning an java.lang.String, or a method that returns an java.lang.String.

scriptSource	String	in	Conditionally	URL specifying the location of the script.

hideInComment	boolean	in	No	If hideInComment evaluates to true, the script is enclosed in an HTML comment (<!-- script -->). Since scripts can generate errors in some older browsers that weren’t designed to execute them, you may want to enclose your script in an HTML comment. Browsers designed to run these scripts will still be able to execute them despite the surrounding comment tags.

References:
	>(no subject) (From: vaibhav srivastava <email@hidden>)