| <?xml version="1.0" encoding="UTF-8"?> |
| <!-- |
| Copyright 2004, 2005 The Apache Software Foundation |
| |
| Licensed under the Apache License, Version 2.0 (the "License"); |
| you may not use this file except in compliance with the License. |
| You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <document> |
| <properties> |
| <title>ServiceLink</title> |
| </properties> |
| <body> |
| |
| <section name="ServiceLink"> |
| |
| <p> |
| A component for creating a link for an arbitrary engine service that uses no |
| parameters, such as the reset or home service. A ServiceLink component can emulate |
| an ActionLink, PageLink or DirectLink component, but is most often used in |
| conjunction with an application-specific service. |
| </p> |
| |
| <p> |
| <strong> |
| See also: |
| <a href="directlink.html">DirectLink</a> |
| , |
| <a href="externallink.html">ExternalLink</a> |
| , |
| <a href="genericlink.html">GenericLink</a> |
| , |
| <a href="pagelink.html">PageLink</a> |
| </strong> |
| </p> |
| |
| <section name="Parameters"> |
| <table> |
| <tr> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th>Description</th> |
| </tr> |
| |
| <tr> |
| <td>service</td> |
| <td>String</td> |
| <td>yes</td> |
| <td></td> |
| <td> |
| The name of the |
| <a |
| href="../../apidocs/org/apache/tapestry/engine/IEngineService.html"> |
| IEngineService |
| </a> |
| to invoke. Can be any service, esp random ones contributed by you. |
| </td> |
| </tr> |
| <tr> |
| <td>parameters</td> |
| <td> |
| Object or |
| <br /> |
| Object[] or |
| <br /> |
| List |
| </td> |
| <td>no</td> |
| <td></td> |
| <td> |
| An array of Objects to be encoded into the URL. These parameters will be |
| decoded when the link is triggered. |
| </td> |
| </tr> |
| <tr> |
| <td>disabled</td> |
| <td>boolean</td> |
| <td>no</td> |
| <td>false</td> |
| <td> |
| <p> |
| Controls whether the link is produced. If disabled, the portion of |
| the template the link surrounds is still rendered, but not the link |
| itself. |
| </p> |
| <p> |
| Using the namespace scheme, to create a link to a page in a library, |
| you must provide the libraries namespace prefix. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td>target</td> |
| |
| <td>String</td> |
| <td>no</td> |
| <td /> |
| <td> |
| The name of the html target for this link, this is just the normal html attribute that will |
| control where the response generated from this link will go. (Usually used in frames) |
| </td> |
| </tr> |
| <tr> |
| <td>anchor</td> |
| |
| <td>String</td> |
| <td>no</td> |
| <td></td> |
| <td> |
| The name of an anchor or element to link to. The final URL will have '#' |
| and the anchor appended to it. |
| </td> |
| |
| </tr> |
| |
| <tr> |
| <td>scheme</td> |
| <td>String</td> |
| <td>no</td> |
| <td></td> |
| <td> |
| The required scheme ("http" or "https", typically) for the URL. This |
| will force the creation of an absolute URL when the current request's |
| scheme does not match the value for this parameter. This is most often |
| used to switch to "https" for secure portions of an application (such as |
| a login page), before switching back to standard "http" for the majority |
| of an application. |
| </td> |
| </tr> |
| |
| <tr> |
| <td>port</td> |
| <td>Integer</td> |
| <td>no</td> |
| <td></td> |
| <td> |
| The required port (80, 443, 8080. 8443, typically) for the URL. This |
| will force the creation of an absolute URL when the current request's |
| scheme does not match the value for this parameter. This is most often |
| used in conjunction with scheme to switch to "https:443"/"https:8443" |
| for secure portions of an application (such as a login page), before |
| switching back to standard "http:80"/"http:80" for the majority of an |
| application. |
| </td> |
| </tr> |
| |
| <tr> |
| <td>renderer</td> |
| <td> |
| <a |
| href="../../apidocs/org/apache/tapestry/link/ILinkRenderer.html"> |
| ILinkRenderer |
| </a> |
| </td> |
| <td>no</td> |
| <td></td> |
| |
| <td>The object which will actually render the link.</td> |
| </tr> |
| |
| </table> |
| |
| <p> |
| Body: |
| <strong>rendered</strong> |
| </p> |
| |
| <p> |
| Informal parameters: |
| <strong>allowed</strong> |
| </p> |
| |
| <p> |
| Reserved parameters: |
| <em>href</em> |
| </p> |
| |
| </section> |
| |
| <section name="Examples"> |
| |
| <p>This example is under construction.</p> |
| </section> |
| |
| </section> |
| |
| </body> |
| </document> |
