com.sun.webui.jsf.component
Class ImageHyperlink

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.Hyperlink
                      extended by com.sun.webui.jsf.component.ImageHyperlink
All Implemented Interfaces:
com.sun.webui.jsf.component.ComplexComponent, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.NamingContainer, javax.faces.component.StateHolder
Direct Known Subclasses:
AlarmStatus, IconHyperlink, JobStatus, NotificationPhrase

public class ImageHyperlink
extends Hyperlink
implements javax.faces.component.NamingContainer

Use the webuijsf:imageHyperlink tag to display a clickable image in the rendered HTML page. The image is surrounded by an HTML anchor, allowing the image to function as a hyperlink.  This tag is based on a webuijsf:hyperlink tag and functions the same way.  The main difference is this tag will format an image with a surrounding hyperlink.  See the webuijsf:hyperlink tag for more examples on using a hyperlink.

The webuijsf:imageHyperlink component can be also be used to submit forms. If the actionExpression 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 webuijsf:imageHyperlink can display a clickable icon image from the current theme in the rendered HTML page using the "icon" attribute. Take a look at the webuijsf:image tag to see how the icon attribute is to be used. The image that is specified as a part of the imageUrl or the icon attribute is shown for the enabled state of the imageHyperlink. If a disabledImage facet is specified, then that image will be shown when the imageHyperlink changes to the disabled state. If not, the image specified for the enabled state will be shown.


Field Summary
 
Fields inherited from class javax.faces.component.UICommand
COMPONENT_FAMILY, COMPONENT_TYPE
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
ImageHyperlink()
          Default constructor.
 
Method Summary
 java.lang.String getAlign()
          Specifies the position of the image with respect to its context.
 java.lang.String getAlt()
          Alternative textual description of the image rendered by this component.
 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.
 ImageComponent getImageFacet()
          Return a component that implements an image or an icon.
 java.lang.String getImageURL()
          Absolute or relative URL to the image to be rendered.
 java.lang.String getOnDblClick()
          Specifies the position of the image with respect to its context.
 java.lang.String getRendererType()
           Return the renderer type to be used for the component.
 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 textual description of the image rendered by this component.
 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.webui.jsf.component.Hyperlink
getFocusElementId, getHtmlTemplate, getIndicatorComponent, getLabeledElementId, getOnBlur, getOnClick, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseDown, getOnMouseMove, getOnMouseOut, getOnMouseOver, getOnMouseUp, getPrimaryElementID, getShape, getStyle, getStyleClass, getTabIndex, getTarget, getText, getToolTip, getType, getUrl, getUrlLang, getValue, getValueExpression, isDisabled, setDisabled, setHtmlTemplate, setOnBlur, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setShape, setStyle, setStyleClass, setTabIndex, setTarget, setText, setToolTip, setType, setUrl, setUrlLang, setValueExpression, toString
 
Methods inherited from class com.sun.webui.jsf.component.WebuiCommand
broadcast, getAction, getActionExpression, getActionListener, getActionListenerExpression, processDecodes, processUpdates, processValidators, setActionListenerExpression, setId, setImmediate, setRendered
 
Methods inherited from class javax.faces.component.UICommand
addActionListener, getActionListeners, isImmediate, 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, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ImageHyperlink

public ImageHyperlink()
Default constructor.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Overrides:
getFamily in class Hyperlink

getRendererType

public java.lang.String getRendererType()

Return the renderer type to be used for the component.

Overrides:
getRendererType in class Hyperlink

getImageFacet

public ImageComponent getImageFacet()
Return a component that implements an image or an icon. If getImageURL() returns a value that is not null, an ImageComponent is returned. If getImageURL() returns null and getIcon() returns a value that is not null, an Icon component is returned. If both methods return null, null is returned. The returned instance is intialized with the values from

The returned ImageComponent or Icon component is created every time this method is called.

Returns:
ImageComponent or Icon instance

getOnDblClick

public java.lang.String getOnDblClick()

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

Overrides:
getOnDblClick in class Hyperlink

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 textual description of the image rendered by this component. The alt text can be used by screen readers and in tool tips, and when image display is turned off in the web browser.


setAlt

public void setAlt(java.lang.String alt)

Alternative textual description of the image rendered by this component. The alt text can be used by screen readers and in tool tips, and when image display is turned off in the web browser.

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".


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".

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 Hyperlink

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 Hyperlink
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 Hyperlink

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 Hyperlink


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