|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.turbine.util.template.HtmlPageAttributes
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( $linkTag in $page.Links )
<link rel="$linkTag.Relation" href="$linkTag.Url"
#if($linkTag.Type != "" ) type="$linkTag.Type" #end
#if($linkTag.Media != "") media="$linkTag.Media" #end
#if($linkTag.Title != "") title="$linkTag.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")
Nested Class Summary | |
class |
HtmlPageAttributes.LinkTag
Helper class to hold data about a <link ... |
Constructor Summary | |
HtmlPageAttributes()
Default constructor. |
|
HtmlPageAttributes(RunData data)
Construct a new instance with the given RunData object. |
Method Summary | |
HtmlPageAttributes |
addAttribute(java.lang.String name,
java.lang.String value)
Deprecated. Use addBodyAttribute instead. |
HtmlPageAttributes |
addBodyAttribute(java.lang.String name,
java.lang.String value)
Adds an attribute to the BODY tag. |
HtmlPageAttributes |
addLink(java.lang.String relation,
java.lang.String linkURL)
Adds a generic external reference |
HtmlPageAttributes |
addLink(java.lang.String relation,
java.lang.String linkURL,
java.lang.String title)
Adds a generic external reference |
HtmlPageAttributes |
addLink(java.lang.String relation,
java.lang.String linkURL,
java.lang.String title,
java.lang.String type)
Adds a generic external reference |
HtmlPageAttributes |
addScript(java.lang.String scriptURL)
Adds a script reference |
HtmlPageAttributes |
addStyle(java.lang.String styleText)
Adds a STYLE element to the HEAD of the page with the provided content. |
HtmlPageAttributes |
addStyleSheet(java.lang.String styleSheetURL)
Adds a style sheet reference |
HtmlPageAttributes |
addStyleSheet(java.lang.String styleSheetURL,
java.lang.String media,
java.lang.String title,
java.lang.String type)
Adds a style sheet reference |
java.util.Map |
getBodyAttributes()
Returns the map of body attributes |
java.lang.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). |
java.util.Map |
getHttpEquivs()
Gets the map of http equiv tags |
java.util.List |
getLinks()
Returns a collection of link URLs |
java.util.Map |
getMetaTags()
Gets the map of meta tags |
java.util.List |
getScripts()
Returns a collection of script URLs |
java.util.List |
getStyles()
Returns a collection of styles |
java.util.List |
getStyleSheets()
Deprecated. use getLinks() instead |
java.lang.String |
getTitle()
Get the title in the page. |
void |
init(java.lang.Object data)
Initialise this instance with the given RunData object. |
void |
refresh()
Refresh method - does nothing |
HtmlPageAttributes |
setAlinkColor(java.lang.String color)
Set the active link color for the BODY tag. |
HtmlPageAttributes |
setBackground(java.lang.String url)
Set the background image for the BODY tag. |
HtmlPageAttributes |
setBgColor(java.lang.String color)
Set the background color for the BODY tag. |
HtmlPageAttributes |
setDescription(java.lang.String description)
Add a description META tag to the HEAD of the page. |
HtmlPageAttributes |
setHttpEquiv(java.lang.String httpEquiv,
java.lang.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") |
HtmlPageAttributes |
setKeywords(java.lang.String keywords)
Set a keywords META tag in the HEAD of the page. |
HtmlPageAttributes |
setLinkColor(java.lang.String color)
Set the link color for the BODY tag. |
HtmlPageAttributes |
setScript(java.lang.String scriptURL)
Deprecated. Use addScript instead |
HtmlPageAttributes |
setStyle(java.lang.String styleText)
Deprecated. use addStyle instead |
HtmlPageAttributes |
setStyleSheet(java.lang.String styleSheetURL)
Deprecated. use addStyleSheet instead |
HtmlPageAttributes |
setStyleSheet(java.lang.String styleSheetURL,
java.lang.String media)
Deprecated. use addStyleSheet instead |
HtmlPageAttributes |
setTextColor(java.lang.String color)
Set the text color for the BODY tag. |
HtmlPageAttributes |
setTitle(java.lang.String title)
Set the title in the page. |
HtmlPageAttributes |
setVlinkColor(java.lang.String color)
Set the visited link color for the BODY tag. |
java.lang.String |
toString()
A dummy toString method that returns an empty string. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public HtmlPageAttributes()
public HtmlPageAttributes(RunData data)
data
- a RunData instanceMethod Detail |
public void init(java.lang.Object data)
init
in interface ApplicationTool
data
- Assumed to be a RunData instancepublic void refresh()
refresh
in interface ApplicationTool
public HtmlPageAttributes setTitle(java.lang.String title)
title
- A String with the title.
HtmlPageAttributes
(self).public java.lang.String getTitle()
public HtmlPageAttributes addAttribute(java.lang.String name, java.lang.String value)
name
- A String.value
- A String.
HtmlPageAttributes
(self).public HtmlPageAttributes addBodyAttribute(java.lang.String name, java.lang.String value)
name
- A String.value
- A String.
HtmlPageAttributes
(self).public java.util.Map getBodyAttributes()
public HtmlPageAttributes addScript(java.lang.String scriptURL)
scriptURL
-
HtmlPageAttributes
(self).public HtmlPageAttributes setScript(java.lang.String scriptURL)
scriptURL
-
HtmlPageAttributes
(self).public java.util.List getScripts()
public HtmlPageAttributes addStyleSheet(java.lang.String styleSheetURL)
styleSheetURL
- URL of the style sheet
HtmlPageAttributes
(self).public HtmlPageAttributes addStyleSheet(java.lang.String styleSheetURL, java.lang.String media, java.lang.String title, java.lang.String type)
styleSheetURL
- URL of the style sheetmedia
- name of the mediatitle
- title of the stylesheettype
- content type
HtmlPageAttributes
(self).public HtmlPageAttributes setStyleSheet(java.lang.String styleSheetURL)
styleSheetURL
-
HtmlPageAttributes
(self).public HtmlPageAttributes setStyleSheet(java.lang.String styleSheetURL, java.lang.String media)
styleSheetURL
- media
- name of the media
HtmlPageAttributes
(self).public HtmlPageAttributes addLink(java.lang.String relation, java.lang.String linkURL)
relation
- type of the reference (prev, next, first, last, top, etc.)linkURL
- URL of the reference
HtmlPageAttributes
(self).public HtmlPageAttributes addLink(java.lang.String relation, java.lang.String linkURL, java.lang.String title)
relation
- type of the reference (prev, next, first, last, top, etc.)linkURL
- URL of the referencetitle
- title of the reference
HtmlPageAttributes
(self).public HtmlPageAttributes addLink(java.lang.String relation, java.lang.String linkURL, java.lang.String title, java.lang.String type)
relation
- type of the reference (prev, next, first, last, top, etc.)linkURL
- URL of the referencetitle
- title of the referencetype
- content type
HtmlPageAttributes
(self).public java.util.List getStyleSheets()
public java.util.List getLinks()
public HtmlPageAttributes setStyle(java.lang.String styleText)
styleText
- The contents of the style
tag.
HtmlPageAttributes
(self).public HtmlPageAttributes addStyle(java.lang.String styleText)
styleText
- The contents of the style
tag.
HtmlPageAttributes
(self).public java.util.List getStyles()
public HtmlPageAttributes setKeywords(java.lang.String keywords)
keywords
- A String.
HtmlPageAttributes
(self).public HtmlPageAttributes setHttpEquiv(java.lang.String httpEquiv, java.lang.String content)
setHttpEquiv("refresh", "5; URL=http://localhost/nextpage.html")
setHttpEquiv("Expires", "Tue, 20 Aug 1996 14:25:27 GMT")
httpEquiv
- The value to use for the http-equiv attribute.content
- The text for the content attribute of the meta tag.
HtmlPageAttributes
(self).public HtmlPageAttributes setDescription(java.lang.String description)
description
- A String.
HtmlPageAttributes
(self).public HtmlPageAttributes setBackground(java.lang.String url)
url
- A String.
HtmlPageAttributes
(self).public HtmlPageAttributes setBgColor(java.lang.String color)
color
- A String.
HtmlPageAttributes
(self).public HtmlPageAttributes setTextColor(java.lang.String color)
color
- A String.
HtmlPageAttributes
(self).public HtmlPageAttributes setLinkColor(java.lang.String color)
color
- A String.
HtmlPageAttributes
(self).public HtmlPageAttributes setVlinkColor(java.lang.String color)
color
- A String.
HtmlPageAttributes
(self).public HtmlPageAttributes setAlinkColor(java.lang.String color)
color
- A String.
HtmlPageAttributes
(self).public java.util.Map getHttpEquivs()
public java.util.Map getMetaTags()
public java.lang.String toString()
public java.lang.String getDefaultDoctype()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |