Package org.apache.turbine.util.template

Class HtmlPageAttributes

  • All Implemented Interfaces:
    ApplicationTool
    public class HtmlPageAttributes
extends Object
implements ApplicationTool
    Template context tool that can be used to set various attributes of a HTML page. This tool does not automatically make the changes in the HTML page for you. You must use this tool in your layout template to retrieve the attributes.

    The set/add methods are can be used from a screen template, action, screen class, layour template, or anywhere else. The get methods should be used in your layout template(s) to construct the appropriate HTML tags.

    Example usage of this tool to build the HEAD and BODY tags in your layout templates:

    ## Set defaults for all pages using this layout. Anything set here can
    ## be overridden in the screen template.
    $page.setTitle("My default page title");
    $page.setHttpEquiv("Content-Style-Type","text/css")
    $page.addStyleSheet($content.getURI("myStyleSheet.css"))
    $page.addScript($content.getURI("globalJavascriptCode.js"))

    ## build the HTML, HEAD, and BODY tags dynamically
    <html>
    <head>
    #if( $page.Title != "" )
    <title>$page.Title</title>
    #end
    #foreach($metaTag in $page.MetaTags.keySet())
    <meta name="$metaTag" content="$page.MetaTags.get($metaTag)">
    #end
    #foreach($httpEquiv in $page.HttpEquivs.keySet())
    <meta http-equiv="$httpEquiv" content="$page.HttpEquivs.get($httpEquiv)">
    #end
    #foreach( $styleSheet in $page.StyleSheets )
    <link rel="stylesheet" href="$styleSheet.Url"
    #if($styleSheet.Type != "" ) type="$styleSheet.Type" #end
    #if($styleSheet.Media != "") media="$styleSheet.Media" #end
    #if($styleSheet.Title != "") title="$styleSheet.Title" #end
    >
    #end
    #foreach( $script in $page.Scripts )
    <script type="text/javascript" src="$script" language="JavaScript"></script>
    #end
    </head>

    ## Construct the body tag. Iterate through the body attributes to build the opening tag
    <body
    #foreach( $attributeName in $page.BodyAttributes.keySet() )
    $attributeName = "$page.BodyAttributes.get($attributeName)"
    #end
    >

    Example usages of this tool in your screen templates:
    $page.addScript($content.getURI("myJavascript.js")
    $page.setTitle("My page title")
    $page.setHttpEquiv("refresh","5; URL=http://localhost/nextpage.html")

    Version:
    $Id$
    Author:
    Quinton McCombs, Scott Eade

    • Method Detail

      • init

        public void init​(Object data)
        Initialize this instance. (ApplicationTool method)
        Specified by:
        init in interface ApplicationTool
        Parameters:
        data - not used

      • setTitle

        public HtmlPageAttributes setTitle​(String title)
        Set the title in the page. This returns an empty String so that the template doesn't complain about getting a null return value. Subsequent calls to this method will replace the current title.
        Parameters:
        title - A String with the title.
        Returns:
        a HtmlPageAttributes (self).

      • getTitle

        public String getTitle()
        Get the title in the page. This returns an empty String if empty so that the template doesn't complain about getting a null return value.
        Returns:
        A String with the title.

      • addScript

        public HtmlPageAttributes addScript​(String scriptURL)
        Adds a script reference
        Parameters:
        scriptURL - the url
        Returns:
        a HtmlPageAttributes (self).

      • getScripts

        public List<String> getScripts()
        Returns a collection of script URLs
        Returns:
        list of String objects containing URLs of javascript files to include

      • addStyleSheet

        public HtmlPageAttributes addStyleSheet​(String styleSheetURL)
        Adds a style sheet reference
        Parameters:
        styleSheetURL - URL of the style sheet
        Returns:
        a HtmlPageAttributes (self).

      • addStyleSheet

        public HtmlPageAttributes addStyleSheet​(String styleSheetURL,
                                        String media,
                                        String title,
                                        String type)
        Adds a style sheet reference
        Parameters:
        styleSheetURL - URL of the style sheet
        media - name of the media
        title - title of the stylesheet
        type - content type
        Returns:
        a HtmlPageAttributes (self).

      • addLink

        public HtmlPageAttributes addLink​(String relation,
                                  String linkURL)
        Adds a generic external reference
        Parameters:
        relation - type of the reference (prev, next, first, last, top, etc.)
        linkURL - URL of the reference
        Returns:
        a HtmlPageAttributes (self).

      • addLink

        public HtmlPageAttributes addLink​(String relation,
                                  String linkURL,
                                  String title)
        Adds a generic external reference
        Parameters:
        relation - type of the reference (prev, next, first, last, top, etc.)
        linkURL - URL of the reference
        title - title of the reference
        Returns:
        a HtmlPageAttributes (self).

      • addLink

        public HtmlPageAttributes addLink​(String relation,
                                  String linkURL,
                                  String title,
                                  String type)
        Adds a generic external reference
        Parameters:
        relation - type of the reference (prev, next, first, last, top, etc.)
        linkURL - URL of the reference
        title - title of the reference
        type - content type
        Returns:
        a HtmlPageAttributes (self).

      • addStyle

        public HtmlPageAttributes addStyle​(String styleText)
        Adds a STYLE element to the HEAD of the page with the provided content.
        Parameters:
        styleText - The contents of the style tag.
        Returns:
        a HtmlPageAttributes (self).

      • getStyles

        public List<String> getStyles()
        Returns a collection of styles
        Returns:
        list of String objects containing the contents of style tags

      • setKeywords

        public HtmlPageAttributes setKeywords​(String keywords)
        Set a keywords META tag in the HEAD of the page.
        Parameters:
        keywords - A String.
        Returns:
        a HtmlPageAttributes (self).

      • setHttpEquiv

        public HtmlPageAttributes setHttpEquiv​(String httpEquiv,
                                       String content)
        Sets a HttpEquiv META tag in the HEAD of the page, usage:
        setHttpEquiv("refresh", "5; URL=http://localhost/nextpage.html")
        setHttpEquiv("Expires", "Tue, 20 Aug 1996 14:25:27 GMT")
        Parameters:
        httpEquiv - The value to use for the http-equiv attribute.
        content - The text for the content attribute of the meta tag.
        Returns:
        a HtmlPageAttributes (self).

      • setDescription

        public HtmlPageAttributes setDescription​(String description)
        Add a description META tag to the HEAD of the page.
        Parameters:
        description - A String.
        Returns:
        a HtmlPageAttributes (self).

      • setBgColor

        public HtmlPageAttributes setBgColor​(String color)
        Set the background color for the BODY tag. You can use either color names or color values (e.g. "white" or "#ffffff" or "ffffff").
        Parameters:
        color - A String.
        Returns:
        a HtmlPageAttributes (self).

      • setTextColor

        public HtmlPageAttributes setTextColor​(String color)
        Set the text color for the BODY tag. You can use either color names or color values (e.g. "white" or "#ffffff" or "ffffff").
        Parameters:
        color - A String.
        Returns:
        a HtmlPageAttributes (self).

      • setLinkColor

        public HtmlPageAttributes setLinkColor​(String color)
        Set the link color for the BODY tag. You can use either color names or color values (e.g. "white" or "#ffffff" or "ffffff").
        Parameters:
        color - A String.
        Returns:
        a HtmlPageAttributes (self).

      • setVlinkColor

        public HtmlPageAttributes setVlinkColor​(String color)
        Set the visited link color for the BODY tag.
        Parameters:
        color - A String.
        Returns:
        a HtmlPageAttributes (self).

      • setAlinkColor

        public HtmlPageAttributes setAlinkColor​(String color)
        Set the active link color for the BODY tag.
        Parameters:
        color - A String.
        Returns:
        a HtmlPageAttributes (self).

      • getHttpEquivs

        public Map<String,​String> getHttpEquivs()
        Gets the map of http equiv tags
        Returns:
        Map of http equiv names to the contents

      • getMetaTags

        public Map<String,​String> getMetaTags()
        Gets the map of meta tags
        Returns:
        Map of http equiv names to the contents

      • toString

        public String toString()
        A dummy toString method that returns an empty string.
        Overrides:
        toString in class Object
        Returns:
        An empty String ("").

      • getDefaultDoctype

        public String getDefaultDoctype()
        Retrieve the default Doctype as configured by the TurbineResources.peoperties default.doctype.root.element, default.doctype.identifier and default.doctype.url properties (defaults are "HTML", "-//W3C//DTD HTML 4.01 Transitional//EN" and "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd" respectively).
        Returns:
        the DOCTYPE tag constructed from the properties in TurbineResources.properties.

      • getDoctype

        public String getDoctype​(String tag,
                         String identifier,
                         String uri)
        Build the doctype element.
        Parameters:
        tag - the tag whose DTD is being declared.
        identifier - the identifier for the doctype declaration.
        uri - the uri for the doctype declaration.
        Returns:
        the doctype.