org.apache.tapestry5.corelib.components.PageLink

Generates a render request link to some other page in the application. If an activation context is supplied (as the context parameter), then the context values will be encoded into the URL. If no context is supplied, then the target page itself will supply the context via a passivate event. Pages are not required to have an activation context. When a page does have an activation context, the value typically represents the identity of some object displayed or otherwise manipulated by the page.

[JavaDoc]

Component Inheritance

Component Parameters

NameTypeFlagsDefaultDefault PrefixDescription
anchorStringNOT Allow NullliteralAn anchor value to append to the generated URL (the hash separator will be added automatically).
contextObjectNOT Allow NullpropIf provided, this is the activation context for the target page (the information will be encoded into the URL). If not provided, then the target page will provide its own activation context.
disabledbooleanNOT Allow NullfalsepropIf true, then then no link element is rendered (and no informal parameters as well). The body is, however, still rendered.
pageStringRequired, NOT Allow NullliteralThe logical name of the page to link to.

Related Components

Examples

We're continuing with the example introduced in the Grid examples. The UserList page renders a series of page links, passing the user id as the context:

UserList.html (partial)

        <t:grid source="users" row="user" model="model">
            <p:lastnamecell>
                <t:pagelink page="user/view" context="user.id">${user.lastname}</t:pagelink>
            </p:lastnamecell>

        </t:grid>

ViewUser.java

The ViewUser page is responsible for converting that user id back into a User instance, by providing an event handler method for the "activate" event. 
public class ViewUser
{
    private User _user;

    @Inject
    private UserDAO _userDAO;

    public User getUser()
    {
        return _user;
    }

    void onActivate(long userId)
    {
        _user = _userDAO.findById(userId);
    }
}

ViewUser.tml

<html xmlns:t="http://tapestry.apache.org/schema/tapestry_5_0_0.xsd">
    <body>
        <h1>View User</h1>

        <t:beandisplay object="user"/>
    </body>
</html>
Rendering out the User object, using a BeanDisplay component, is easy, and the template doesn't have to know or care about the page activation context; it just reads the user property.

Back to index