Apache Struts 2 Documentation > Home > Guides > Plugin Developers Guide > Tiles Plugin |

Apache Struts 2 Documentation
Tiles Plugin
Edit Page Browse Space Add Page Add News
Added by David H. DeWolf, last edited by Ted Husted on Feb 04, 2007 (view change)

The Tiles Plugin is experimental (it depends on the Apache Tiles beta). Feedback is appreciated!

| Tiles is a templating framework designed to easily allow the creation of web application pages with a consistent look and feel. It can be used for both page decorating and componentization.

The Tiles plugin allows actions to return Tiles pages.

## Features

- Supports Tiles in Freemarker, JSP, and Velocity

## Usage

The following steps must be taken in order to enable tiles support within your Struts2 application:

1. Include the struts-tiles-plugin as a dependency in your web application. If you are using maven2, the dependency configuration will be similar to:

       <dependency>
         <groupId>org.apache.struts</groupId>
         <artifactId>struts2-tiles-plugin</artifactId>
         <version>${version.tiles}</version>
         <scope>compile</scope>
       </dependency>

2. Register the tiles listener. This listener will typically either be the standard tiles listener (org.apache.tiles.listener.TilesListener) or the Struts2 replacement (org.apache.struts2.tiles.TilesListener). The latter provides tighter integration with Struts features such as freemarker integration.

       <listener>
         <listener-class>org.apache.struts2.tiles.StrutsTilesListener</listener-class>
       </listener>

3. All package definitions which require tiles support must either extend the tiles-default package or must register the Tiles Result type definition.

       <result-types>
         <result-type name="tiles" class="org.apache.struts2.views.tiles.TilesResult"/>
       </result-types>

4. Configure your actions to utilize a tiles definition:

       <action name="sample" class="org.apache.struts2.tiles.example.SampleAction" >
         <result name="success" type="tiles">tilesWorks</result>
       </action>

## Example

This example shows a Tiles layout page using Struts tags:

    <%@ taglib uri="http://struts.apache.org/tags-tiles" prefix="tiles" %>
    <%@ taglib prefix="s" uri="/struts-tags" %>

    <%-- Show usage; Used in Header --%>
    <tiles:importAttribute name="title" scope="request"/>
    <html>
        <head><title><tiles:getAsString name="title"/></title></head>
    <body>
        <tiles:attribute name="header"/>

        <p id="body">
            <tiles:attribute name="body"/>
        </p>
    </body>
    </html>

## Settings

This plugin does not have any global settings.

## Installation

This plugin can be installed by copying the plugin jar into your application's `/WEB-INF/lib` directory. No other files need to be copied or created.

Children Show Children Hide Children
Tiles Use (Apache Struts 2 Documentation)