|
||||||||||
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
javax.faces.component.UICommand
com.sun.rave.web.ui.component.SkipHyperlinkBase
public abstract class SkipHyperlinkBase
Use the ui:skipLink
tag to render a single-pixel transparent image (not visible within the browser page) which is hyperlinked to an anchor beyond the section to skip. This tag is used to achieve 508-compliance (paragraph o). It is designed to be used by components such as masthead, tabs, calendar and other components with repetitive links.
The rendered HTML page displays an image hyperlink at the top, followed by an anchor at the end of the region to skip.
<ui:skipHyperlink id="skip1234" description="skip over the masthead" >
<ui:masthead id=masthead1" productImageURL="../images/webconsole.png"
productImageDescription="Java Web Console"
userInfo="test_user" serverInfo="test_server" />
</ui: skipHyperlink>
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 |
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
Constructor Summary | |
---|---|
SkipHyperlinkBase()
Construct a new SkipHyperlinkBase . |
Method Summary | |
---|---|
java.lang.String |
getDescription()
Textual description of the purpose of this skip hyperlink, including a description of the section that is being skipped. |
java.lang.String |
getFamily()
Return the identifier of the component family to which this component belongs. |
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 |
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 |
setDescription(java.lang.String description)
Textual description of the purpose of this skip hyperlink, including a description of the section that is being skipped. |
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 |
Methods inherited from class javax.faces.component.UICommand |
---|
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId, getValueExpression, setValueExpression |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SkipHyperlinkBase()
Construct a new SkipHyperlinkBase
.
Method Detail |
---|
public java.lang.String getFamily()
Return the identifier of the component family to which this
component belongs. This identifier, in conjunction with the value
of the rendererType
property, may be used to select
the appropriate Renderer
for this component instance.
getFamily
in class javax.faces.component.UICommand
public java.lang.String getDescription()
Textual description of the purpose of this skip hyperlink, including a description of the section that is being skipped.
public void setDescription(java.lang.String description)
Textual description of the purpose of this skip hyperlink, including a description of the section that is being skipped.
getDescription()
public java.lang.String getStyle()
CSS style(s) to be applied when this component is rendered.
public void setStyle(java.lang.String style)
CSS style(s) to be applied when this component is rendered.
getStyle()
public java.lang.String getStyleClass()
CSS style class(es) to be applied when this component is rendered.
public void setStyleClass(java.lang.String styleClass)
CSS style class(es) to be applied when this component is rendered.
getStyleClass()
public int getTabIndex()
The position of this component in the tabbing order sequence
public void setTabIndex(int tabIndex)
The position of this component in the tabbing order sequence
getTabIndex()
public void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
Restore the state of this component.
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UICommand
public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Save the state of this component.
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UICommand
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |