Class Body
java.lang.Object
org.apache.maven.doxia.site.decoration.Body
- All Implemented Interfaces:
Serializable, Cloneable
The main content decoration.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate ListField breadcrumbs.private StringIf present, the contained text will be used instead of the generated copyright text.private StringAdditional content (like JavaScript) to include in the HEAD block of the generated pages.private ListField links.private ListField menus. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddBreadcrumb(LinkItem linkItem) Method addBreadcrumb.voidMethod addLink.voidMethod addMenu.clone()Method clone.booleanMethod equals.Method getBreadcrumbs.Get if present, the contained text will be used instead of the generated copyright text.getHead()Get additional content (like JavaScript) to include in the HEAD block of the generated pages.getLinks()Method getLinks.getMenus()Method getMenus.inthashCode()Method hashCode.voidremoveBreadcrumb(LinkItem linkItem) Method removeBreadcrumb.voidremoveLink(LinkItem linkItem) Method removeLink.voidremoveMenu(Menu menu) Method removeMenu.voidsetBreadcrumbs(List breadcrumbs) Set a list of breadcrumbs to display in the navigation.voidSet if present, the contained text will be used instead of the generated copyright text.voidSet additional content (like JavaScript) to include in the HEAD block of the generated pages.voidSet a list of links to display in the navigation.voidSet a list of menus to include in the navigation.toString()Method toString.
-
Field Details
-
head
Additional content (like JavaScript) to include in the HEAD block of the generated pages. -
links
Field links. -
breadcrumbs
Field breadcrumbs.
-
-
Constructor Details
-
Body
public Body()
-
-
Method Details
-
addBreadcrumb
Method addBreadcrumb.- Parameters:
linkItem- a linkItem object.
-
addLink
-
addMenu
-
clone
-
equals
-
getBreadcrumbs
-
getHead
Get additional content (like JavaScript) to include in the HEAD block of the generated pages.- Returns:
- String
-
getLinks
-
getMenus
-
hashCode
-
removeBreadcrumb
Method removeBreadcrumb.- Parameters:
linkItem- a linkItem object.
-
removeLink
Method removeLink.- Parameters:
linkItem- a linkItem object.
-
removeMenu
-
setBreadcrumbs
Set a list of breadcrumbs to display in the navigation.- Parameters:
breadcrumbs- a breadcrumbs object.
-
setHead
Set additional content (like JavaScript) to include in the HEAD block of the generated pages.- Parameters:
head- a head object.
-
setLinks
Set a list of links to display in the navigation.- Parameters:
links- a links object.
-
setMenus
Set a list of menus to include in the navigation.- Parameters:
menus- a menus object.
-
toString
-