Class Body
- java.lang.Object
-
- org.apache.maven.doxia.site.decoration.Body
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
public class Body extends java.lang.Object implements java.io.Serializable, java.lang.Cloneable
The main content decoration.- Version:
- $Revision$ $Date$
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<LinkItem>
breadcrumbs
Field breadcrumbs.private java.lang.String
footer
If present, the contained text will be used instead of the generated copyright text.private java.lang.String
head
Additional content (like JavaScript) to include in the HEAD block of the generated pages.private java.util.List<LinkItem>
links
Field links.private java.util.List<Menu>
menus
Field menus.
-
Constructor Summary
Constructors Constructor Description Body()
-
Method Summary
All Methods Instance Methods Concrete Methods 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(java.lang.Object other)
Method equals.java.util.List<LinkItem>
getBreadcrumbs()
Method getBreadcrumbs.java.lang.String
getFooter()
Get if present, the contained text will be used instead of the generated copyright text.java.lang.String
getHead()
Get additional content (like JavaScript) to include in the HEAD block of the generated pages.java.util.List<LinkItem>
getLinks()
Method getLinks.java.util.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(java.util.List<LinkItem> breadcrumbs)
Set a list of breadcrumbs to display in the navigation.void
setFooter(java.lang.String footer)
Set if present, the contained text will be used instead of the generated copyright text.void
setHead(java.lang.String head)
Set additional content (like JavaScript) to include in the HEAD block of the generated pages.void
setLinks(java.util.List<LinkItem> links)
Set a list of links to display in the navigation.void
setMenus(java.util.List<Menu> menus)
Set a list of menus to include in the navigation.java.lang.String
toString()
Method toString.
-
-
-
Field Detail
-
head
private java.lang.String head
Additional content (like JavaScript) to include in the HEAD block of the generated pages.
-
links
private java.util.List<LinkItem> links
Field links.
-
breadcrumbs
private java.util.List<LinkItem> breadcrumbs
Field breadcrumbs.
-
menus
private java.util.List<Menu> menus
Field menus.
-
footer
private java.lang.String footer
If present, the contained text will be used instead of the generated copyright text.
-
-
Method Detail
-
addBreadcrumb
public void addBreadcrumb(LinkItem linkItem)
Method addBreadcrumb.- Parameters:
linkItem
-
-
addLink
public void addLink(LinkItem linkItem)
Method addLink.- Parameters:
linkItem
-
-
addMenu
public void addMenu(Menu menu)
Method addMenu.- Parameters:
menu
-
-
clone
public Body clone()
Method clone.- Overrides:
clone
in classjava.lang.Object
- Returns:
- Body
-
equals
public boolean equals(java.lang.Object other)
Method equals.- Overrides:
equals
in classjava.lang.Object
- Parameters:
other
-- Returns:
- boolean
-
getBreadcrumbs
public java.util.List<LinkItem> getBreadcrumbs()
Method getBreadcrumbs.- Returns:
- List
-
getFooter
public java.lang.String getFooter()
Get if present, the contained text will be used instead of the generated copyright text.- Returns:
- String
-
getHead
public java.lang.String getHead()
Get additional content (like JavaScript) to include in the HEAD block of the generated pages.- Returns:
- String
-
getLinks
public java.util.List<LinkItem> getLinks()
Method getLinks.- Returns:
- List
-
getMenus
public java.util.List<Menu> getMenus()
Method getMenus.- Returns:
- List
-
hashCode
public int hashCode()
Method hashCode.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- int
-
removeBreadcrumb
public void removeBreadcrumb(LinkItem linkItem)
Method removeBreadcrumb.- Parameters:
linkItem
-
-
removeLink
public void removeLink(LinkItem linkItem)
Method removeLink.- Parameters:
linkItem
-
-
removeMenu
public void removeMenu(Menu menu)
Method removeMenu.- Parameters:
menu
-
-
setBreadcrumbs
public void setBreadcrumbs(java.util.List<LinkItem> breadcrumbs)
Set a list of breadcrumbs to display in the navigation.- Parameters:
breadcrumbs
-
-
setFooter
public void setFooter(java.lang.String footer)
Set if present, the contained text will be used instead of the generated copyright text.- Parameters:
footer
-
-
setHead
public void setHead(java.lang.String head)
Set additional content (like JavaScript) to include in the HEAD block of the generated pages.- Parameters:
head
-
-
setLinks
public void setLinks(java.util.List<LinkItem> links)
Set a list of links to display in the navigation.- Parameters:
links
-
-
setMenus
public void setMenus(java.util.List<Menu> menus)
Set a list of menus to include in the navigation.- Parameters:
menus
-
-
toString
public java.lang.String toString()
Method toString.- Overrides:
toString
in classjava.lang.Object
- Returns:
- String
-
-