com.bowstreet.builders.webapp.api
Class Breadcrumbs2

java.lang.Object
  com.bowstreet.builders.BaseBuilderAPI
      com.bowstreet.builders.webapp.api.Breadcrumbs2

public class Breadcrumbs2
extends com.bowstreet.builders.BaseBuilderAPI

Adds breadcrumbs navigation to illustrate a drilldown and provide backward navigation. The breadcrumbs consist of links to each of the elements the end-user visits in the end-user's navigation path.
Note: this is a builder API wrapper class, intended to be called by the regen logic of a builder. It can be used to programmatically add a call to the Breadcrumbs2 builder to a model.

Nested Class Summary

static interface

Breadcrumbs2.BuilderStaticValues Constant values imported from the builder definition file.

Constructor Summary

Breadcrumbs2(BuilderCall parent, GenContext gc)

Method Summary

boolean	getAutomaticReferences() Manually specify which pages will participate in the Breadcrumbs.
java.lang.String	getBaseHTMLPage() Select the Base HTML Page file used to generate the breadcrumbs
java.lang.String	getBreadcrumbsPrefixText() Text before Breadcrumbs
java.lang.String	getBreadcrumbsSeparator() Breadcrumbs separator
java.lang.String	getBreadcrumbsStylesheet() Sets the Stylesheet for Breadcrumbs
java.lang.String	getDataProvider() Java class which specifies a Data Provider.
java.lang.String	getGetTextMethod() Choose a method that the Breadcrumbs tool will call to get the display text for an Item.
java.lang.Object	getLocationForBreadcrumbs() Page Location for the breadcrumbs
java.lang.String	getName() Specify name of this builder call (required and must contain only alphanumeric characters and underscores)
IXml	getPagesParticipating() PagesParticipating
java.lang.String	getPreparePageMethod() Choose a method that the Breadcrumbs tool will call to prepare for a new Item.
java.lang.String	getSeparatorStyleClass() Style class for Separator Text
java.lang.String	getStyleClass() Style class for Text/Links
java.lang.String	getTagOnPages() Choose the tag for breadcrumbs.
java.lang.String	getTitleTextStyleClass() Style class for Title Text
boolean	getUseEmptyConstructor() Check if your DataProvider class should be constructed with an empty constructor.
void	initializeBuilderInputs()
void	setAutomaticReferences(boolean value) Manually specify which pages will participate in the Breadcrumbs.
void	setBaseHTMLPage(java.lang.String value) Select the Base HTML Page file used to generate the breadcrumbs
void	setBreadcrumbsPrefixText(java.lang.String value) Text before Breadcrumbs
void	setBreadcrumbsSeparator(java.lang.String value) Breadcrumbs separator
void	setBreadcrumbsStylesheet(java.lang.String value) Sets the Stylesheet for Breadcrumbs
void	setDataProvider(java.lang.String value) Java class which specifies a Data Provider.
void	setGetTextMethod(java.lang.String value) Choose a method that the Breadcrumbs tool will call to get the display text for an Item.
void	setLocationForBreadcrumbs(java.lang.Object value) Page Location for the breadcrumbs
void	setName(java.lang.String value) Specify name of this builder call (required and must contain only alphanumeric characters and underscores)
void	setPagesParticipating(IXml value) PagesParticipating
void	setPreparePageMethod(java.lang.String value) Choose a method that the Breadcrumbs tool will call to prepare for a new Item.
void	setSeparatorStyleClass(java.lang.String value) Style class for Separator Text
void	setStyleClass(java.lang.String value) Style class for Text/Links
void	setTagOnPages(java.lang.String value) Choose the tag for breadcrumbs.
void	setTitleTextStyleClass(java.lang.String value) Style class for Title Text
void	setUseEmptyConstructor(boolean value) Check if your DataProvider class should be constructed with an empty constructor.

Methods inherited from class com.bowstreet.builders.BaseBuilderAPI

getBuilderCall, getBuilderInputs, invokeBuilder, invokeBuilderBC, setBuilderInputs

Methods inherited from class java.lang.Object

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

Constructor Detail

Breadcrumbs2

public Breadcrumbs2(BuilderCall parent,
                    GenContext gc)

Method Detail

getAutomaticReferences

public boolean getAutomaticReferences()

Manually specify which pages will participate in the Breadcrumbs.

getBaseHTMLPage

