webuijsf
Tag breadcrumbs


Use the webuijsf:breadcrumbs tag to display a set of hyperlinks that can be used as a navigation aid in the rendered HTML page. Breadcrumbs, or a parentage path, show the user's location within an application, and the physical or logical path to a page. The user can click breadcrumbs to navigate to other locations previously traversed within the application.

A breadcrumb's hyperlinks may be specified in one of two ways:

You should provide either child hyperlinks or bound hyperlinks, but not both. If both are provided, bound hyperlinks are rendered, and any child hyperlinks are ignored. Non-hyperlink children are also ignored.

Bound hyperlinks are treated as child hyperlinks for all phases of request processing, except that they are not asked to save or restore their state.

The breadcrumbs component has an immediate property, the default value of which is true. If the breadcrumbs is immediate, all action events generated by child or bound hyperlinks will be treated as though they too were immediate, whether or not the source hyperlink is immediate. If the breadcrumbs is not immediate, action events will be processed according to whether their source hyperlink is immediate or not.

HTML Elements and Layout

Breadcrumbs are rendered as a series of <a> XHTML hyperlinks separated by ">"  symbols, similar to the following: 

The last element in the breadcrumbs should correspond to the current page, and is rendered as static text.

Separators are rendered between hyperlinks that are visible and renderable. The last child hyperlink is always assumed to refer to the current page, whether or not it is visible or renderable.

Theme Identifiers

None.

Client Side Javascript Functions

None.

Examples

Example 1: Using child components

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

Example 2: Using a value binding

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


Tag Information
Tag Classcom.sun.webui.jsf.component.BreadcrumbsTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
bindingfalsefalsejava.lang.String A ValueExpression that resolves to the UIComponent that corresponds to this tag. This binding allows the Java bean that contains the UIComponent to manipulate the UIComponent, its properties, and its children.
styleClassfalsefalsejava.lang.String CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
pagesfalsefalsejava.lang.String An array of zero or more Hyperlink components that constitute the current path. If this property is not null, any child Hyperlinks will be ignored. The hyperlinks must have non-null, unique ids.
immediatefalsefalsejava.lang.String Indicates whether actions should be handled immediately when generated by hyperlinks that are part of this component. The default value is true.
visiblefalsefalsejava.lang.String Indicates whether the component and its child components should be viewable by the user in the rendered HTML page.
stylefalsefalsejava.lang.String CSS style(s) to be applied to the outermost HTML element when this component is rendered.
renderedfalsefalsejava.lang.String Use the rendered attribute to indicate whether the HTML code for the component should be included in the rendered HTML page. If set to false, the rendered HTML page does not include the HTML for the component. If the component is not rendered, it is also not processed on any subsequent form submission.
tabIndexfalsefalsejava.lang.String Position of this element in the tabbing order of the current document. Tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The value must be an integer between 0 and 32767.
idfalsetruejava.lang.StringNo Description

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.