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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ImageHyperlink

public abstract class ImageHyperlinkBase

extends Hyperlink

Use the ui:imageHyperlink tag to display a clickable image in the rendered HTML page. The image is surrounded by an HTML hyperlink, allowing the image to function as a hyperlink. 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 ui:imageHyperlink 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.

The ui:imageHyperlink can display a clickable icon image from the current theme in the rendered HTML page using the "icon" attribute. The 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:imageHyperlink tag. In the near future a supported list will be published.

HTML Elements and Layout

The rendered HTML page contains an XHTML <a> element with an <img> element inside. Image attributes that are specified with the ui:imageHyperlink tag are used as attributes in the <img> element.

Theme Identifiers

None

Client Side Javascript Functions

None.

Examples

Example 1: Create an imageHyperlink with yahoo gif

<ui:imageHyperlink id="imagehyperlinktest1" imageURL="./myyahoo.gif" action="#{HyperlinkBean.getRequiredHelp}" />

Example 2: Create an IconHyperlink using the required indicator icon

<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 javax.faces.component.UICommand

COMPONENT_FAMILY, COMPONENT_TYPE

Constructor Summary

ImageHyperlinkBase()
Construct a new ImageHyperlinkBase.

Method Summary

java.lang.String	getAlign() Specifies the position of the image with respect to its context.
java.lang.String	getAlt() Alternative text description used by screen reader tools
int	getBorder() Specifies the width of the img border in pixels.
java.lang.String	getFamily() Return the family for this component.
int	getHeight() When specified, the width and height attributes tell the client browser to override the natural image or object size in favor of these values, specified in pixels.
int	getHspace() Specifies the amount of white space in pixels to be inserted to the left and right of the image.
java.lang.String	getIcon() The identifier of the desired theme image.
java.lang.String	getImageURL() Absolute or relative URL to the image to be rendered.
java.lang.String	getTextPosition() Specifies where the text will be placed relative to the image.
int	getVspace() Specifies the amount of white space in pixels to be inserted above and below the image.
int	getWidth() Image width override.
boolean	isVisible() Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.
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	setAlign(java.lang.String align) Specifies the position of the image with respect to its context.
void	setAlt(java.lang.String alt) Alternative text description used by screen reader tools
void	setBorder(int border) Specifies the width of the img border in pixels.
void	setHeight(int height) When specified, the width and height attributes tell the client browser to override the natural image or object size in favor of these values, specified in pixels.
void	setHspace(int hspace) Specifies the amount of white space in pixels to be inserted to the left and right of the image.
void	setIcon(java.lang.String icon) The identifier of the desired theme image.
void	setImageURL(java.lang.String imageURL) Absolute or relative URL to the image to be rendered.
void	setTextPosition(java.lang.String textPosition) Specifies where the text will be placed relative to the image.
void	setVisible(boolean visible) Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.
void	setVspace(int vspace) Specifies the amount of white space in pixels to be inserted above and below the image.
void	setWidth(int width) Image width override.

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

ImageHyperlinkBase

public ImageHyperlinkBase()

Construct a new ImageHyperlinkBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Overrides:

getFamily in class HyperlinkBase

getAlign

public java.lang.String getAlign()

Specifies the position of the image with respect to its context. Valid values are: bottom (the default); middle; top; left; right.

setAlign

public void setAlign(java.lang.String align)

Specifies the position of the image with respect to its context. Valid values are: bottom (the default); middle; top; left; right.

See Also:

getAlign()

getAlt

public java.lang.String getAlt()

Alternative text description used by screen reader tools

setAlt

public void setAlt(java.lang.String alt)

Alternative text description used by screen reader tools

See Also:

getAlt()

getBorder

public int getBorder()

Specifies the width of the img border in pixels. The default value for this attribute depends on the client browser

setBorder

public void setBorder(int border)

Specifies the width of the img border in pixels. The default value for this attribute depends on the client browser

See Also:

getBorder()

getHeight

public int getHeight()

When specified, the width and height attributes tell the client browser to override the natural image or object size in favor of these values, specified in pixels. Some browsers might not support this behavior.

setHeight

public void setHeight(int height)

When specified, the width and height attributes tell the client browser to override the natural image or object size in favor of these values, specified in pixels. Some browsers might not support this behavior.

See Also:

getHeight()

getHspace

public int getHspace()

Specifies the amount of white space in pixels to be inserted to the left and right of the image. The default value is not specified but is generally a small, non-zero size.

setHspace

public void setHspace(int hspace)

Specifies the amount of white space in pixels to be inserted to the left and right of the image. The default value is not specified but is generally a small, non-zero size.

See Also:

getHspace()

getIcon

public java.lang.String getIcon()

The identifier of the desired theme image.

setIcon

public void setIcon(java.lang.String icon)

The identifier of the desired theme image.

See Also:

getIcon()

getImageURL

public java.lang.String getImageURL()

Absolute or relative URL to the image to be rendered.

setImageURL

public void setImageURL(java.lang.String imageURL)

Absolute or relative URL to the image to be rendered.

See Also:

getImageURL()

getTextPosition

public java.lang.String getTextPosition()

Specifies where the text will be placed relative to the image. The valid values currently are "right" or "left". There will be support in the future for "top" and "bottom".

setTextPosition

public void setTextPosition(java.lang.String textPosition)

Specifies where the text will be placed relative to the image. The valid values currently are "right" or "left". There will be support in the future for "top" and "bottom".

See Also:

getTextPosition()

isVisible

public boolean isVisible()

Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.

Overrides:

isVisible in class HyperlinkBase

setVisible

public void setVisible(boolean visible)

Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.

Overrides:

setVisible in class HyperlinkBase

See Also:

isVisible()

getVspace

public int getVspace()

Specifies the amount of white space in pixels to be inserted above and below the image. The default value is not specified but is generally a small, non-zero size.

setVspace

public void setVspace(int vspace)

Specifies the amount of white space in pixels to be inserted above and below the image. The default value is not specified but is generally a small, non-zero size.

See Also:

getVspace()

getWidth

public int getWidth()

Image width override. When specified, the width and height attributes tell user agents to override the natural image or object size in favor of these values.

setWidth

public void setWidth(int width)

Image width override. When specified, the width and height attributes tell user agents to override the natural image or object size in favor of these values.

See Also:

getWidth()

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 HyperlinkBase

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 HyperlinkBase