Module com.aoindustries.web.struts

Package com.aoindustries.web.struts.skintags

Class PageAttributes

java.lang.Object

com.aoindustries.web.struts.skintags.PageAttributes

public class PageAttributes
extends Object

During the processing of the skin, page attributes are built and stored here, one instance per request.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PageAttributes.Link

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LAYOUT_MINIMAL	The possible values for layout.
static final String	LAYOUT_NORMAL	The possible values for layout.
static final ScopeEE.Request.Attribute<PageAttributes>	REQUEST_ATTRIBUTE	The following key is used to store the objects in the page attributes.

Constructor Summary

Constructors

Constructor	Description
PageAttributes()

Method Summary

Modifier and Type	Method	Description
void	addChild(Child child)
void	addLink(String rel, String href, String type)	Adds an additional link to include for this page in the order they should be added.
void	addMeta(Meta meta)
void	addParent(Parent parent)
String	getAuthor()
String	getAuthorHref()
List<Child>	getChildren()	Gets the direct children of this page.
String	getCopyright()
String	getDescription()
Formtype	getFormtype()
String	getKeywords()
String	getLayout()
List<PageAttributes.Link>	getLinks()	Gets an optional set of additional links to include for this page in the order they should be added.
List<Meta>	getMetas()
String	getNavImageAlt()
String	getOnload()
List<Parent>	getParents()
String	getPath()
String	getTitle()
void	setAuthor(String author)
void	setAuthorHref(String authorHref)
void	setCopyright(String copyright)
void	setDescription(String description)
void	setFormtype(Formtype formtype)
void	setKeywords(String keywords)
void	setLayout(String layout)
void	setNavImageAlt(String navImageAlt)
void	setOnload(String onload)
void	setPath(String path)
void	setTitle(String title)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LAYOUT_NORMAL

public static final String LAYOUT_NORMAL

The possible values for layout.

See Also:

• Constant Field Values

LAYOUT_MINIMAL

public static final String LAYOUT_MINIMAL

The possible values for layout.

See Also:

• Constant Field Values

REQUEST_ATTRIBUTE

public static final ScopeEE.Request.Attribute<PageAttributes> REQUEST_ATTRIBUTE

The following key is used to store the objects in the page attributes.

Constructor Details

PageAttributes

public PageAttributes()

Method Details

getPath

public String getPath()

setPath

public void setPath(String path)

getKeywords

public String getKeywords()

setKeywords

public void setKeywords(String keywords)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getAuthor

public String getAuthor()

setAuthor

public void setAuthor(String author)

getAuthorHref

public String getAuthorHref()

setAuthorHref

public void setAuthorHref(String authorHref)

getCopyright

public String getCopyright()

setCopyright

public void setCopyright(String copyright)

getMetas

public List<Meta> getMetas()

addMeta

public void addMeta(Meta meta)

getLinks

public List<PageAttributes.Link> getLinks()

Gets an optional set of additional links to include for this page in the order they should be added.

Please note, that any links to stylesheets here are never optimized. Please prefer the page-scope web resource registry.

addLink

public void addLink(String rel,
 String href,
 String type)

Adds an additional link to include for this page in the order they should be added.

Please note, that any links to stylesheets here are never optimized. Please prefer the page-scope web resource registry.

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getNavImageAlt

public String getNavImageAlt()

setNavImageAlt

public void setNavImageAlt(String navImageAlt)

getParents

public List<Parent> getParents()

addParent

public void addParent(Parent parent)

getChildren

public List<Child> getChildren()

Gets the direct children of this page.

addChild

public void addChild(Child child)

getLayout

public String getLayout()

setLayout

public void setLayout(String layout)

getFormtype

public Formtype getFormtype()

setFormtype

public void setFormtype(Formtype formtype)

Parameters:

formtype - Includes appropriate content in the head based on the type of form.

getOnload

public String getOnload()

setOnload

public void setOnload(String onload)