You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Error formatting macro: contentbylabel: com.atlassian.confluence.api.service.exceptions.BadRequestException: Could not parse cql : null

You may see frequent reference to a Layout Component, but you won't find it in the component reference. The Layout Component is a component that you create to provide common elements across all of your pages.

In traditional servlet development, you may be familiar with the use of a JSP include to include a banner across the top of your page and a copyright message across the bottom. Tapestry doesn't have a mechanism for such includes – nor does it need one.

Instead, you create a layout component that acts as a template:

Layout.tml
<html xmlns:t="http://tapestry.apache.org/schema/tapestry_5_1_0.xsd">
    <head>
        <title>My Nifty Web Application</title>
    </head>
    <body>
        <div class="nav-top">
            Nifty Web Application
        </div>
    
        <t:body/>

        <div class="nav-bottom">
            (C) 2008 NiftyWebCo, Inc.
        </div>
    </body>
</html>

and then each page in your application can wrap itself in that template.

The magic is in the <t:body/> element in the center; this will be replaced by each page's content, whatever that is.

In a real-world example, the two <div> elements in this example might contain the typical repeating content you'll see across the pages of a web application: banners (and banner ads!), menus, login forms and so forth. Often these components get very complex ... in fact, in many applications the Layout component grows to be more complex than almost any other component.

Remember that if your layout component includes a link to a resource such as an image or a stylesheet, you must use an absolute URL. The same component will be used for pages in many different folders, or with many different activation contexts, so relative URLs won't work.

Layout is a regular component like other, with an ordinary component template. Like all component templates, it will be stored on the classpath (typically under src/main/resources).

Components must always have a Java class. But in this trivial example, the Layout component doesn't need any logic:

Layout.java
@Import(stylesheet="context:css/site.css")
public class Layout
{
}

We use the @Import annotation (in 5.2 or later), as opposed to directly adding the <link> element to the template, for significant performance benefits described elsewhere. (For 5.0 and 5.1, use the deprecated @IncludeStyleSheet annotation instead.)

Using the Layout in a Page

Welcome.tml
<html t:type="layout" xmlns:t="http://tapestry.apache.org/schema/tapestry_5_1_0.xsd">

   <h1>Welcome to the Nifty Web Application!</h1>

   <p>
        Would you like to <t:pagelink page="login">Log In</t:pagelink>?
   </p>
</html>

This is an example of using the Layout component in a page (in this case, Welcome.tml). To keep our Welcome.tml template relatively preview-able, we are using an <html> element and the t:type attribute to specify that it is a component.

The <html> tag will be removed, and replaced with the content from the Layout.tml template (which conveniently starts with an <html> element). The <t:body> in Layout.tml will be replaced with the page specific content here: the <h1> and <p> tags.

Any page in the application that follows this pattern, using the Layout component, will have the same look and feel.

You may find that your application has more than one look and feel: perhaps user registration pages have one look, while administrative pages have another. This can be accomplished by having multiple layout components (using any names you choose) and using those different layout types for different pages.

Nested Layouts

Layouts are really just ordinary components, so they can be nested to any level needed. You can have, for example, a "CommonLayout" component that provides the peripheral elements for all your pages, and then a more specialized "AdminLayout" component that provides the layout only for the administrative pages, and make the AdminLayout component wrap itself in the CommonLayout component. So then the administrative pages would start with <html t:type="adminLayout" ...> and the other pages (and the AdminLayout component itself) would start with <html t:type="commonLayout" ...>.

AdminLayout.tml
<html t:type="commonLayout" xmlns:t="http://tapestry.apache.org/schema/tapestry_5_1_0.xsd">

    <h1>Administrative Functions</h1>

    <t:body/>

</html>
  • No labels