|
|
|
| |
Description
Creates a <a> hyperlink that notifies the component when the link is
triggered. The link includes some context-specific data that is made available
to the component's listener. This is used in cases where the
ActionLink component can't be used (or is too inefficient).
See the Developers Guide
ActionLink and DirectLink listeners for a more complete description.
Prior to release 2.2, this component was named
Direct.
|
See Also
ActionLink,
GenericLink,
PageLink,
ServiceLink
|
Parameters
| Name |
Type |
Direction |
Required |
Default |
Description |
| listener |
IActionListener
|
in |
yes |
|
Specifies an object that is notified when the link is clicked,
which is typically a listener method of its container
(for example, listeners.method). |
| parameters |
Object or
Object[] or
List
|
in |
no |
|
An array of objects to be encoded into the URL. These parameters will be
decoded when the link is triggered.
In a web application built onto of Enterprise JavaBeans, the context is
often the primary key of some Entity bean; typically such keys are Strings
or Integers.
A listener method can retrieve the parameters using
IRequestCycle.getServiceParameters().
Prior to release 2.2, the parameters were always type String. They may now
be of any type; type will be maintained when the parameters are later
retrieved by a listener. See
DataSqueezer for more details.
|
| disabled |
boolean |
in |
no |
false |
Controls whether the link is produced. If disabled, the portion of the
template the link surrounds is still rendered, but not the link itself.
|
| stateful |
boolean |
in |
no |
true |
If true (the default), then the component requires an active (i.e., non-new)
HttpSession when triggered. Failing that, it throws a
StaleLinkException.
If false, then no check is necessary. The
latter works well with links that encode all necessary state inside the URL
itself.
|
| scheme |
String |
in |
no |
|
If specified, then a longer URL (including scheme, server and possibly port)
is generated using the specified scheme. Server is determined fromt he
incoming request, and port is deterimined from the port paramter or the
incoming request.
|
| port |
int |
in |
no |
|
If specified, then a longer URL (including scheme, server and port) is
generated using the specified port. The server is determined from the
incoming request, the scheme from the scheme parameter or the incoming
request.
|
| anchor |
String |
in |
no |
|
The name of an anchor or element to link to. The final URL will have '#'
and the anchor appended to it.
|
Body: rendered
Informal parameters:
allowed
Reserved parameters:
"href"
|
|
Examples
This example is under construction.
|
|
