Class PageLink

  extended by org.apache.tapestry5.corelib.base.AbstractLink
      extended by org.apache.tapestry5.corelib.components.PageLink
All Implemented Interfaces:

public class PageLink
extends AbstractLink

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.

Component Parameters
NameDescriptionTypeFlagsDefaultDefault PrefixSince
anchorAn anchor value to append to the generated URL (the hash separator will be added automatically).Stringliteral
contextIf 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.Objectprop
disabledIf true, then then no link element is rendered (and no informal parameters as well). The body is, however, still rendered.booleanfalseprop
pageThe logical name of the page to link to.StringRequired, Not Nullliteral
parametersIf specified, the parameters are added to the link as query parameters in key=value fashion. Values will be coerced to string using value encoder; keys should be Nullprop5.3
Related Components:

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">
                <t:pagelink page="user/view" context="">${user.lastname}</t:pagelink>


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;

    private UserDAO userDAO;

    public User getUser()
        return user;

    void onActivate(long userId)
        user = userDAO.findById(userId);


<html xmlns:t="">
        <h1>View User</h1>

        <t:beandisplay object="user"/>

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.

Constructor Summary
Method Summary
Methods inherited from class org.apache.tapestry5.corelib.base.AbstractLink
addParameters, getClientId, getLink, isDisabled, writeLink
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public PageLink()

Copyright © 2003-2012 The Apache Software Foundation.