|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.confluence.util.breadcrumbs.AbstractBreadcrumb
public abstract class AbstractBreadcrumb
Field Summary | |
---|---|
protected java.lang.String |
cssClass
|
protected java.lang.String |
displayTitle
|
protected boolean |
filterTrailingBreadcrumb
|
protected java.lang.String |
target
|
protected java.lang.String |
title
|
protected java.lang.String |
tooltip
|
Constructor Summary | |
---|---|
protected |
AbstractBreadcrumb()
|
protected |
AbstractBreadcrumb(java.lang.String title,
java.lang.String target)
|
protected |
AbstractBreadcrumb(java.lang.String title,
java.lang.String target,
java.lang.String tooltip)
|
Method Summary | |
---|---|
boolean |
filterTrailingBreadcrumb()
Whether or not the last breadcrumb in the breadcrumbs trail should be filtered out. |
java.util.List<Breadcrumb> |
getBreadcrumbsTrail()
Gets all the breadcrumbs required for displaying this breadcrumb. |
java.lang.String |
getCssClass()
CSS class to apply to the breadcrumb |
java.lang.String |
getDisplayTitle()
Gets the display title of the breadcrumb for user display. |
protected java.util.List<Breadcrumb> |
getMyCrumbs()
Returns a list of breadcrumbs for the current breadcrumb. |
protected abstract Breadcrumb |
getParent()
Gets the parent breadcrumb. |
java.lang.String |
getTarget()
Gets the relative url for the target which a breadcrumb points to. |
java.lang.String |
getTitle()
Gets the i18n key for the title of the breadcrumb. |
java.lang.String |
getTooltip()
Gets the breadcrumb's tooltip. |
void |
setCssClass(java.lang.String cssClass)
Override the default CSS class of the breadcrumb |
void |
setFilterTrailingBreadcrumb(boolean filterTrailingBreadcrumb)
Override the breadcrumb's default value for whether or not the last breadcrumb in the trail should be filtered out. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.lang.String title
protected java.lang.String target
protected java.lang.String tooltip
protected java.lang.String displayTitle
protected java.lang.String cssClass
protected boolean filterTrailingBreadcrumb
Constructor Detail |
---|
protected AbstractBreadcrumb()
protected AbstractBreadcrumb(java.lang.String title, java.lang.String target)
protected AbstractBreadcrumb(java.lang.String title, java.lang.String target, java.lang.String tooltip)
Method Detail |
---|
public java.lang.String getTarget()
Breadcrumb
getTarget
in interface Breadcrumb
public java.lang.String getTitle()
Breadcrumb
Breadcrumb.getDisplayTitle()
for
titles that don't need to be translated.
getTitle
in interface Breadcrumb
public java.lang.String getTooltip()
Breadcrumb
getTooltip
in interface Breadcrumb
public java.lang.String getDisplayTitle()
Breadcrumb
getDisplayTitle
in interface Breadcrumb
public java.util.List<Breadcrumb> getBreadcrumbsTrail()
getMyCrumbs()
).
getBreadcrumbsTrail
in interface Breadcrumb
List
of breadcrumbs for displayprotected java.util.List<Breadcrumb> getMyCrumbs()
BlogPostBreadcrumb
overrides this method and returns 4 crumbs altogether to represent itself: 2007 > 11 > 28 > BlogTitle.
By default my crumbs will be a list with size 1, containing itself, unless the current breadcrumb
has no title.
protected abstract Breadcrumb getParent()
public void setCssClass(java.lang.String cssClass)
Breadcrumb
setCssClass
in interface Breadcrumb
cssClass
- the default string to write in the class attributepublic java.lang.String getCssClass()
Breadcrumb
getCssClass
in interface Breadcrumb
public java.lang.String toString()
toString
in class java.lang.Object
public void setFilterTrailingBreadcrumb(boolean filterTrailingBreadcrumb)
Breadcrumb
setFilterTrailingBreadcrumb
in interface Breadcrumb
filterTrailingBreadcrumb
- true if the last breadcrumb in the trail should be filtered out.public boolean filterTrailingBreadcrumb()
Breadcrumb
filterTrailingBreadcrumb
in interface Breadcrumb
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |