|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
com.sun.webui.jsf.component.Breadcrumbs
public class Breadcrumbs
The Breadcrumbs component is used to display a list of hyperlinks, as an aid to navigation.
Breadcrumbs show the user's location within an application, and the physical or logical path to the current page. The user can click hyperlinks in the breadcrumbs to navigate to other, previously visited pages in the application.
A breadcrumb's hyperlinks may be specified in one of two ways:
pages
attribute. The value must a value binding
expression that identifies an array of com.sun.webui.jsf.Hyperlink
components. Hyperlinks
specified in this manner are referred to as "bound" hyperlinks. Bound hyperlinks must
be uniquely identifiable by the value of their id
attribute, and this attribute
must not be null. Bound hyperlinks should not be part of a view tree, and the value of
their parent
property should be null.
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.
Field Summary |
---|
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
Breadcrumbs()
|
Method Summary | |
---|---|
java.lang.String |
getFamily()
|
java.lang.String |
getFocusElementId(javax.faces.context.FacesContext context)
Return the absolute identifier of the HTML element suitable to receive the focus. |
javax.faces.component.UIComponent |
getIndicatorComponent(javax.faces.context.FacesContext context,
Label label)
Return a component instance that can be referenced by a Label component in order to evaluate the
required and valid states of the component. |
java.lang.String |
getLabeledElementId(javax.faces.context.FacesContext context)
Return the absolute identifier of the HTML element suitable for use as the value of an HTML Label element's for attribute. |
Hyperlink[] |
getPages()
Get the array of zero or more Hyperlink components that constitute the current path. |
java.lang.String |
getPrimaryElementID(javax.faces.context.FacesContext context)
Deprecated. |
java.lang.String |
getStyle()
Returns the CSS style(s) to be applied to the outermost HTML element when this component is rendered. |
java.lang.String |
getStyleClass()
Get the CSS style class(es) to be applied to the outermost HTML element when this component is rendered. |
int |
getTabIndex()
Get the position of this element in the tabbing order of the current document. |
boolean |
isImmediate()
|
boolean |
isVisible()
Returns true if this component and its child components should be viewable by the user in the rendered HTML page. |
void |
processDecodes(javax.faces.context.FacesContext context)
|
void |
processUpdates(javax.faces.context.FacesContext context)
|
void |
processValidators(javax.faces.context.FacesContext context)
|
void |
queueEvent(javax.faces.event.FacesEvent event)
|
void |
restoreState(javax.faces.context.FacesContext _context,
java.lang.Object _state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext _context)
|
void |
setId(java.lang.String id)
The component identifier for this component. |
void |
setImmediate(boolean immediate)
|
void |
setPages(Hyperlink[] pages)
Set the array of zero or more Hyperlink components that constitute the current path. |
void |
setRendered(boolean rendered)
Use the rendered attribute to indicate whether the HTML code for the component should be included in the rendered HTML page. |
void |
setStyle(java.lang.String style)
Set the CSS style(s) to be applied to the outermost HTML element when this component is rendered. |
void |
setStyleClass(java.lang.String styleClass)
Set the CSS style class(es) to be applied to the outermost HTML element when this component is rendered. |
void |
setTabIndex(int tabIndex)
Set the position of this element in the tabbing order of the current document. |
void |
setVisible(boolean visible)
Returns true if this component and its child components should be viewable by the user in the rendered HTML page. |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding, setValueExpression |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Breadcrumbs()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIComponent
public void setId(java.lang.String id)
setId
in class javax.faces.component.UIComponentBase
public void setRendered(boolean rendered)
setRendered
in class javax.faces.component.UIComponentBase
public Hyperlink[] getPages()
public void setPages(Hyperlink[] pages)
public java.lang.String getStyle()
setStyle(java.lang.String)
public void setStyle(java.lang.String style)
getStyle()
public java.lang.String getStyleClass()
setStyleClass(java.lang.String)
public void setStyleClass(java.lang.String styleClass)
getStyleClass()
public int getTabIndex()
setTabIndex(int)
public void setTabIndex(int tabIndex)
getTabIndex()
public boolean isImmediate()
public void setImmediate(boolean immediate)
public boolean isVisible()
setVisible(boolean)
public void setVisible(boolean visible)
isVisible()
public void processDecodes(javax.faces.context.FacesContext context)
processDecodes
in class javax.faces.component.UIComponentBase
public void processValidators(javax.faces.context.FacesContext context)
processValidators
in class javax.faces.component.UIComponentBase
public void processUpdates(javax.faces.context.FacesContext context)
processUpdates
in class javax.faces.component.UIComponentBase
public void queueEvent(javax.faces.event.FacesEvent event)
queueEvent
in class javax.faces.component.UIComponentBase
public java.lang.String getPrimaryElementID(javax.faces.context.FacesContext context)
for
attribute should apply.
getPrimaryElementID
in interface com.sun.webui.jsf.component.ComplexComponent
context
- The FacesContext for the request
getLabeledElementId(javax.faces.context.FacesContext)
,
getFocusElementId(javax.faces.context.FacesContext)
public java.lang.String getLabeledElementId(javax.faces.context.FacesContext context)
for
attribute.
For a breadcrumb component, delegate to the first hyperlink child
component or first hyperlink component in the pages
list. If there is a single hyperlink component, it will be rendered
as HTML static text within a span
, so a null is returned.
getLabeledElementId
in interface com.sun.webui.jsf.component.ComplexComponent
context
- The FacesContext used for the request
for
attribute.public java.lang.String getFocusElementId(javax.faces.context.FacesContext context)
pages
list. If there is a single hyperlink component, it will be rendered
as HTML static text within a span
, so a null is returned.
getFocusElementId
in interface com.sun.webui.jsf.component.ComplexComponent
context
- The FacesContext used for the request
public javax.faces.component.UIComponent getIndicatorComponent(javax.faces.context.FacesContext context, Label label)
Label
component in order to evaluate the
required
and valid
states of the component.
For a breadcrumb, there are no such components, since it currently
restricts its children to be Hyperlink
components.
However, we delegate to the first hyperlink component, since its
a child component implementing the ComplexComponent interface.
getIndicatorComponent
in interface com.sun.webui.jsf.component.ComplexComponent
context
- The FacesContext used for the requestlabel
- The Label
component that labels this
breadcrumb.
UIComponent
used to evaluate the required
and valid states.public void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIComponentBase
public java.lang.Object saveState(javax.faces.context.FacesContext _context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIComponentBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |