Package org.silverpeas.core.web.util.viewgenerator.html.browsebars

Interface BrowseBar

All Superinterfaces:

SimpleGraphicElement

All Known Implementing Classes:

AbstractBrowseBar, BrowseBarComplete

public interface BrowseBar
extends SimpleGraphicElement

The Browse interface gives us the skeleton for all funtionnalities we need to display typical WA browse bar

Version:

1.0

Author:

neysseri

Method Summary

Modifier and Type	Method	Description
void	addElement(BrowseBarElement element)
void	addElements(List<BrowseBarElement> elements)	add given elements to existing elements
String	getBreadCrumb()
String	print()	Print the browseBar in an html format.
void	setClickable(boolean clickable)
void	setComponentId(String componentId)
void	setComponentJavascriptCallback(String callback)
void	setComponentName(String componentName)	Method declaration
void	setComponentName(String componentName, String link)	Method declaration
void	setDomainName(String domainName)	Method declaration
void	setElements(List<BrowseBarElement> elements)	remove existing elements and add given elements
void	setExtraInformation(String information)	Method declaration
void	setI18N(String url, String language)
void	setI18N(List<String> languages, String language)
void	setI18N(I18NBean bean, String language)
void	setIgnoreComponentLink(boolean ignore)
void	setLook(LookHelper look)
void	setMainSessionController(MainSessionController mainSessionController)
void	setPath(String path)	Method declaration
void	setSpaceId(String spaceId)
void	setSpaceJavascriptCallback(String callback)

Method Detail

setDomainName

void setDomainName(String domainName)

Method declaration

Parameters:

domainName -

setComponentName

void setComponentName(String componentName)

Method declaration

Parameters:

componentName -

setComponentName

void setComponentName(String componentName,
                      String link)

Method declaration

Parameters:

componentName -

link -

setExtraInformation

void setExtraInformation(String information)

Method declaration

Parameters:

information -

setPath

void setPath(String path)

Method declaration

Parameters:

path -

setI18N

void setI18N(I18NBean bean,
             String language)

setI18N

void setI18N(String url,
             String language)

setI18N

void setI18N(List<String> languages,
             String language)

setSpaceId

void setSpaceId(String spaceId)

setComponentId

void setComponentId(String componentId)

setMainSessionController

void setMainSessionController(MainSessionController mainSessionController)

setLook

void setLook(LookHelper look)

print

String print()

Print the browseBar in an html format.

Specified by:

print in interface SimpleGraphicElement

Returns:

The html based line code

addElement

void addElement(BrowseBarElement element)

addElements

void addElements(List<BrowseBarElement> elements)

add given elements to existing elements

Parameters:

elements - to add to breadscrumb

setElements

void setElements(List<BrowseBarElement> elements)

remove existing elements and add given elements

Parameters:

elements - to add to breadscrumb

getBreadCrumb

String getBreadCrumb()

setSpaceJavascriptCallback

void setSpaceJavascriptCallback(String callback)

setComponentJavascriptCallback

void setComponentJavascriptCallback(String callback)

setClickable

void setClickable(boolean clickable)

setIgnoreComponentLink

void setIgnoreComponentLink(boolean ignore)