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

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UICommand
              com.sun.rave.web.ui.component.HyperlinkBase
                  com.sun.rave.web.ui.component.Hyperlink
                      com.sun.rave.web.ui.component.ImageHyperlinkBase
                          com.sun.rave.web.ui.component.ImageHyperlink
                              com.sun.rave.web.ui.component.IconHyperlinkBase

All Implemented Interfaces:

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

Direct Known Subclasses:

IconHyperlink

public abstract class IconHyperlinkBase

extends ImageHyperlink

Use the ui:iconHyperlink tag to display a clickable icon image from the current theme in the rendered HTML page. The iconHyperlink component is essentially a subclass of the imageHyperlink component. The ui:iconHyperlink tag allows you to use an icon (a small image) from the current theme. Currently the list of icons that you can use is not publicly supported, but the icon names are specified in the /com/sun/rave/web/ui/suntheme/SunTheme.properties file. The names are listed as resource keys of the format image.ICON_NAME. Use only the part of the key that follows image. For example, if the key is image.ALARM_CRITICAL_SMALL, you should use ALARM_CRITICAL_SMALL as the specified icon name in the ui:iconHyperlink tag. In the near future a supported list will be published. This tag is based on a ui:hyperlink tag and functions the same way. The main difference is this tag will format an image with a surrounding hyperlink. See the ui:hyperlink tag for more examples on using a hyperlink

The iconHyperlink component can be also be used to submit forms. If the action attribute is used, the form is submitted. If the url attribute is used, the link is a normal hyperlink that sends the browser to a new location.

HTML Elements and Layout

The rendered HTML page displays....

Theme Identifiers

None.

Client-side JavaScript functions

None.

Examples

Example 1: Create an IconHyperlink using showing the required indicator

<ui:iconHyperlink id="iconhyperlinktest1"
icon="LABEL_REQUIRED_ICON"
action="#{HyperlinkBean.getRequiredHelp}" />


Auto-generated component class. Do NOT modify; all changes will be lost!

Field Summary

Fields inherited from class com.sun.rave.web.ui.component.ImageHyperlink

IMAGE_FACET_SUFFIX

Fields inherited from class javax.faces.component.UICommand

COMPONENT_FAMILY, COMPONENT_TYPE

Constructor Summary

IconHyperlinkBase()
Construct a new IconHyperlinkBase.

Method Summary

java.lang.String	getFamily() Return the family for this component.
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.

Methods inherited from class com.sun.rave.web.ui.component.ImageHyperlink

getImageFacet, setAttributes

Methods inherited from class com.sun.rave.web.ui.component.ImageHyperlinkBase

getAlign, getAlt, getBorder, getHeight, getHspace, getIcon, getImageURL, getTextPosition, getVspace, getWidth, isVisible, setAlign, setAlt, setBorder, setHeight, setHspace, setIcon, setImageURL, setTextPosition, setVisible, setVspace, setWidth

Methods inherited from class com.sun.rave.web.ui.component.Hyperlink

getPrimaryElementID, toString

Methods inherited from class com.sun.rave.web.ui.component.HyperlinkBase

getAction, getActionListener, getOnBlur, getOnClick, getOnDblClick, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseDown, getOnMouseMove, getOnMouseOut, getOnMouseOver, getOnMouseUp, getShape, getStyle, getStyleClass, getTabIndex, getTarget, getText, getToolTip, getType, getUrl, getUrlLang, getValueBinding, isDisabled, setAction, setActionListener, setDisabled, setOnBlur, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setShape, setStyle, setStyleClass, setTabIndex, setTarget, setText, setToolTip, setType, setUrl, setUrlLang, setValueBinding

Methods inherited from class javax.faces.component.UICommand

addActionListener, broadcast, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, 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, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IconHyperlinkBase

public IconHyperlinkBase()

Construct a new IconHyperlinkBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Overrides:

getFamily in class ImageHyperlinkBase

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 ImageHyperlinkBase

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 ImageHyperlinkBase