Package org.apache.maven.doxia.site.decoration

Class Body

java.lang.Object

org.apache.maven.doxia.site.decoration.Body

All Implemented Interfaces:

Serializable, Cloneable

public class Body
extends Object
implements Serializable, Cloneable

The main content decoration.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Body()

Method Summary

Modifier and Type	Method	Description
void	addBreadcrumb(LinkItem linkItem)	Method addBreadcrumb.
void	addLink(LinkItem linkItem)	Method addLink.
void	addMenu(Menu menu)	Method addMenu.
Body	clone()	Method clone.
boolean	equals(Object other)	Method equals.
List<LinkItem>	getBreadcrumbs()	Method getBreadcrumbs.
String	getFooter()	Get if present, the contained text will be used instead of the generated copyright text.
String	getHead()	Get additional content (like JavaScript) to include in the HEAD block of the generated pages.
List<LinkItem>	getLinks()	Method getLinks.
List<Menu>	getMenus()	Method getMenus.
int	hashCode()	Method hashCode.
void	removeBreadcrumb(LinkItem linkItem)	Method removeBreadcrumb.
void	removeLink(LinkItem linkItem)	Method removeLink.
void	removeMenu(Menu menu)	Method removeMenu.
void	setBreadcrumbs(List<LinkItem> breadcrumbs)	Set a list of breadcrumbs to display in the navigation.
void	setFooter(String footer)	Set if present, the contained text will be used instead of the generated copyright text.
void	setHead(String head)	Set additional content (like JavaScript) to include in the HEAD block of the generated pages.
void	setLinks(List<LinkItem> links)	Set a list of links to display in the navigation.
void	setMenus(List<Menu> menus)	Set a list of menus to include in the navigation.
String	toString()	Method toString.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Body

public Body()

Method Detail

addBreadcrumb

public void addBreadcrumb(LinkItem linkItem)

Method addBreadcrumb.

Parameters:

linkItem - a linkItem object.

addLink

public void addLink(LinkItem linkItem)

Method addLink.

Parameters:

linkItem - a linkItem object.

addMenu

public void addMenu(Menu menu)

Method addMenu.

Parameters:

menu - a menu object.

clone

public Body clone()

Method clone.

Overrides:

clone in class Object

Returns:

Body

equals

public boolean equals(Object other)

Method equals.

Overrides:

equals in class Object

Parameters:

other - a other object.

Returns:

boolean

getBreadcrumbs

public List<LinkItem> getBreadcrumbs()

Method getBreadcrumbs.

Returns:

List

getFooter

public String getFooter()

Get if present, the contained text will be used instead of the generated copyright text.

Returns:

String

getHead

public String getHead()

Get additional content (like JavaScript) to include in the HEAD block of the generated pages.

Returns:

String

getLinks

public List<LinkItem> getLinks()

Method getLinks.

Returns:

List

getMenus

public List<Menu> getMenus()

Method getMenus.

Returns:

List

hashCode

public int hashCode()

Method hashCode.

Overrides:

hashCode in class Object

Returns:

int

removeBreadcrumb

public void removeBreadcrumb(LinkItem linkItem)

Method removeBreadcrumb.

Parameters:

linkItem - a linkItem object.

removeLink

public void removeLink(LinkItem linkItem)

Method removeLink.

Parameters:

linkItem - a linkItem object.

removeMenu

public void removeMenu(Menu menu)

Method removeMenu.

Parameters:

menu - a menu object.

setBreadcrumbs

public void setBreadcrumbs(List<LinkItem> breadcrumbs)

Set a list of breadcrumbs to display in the navigation.

Parameters:

breadcrumbs - a breadcrumbs object.

setFooter

public void setFooter(String footer)

Set if present, the contained text will be used instead of the generated copyright text.

Parameters:

footer - a footer object.

setHead

public void setHead(String head)

Set additional content (like JavaScript) to include in the HEAD block of the generated pages.

Parameters:

head - a head object.

setLinks

public void setLinks(List<LinkItem> links)

Set a list of links to display in the navigation.

Parameters:

links - a links object.

setMenus

public void setMenus(List<Menu> menus)

Set a list of menus to include in the navigation.

Parameters:

menus - a menus object.

toString

public String toString()

Method toString.

Overrides:

toString in class Object

Returns:

String