com.sun.rave.web.ui.component
Class BreadcrumbsBase

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UICommand
              com.sun.rave.web.ui.component.BreadcrumbsBase

All Implemented Interfaces:

javax.faces.component.ActionSource, javax.faces.component.StateHolder

Direct Known Subclasses:

Breadcrumbs

public abstract class BreadcrumbsBase

extends javax.faces.component.UICommand

Render a breadcrumb or parentage path.

HTML Elements and Layout

This tag will render a breadcrumb (or parentage path) on a page. A breadcrumb or parentage path is a set of hyperlinks, displayed on a page to show the user's location within an application, and the physical or logical path to a page. The breadcrumbs can be used to navigate to other locations within the application.

Client Side Javascript Functions

none.

Examples

The pages which comprise breadcrumbs can be specified as child components of the breadcrumbs or by using the pages attribute. If the pages attribute is used, the value must an EL expression that identifies an array of com.sun.rave.web.ui.Hyperlink.
Breadcrumbs must be used within a <ui:form> tag.

Example 1:

Using child components:

       <ui:breadcrumbs id="breadcrumbs1">
         <ui:hyperlink url="http://google.com" label="Google"/>
         <ui:hyperlink url="http://yahoo.com" label="Yahoo"/>
         <ui:hyperlink url="http://sun.com" label="Sun"/>
       </ui:breadcrumbs>
 

Example 2:

Using a value binding:

       <ui:breadcrumbs id="breadcrumbs2" pages="#{FieldBean.pagelist}" />
 

Auto-generated component class. Do NOT modify; all changes will be lost!

Field Summary

Fields inherited from class javax.faces.component.UICommand

COMPONENT_FAMILY, COMPONENT_TYPE

Constructor Summary

BreadcrumbsBase()
Construct a new BreadcrumbsBase.

Method Summary

java.lang.String	getFamily() Return the family for this component.
Hyperlink[]	getPages() Value binding expression that points to an array of UIComponents containing the information for the pages in the breadcrumbs.
java.lang.String	getStyle() CSS style(s) to be applied when this component is rendered.
java.lang.String	getStyleClass() CSS style class(es) to be applied when this component is rendered.
int	getTabIndex() The position of this component in the tabbing order sequence
boolean	isVisible() Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.
void	restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state) Restore the state of this component.
java.lang.Object	saveState(javax.faces.context.FacesContext _context) Save the state of this component.
void	setPages(Hyperlink[] pages) Value binding expression that points to an array of UIComponents containing the information for the pages in the breadcrumbs.
void	setStyle(java.lang.String style) CSS style(s) to be applied when this component is rendered.
void	setStyleClass(java.lang.String styleClass) CSS style class(es) to be applied when this component is rendered.
void	setTabIndex(int tabIndex) The position of this component in the tabbing order sequence
void	setVisible(boolean visible) Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.

Methods inherited from class javax.faces.component.UICommand

addActionListener, broadcast, getAction, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionListener, setImmediate, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Constructor Detail

BreadcrumbsBase

public BreadcrumbsBase()

Construct a new BreadcrumbsBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

getPages

public Hyperlink[] getPages()

Value binding expression that points to an array of UIComponents containing the information for the pages in the breadcrumbs.

setPages

public void setPages(Hyperlink[] pages)

Value binding expression that points to an array of UIComponents containing the information for the pages in the breadcrumbs.

See Also:

getPages()

getStyle

public java.lang.String getStyle()

CSS style(s) to be applied when this component is rendered.

setStyle

public void setStyle(java.lang.String style)

CSS style(s) to be applied when this component is rendered.

See Also:

getStyle()

getStyleClass

public java.lang.String getStyleClass()

CSS style class(es) to be applied when this component is rendered.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

CSS style class(es) to be applied when this component is rendered.

See Also:

getStyleClass()

getTabIndex

public int getTabIndex()

The position of this component in the tabbing order sequence

setTabIndex

public void setTabIndex(int tabIndex)

The position of this component in the tabbing order sequence

See Also:

getTabIndex()

isVisible

public boolean isVisible()

Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.

setVisible

public void setVisible(boolean visible)

Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.

See Also:

isVisible()

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Restore the state of this component.

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Save the state of this component.