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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

SkipHyperlink

public abstract class SkipHyperlinkBase

extends javax.faces.component.UICommand

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.

HTML Elements and Layout

The rendered HTML page displays an image hyperlink at the top, followed by an anchor at the end of the region to skip.

Theme Identifiers

None.

Client-side JavaScript functions

None.

Examples

Example 1: An example showing how to skip over the masthead:
<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

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 family for this component.
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, 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

SkipHyperlinkBase

public SkipHyperlinkBase()

Construct a new SkipHyperlinkBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

getDescription

public java.lang.String getDescription()

Textual description of the purpose of this skip hyperlink, including a description of the section that is being skipped.

setDescription

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.

See Also:

getDescription()

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()

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.