info.magnolia.cms.taglibs.util
Class Breadcrumb

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      info.magnolia.cms.taglibs.util.Breadcrumb

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class Breadcrumb
extends javax.servlet.jsp.tagext.TagSupport

Outputs "breadcrumbs" with links to parents of the current page.

Version:

$Revision $ ($Author $)

Author:

Marcel Salathe, Fabrizio Giustina

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Breadcrumb()

Method Summary

int	doStartTag()
void	release()
void	setActiveCss(String activeCss) Css class added to the current page link.
void	setDelimiter(String delimiter) displayed between the page names, e.g.
void	setExcludeCurrent(boolean excludeCurrent) Exclude the current (active) page from the breadcrumb.
void	setHideProperty(String hideProperty) Name for a page property which, if set, will make the page hidden in the breadcrumb.
void	setLink(boolean link) Create links to pages.
void	setNolinkCurrent(boolean nolinkCurrent) Add current page but without links.
void	setStartLevel(String startLevel) At which level to start.
void	setTitleProperty(String titleProperty) Name for a page property which holds the title to display in breadcrumbs.

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

Breadcrumb

public Breadcrumb()

Method Detail

setDelimiter

public void setDelimiter(String delimiter)

displayed between the page names, e.g. ">"

setStartLevel

public void setStartLevel(String startLevel)

At which level to start. Often you will want to omit top levels, e.g. if you split your site into multiple languages.

setHideProperty

public void setHideProperty(String hideProperty)

Name for a page property which, if set, will make the page hidden in the breadcrumb.

setExcludeCurrent

public void setExcludeCurrent(boolean excludeCurrent)

Exclude the current (active) page from the breadcrumb. Defaults to false. If true, the current (active) page is not included in breadcrumb.

setNolinkCurrent

public void setNolinkCurrent(boolean nolinkCurrent)

Add current page but without links. Defaults to false (also current page is linked)

setLink

public void setLink(boolean link)

Create links to pages. Defaults to true.

setTitleProperty

public void setTitleProperty(String titleProperty)

Name for a page property which holds the title to display in breadcrumbs. If empty, the standard title is used.

setActiveCss

public void setActiveCss(String activeCss)

Css class added to the current page link.

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException

release

public void release()

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class javax.servlet.jsp.tagext.TagSupport

See Also:

TagSupport.release()