com.sun.webui.jsf.component
Class SkipHyperlink

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by com.sun.webui.jsf.component.WebuiCommand
                  extended by com.sun.webui.jsf.component.SkipHyperlink
All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.StateHolder

public class SkipHyperlink
extends WebuiCommand

The SkipLink component is used to create a single-pixel transparent image (not visible within the browser page) which is hyperlinked to an anchor beyond the section to skip.


Field Summary
 
Fields inherited from class javax.faces.component.UICommand
COMPONENT_FAMILY, COMPONENT_TYPE
 
Constructor Summary
SkipHyperlink()
          Construct a new SkipHyperlink.
 
Method Summary
 javax.el.MethodExpression getActionExpression()
          MethodExpression representing the application action to invoke when this component is activated by the user.
 javax.el.MethodExpression getActionListenerExpression()
          Simply return the stored actionListenerExpression.
 java.lang.String getDescription()
          Use the description attribute to provide text that describes the purpose of the skip hyperlink.
 java.lang.String getFamily()
          Return the family for this component.
 java.lang.String getStyle()
          CSS style(s) to be applied to the outermost HTML element when this component is rendered.
 java.lang.String getStyleClass()
          CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
 int getTabIndex()
          Position of this element in the tabbing order of the current document.
 java.lang.Object getValue()
           
 boolean isImmediate()
           
 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)
          Use the description attribute to provide text that describes the purpose of the skip hyperlink.
 void setStyle(java.lang.String style)
          CSS style(s) to be applied to the outermost HTML element when this component is rendered.
 void setStyleClass(java.lang.String styleClass)
          CSS style class(es) to be applied to the outermost HTML element when this component is rendered.
 void setTabIndex(int tabIndex)
          Position of this element in the tabbing order of the current document.
 
Methods inherited from class com.sun.webui.jsf.component.WebuiCommand
broadcast, getAction, getActionListener, processDecodes, processUpdates, processValidators, setActionListenerExpression, setId, setImmediate, setRendered
 
Methods inherited from class javax.faces.component.UICommand
addActionListener, getActionListeners, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
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

SkipHyperlink

public SkipHyperlink()

Construct a new SkipHyperlink.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Overrides:
getFamily in class javax.faces.component.UICommand

getActionExpression

public javax.el.MethodExpression getActionExpression()
Description copied from class: WebuiCommand
MethodExpression representing the application action to invoke when this component is activated by the user. The expression must evaluate to a either a String or a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application.

Specified by:
getActionExpression in interface javax.faces.component.ActionSource2
Overrides:
getActionExpression in class WebuiCommand

getActionListenerExpression

public javax.el.MethodExpression getActionListenerExpression()
Description copied from class: WebuiCommand

Simply return the stored actionListenerExpression. The broadcast method is overridden in WebuiCommand to invoke the actionListenerExpression.

Overrides:
getActionListenerExpression in class WebuiCommand

isImmediate

public boolean isImmediate()
Specified by:
isImmediate in interface javax.faces.component.ActionSource
Overrides:
isImmediate in class javax.faces.component.UICommand

getValue

public java.lang.Object getValue()
Overrides:
getValue in class javax.faces.component.UICommand

getDescription

public java.lang.String getDescription()

Use the description attribute to provide text that describes the purpose of the skip hyperlink. The description should indicate which section is skipped when the link is clicked. The text is rendered as the alt text for the image.


setDescription

public void setDescription(java.lang.String description)

Use the description attribute to provide text that describes the purpose of the skip hyperlink. The description should indicate which section is skipped when the link is clicked. The text is rendered as the alt text for the image.

See Also:
getDescription()

getStyle

public java.lang.String getStyle()

CSS style(s) to be applied to the outermost HTML element when this component is rendered.


setStyle

public void setStyle(java.lang.String style)

CSS style(s) to be applied to the outermost HTML element when this component is rendered.

See Also:
getStyle()

getStyleClass

public java.lang.String getStyleClass()

CSS style class(es) to be applied to the outermost HTML element when this component is rendered.


setStyleClass

public void setStyleClass(java.lang.String styleClass)

CSS style class(es) to be applied to the outermost HTML element when this component is rendered.

See Also:
getStyleClass()

getTabIndex

public int getTabIndex()

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.


setTabIndex

public void setTabIndex(int tabIndex)

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.

See Also:
getTabIndex()

restoreState

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

Restore the state of this component.

Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class WebuiCommand

saveState

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

Save the state of this component.

Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class WebuiCommand


Copyright © 2008 Sun Microsystems, Inc. All Rights Reserved.