public java.lang.String getBaseHTMLPage()

Select the Base HTML Page file used to generate the breadcrumbs

getBreadcrumbsPrefixText

public java.lang.String getBreadcrumbsPrefixText()

Text before Breadcrumbs

getBreadcrumbsSeparator

public java.lang.String getBreadcrumbsSeparator()

Breadcrumbs separator

getBreadcrumbsStylesheet

public java.lang.String getBreadcrumbsStylesheet()

Sets the Stylesheet for Breadcrumbs

getDataProvider

public java.lang.String getDataProvider()

Java class which specifies a Data Provider. This class MUST implement the interface com.bowstreet.builders.webapp.methods.BreadcrumbsDataProvider.

getGetTextMethod

public java.lang.String getGetTextMethod()

Choose a method that the Breadcrumbs tool will call to get the display text for an Item.

getLocationForBreadcrumbs

public java.lang.Object getLocationForBreadcrumbs()

Page Location for the breadcrumbs

getName

public java.lang.String getName()

Specify name of this builder call (required and must contain only alphanumeric characters and underscores)

getPagesParticipating

public IXml getPagesParticipating()

PagesParticipating

getPreparePageMethod

public java.lang.String getPreparePageMethod()

Choose a method that the Breadcrumbs tool will call to prepare for a new Item.

getSeparatorStyleClass

public java.lang.String getSeparatorStyleClass()

Style class for Separator Text

getStyleClass

public java.lang.String getStyleClass()

Style class for Text/Links

getTagOnPages

public java.lang.String getTagOnPages()

Choose the tag for breadcrumbs. Put this tag on any page that you want to show the current breadcrumbs state.

getTitleTextStyleClass

public java.lang.String getTitleTextStyleClass()

Style class for Title Text

getUseEmptyConstructor

public boolean getUseEmptyConstructor()

Check if your DataProvider class should be constructed with an empty constructor. Otherwise it will be passed two Strings, the PreparePage method name and the GetText method name.

initializeBuilderInputs

public void initializeBuilderInputs()

Overrides:

initializeBuilderInputs in class com.bowstreet.builders.BaseBuilderAPI

setAutomaticReferences

public void setAutomaticReferences(boolean value)

Manually specify which pages will participate in the Breadcrumbs.

setBaseHTMLPage

public void setBaseHTMLPage(java.lang.String value)

Select the Base HTML Page file used to generate the breadcrumbs

setBreadcrumbsPrefixText

public void setBreadcrumbsPrefixText(java.lang.String value)

Text before Breadcrumbs

setBreadcrumbsSeparator

public void setBreadcrumbsSeparator(java.lang.String value)

Breadcrumbs separator

setBreadcrumbsStylesheet

public void setBreadcrumbsStylesheet(java.lang.String value)

Sets the Stylesheet for Breadcrumbs

setDataProvider

public void setDataProvider(java.lang.String value)

Java class which specifies a Data Provider. This class MUST implement the interface com.bowstreet.builders.webapp.methods.BreadcrumbsDataProvider.

setGetTextMethod

public void setGetTextMethod(java.lang.String value)

Choose a method that the Breadcrumbs tool will call to get the display text for an Item.

setLocationForBreadcrumbs

public void setLocationForBreadcrumbs(java.lang.Object value)

Page Location for the breadcrumbs

setName

public void setName(java.lang.String value)

Specify name of this builder call (required and must contain only alphanumeric characters and underscores)

setPagesParticipating

public void setPagesParticipating(IXml value)

PagesParticipating

setPreparePageMethod

public void setPreparePageMethod(java.lang.String value)

Choose a method that the Breadcrumbs tool will call to prepare for a new Item.

setSeparatorStyleClass

public void setSeparatorStyleClass(java.lang.String value)

Style class for Separator Text

setStyleClass

public void setStyleClass(java.lang.String value)

Style class for Text/Links

setTagOnPages

public void setTagOnPages(java.lang.String value)

Choose the tag for breadcrumbs. Put this tag on any page that you want to show the current breadcrumbs state.

setTitleTextStyleClass

public void setTitleTextStyleClass(java.lang.String value)

Style class for Title Text

setUseEmptyConstructor

public void setUseEmptyConstructor(boolean value)

Check if your DataProvider class should be constructed with an empty constructor. Otherwise it will be passed two Strings, the PreparePage method name and the GetText method name.