Introduction

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.

Usage

WOActionURL {action=aMethod | pageName=aString; directActionName=anActionName; actionClass=className; [fragmentIdentifier=anchorFragment;] [queryDictionary=aDict; ?key=value;] [secure=aBoolean;]}

Bindings

action

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

The name of a WebObjects page to display when the URL is accessed.

directActionName

The direct action method to invoke when the URL is accessed (minus the "Action" suffix). Defaults to "default".

actionClass

The name of the class in which the directActionName can be found. Defaults to "DirectAction".

fragmentIdentifier

Named location to display in the destination page (that is, an anchor in the destination page).

queryDictionary

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.

?key

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.

secure

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).

Examples

Java methods

WOD-style

 

Inline bindings (WOOGNL)

 

Related documents

  • No labels