|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UICommand
com.sun.webui.jsf.component.WebuiCommand
com.sun.webui.jsf.component.Hyperlink
com.sun.webui.jsf.component.ImageHyperlink
public class ImageHyperlink
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 |
---|
public ImageHyperlink()
Method Detail |
---|
public java.lang.String getFamily()
Return the family for this component.
getFamily
in class Hyperlink
public java.lang.String getRendererType()
Return the renderer type to be used for the component.
getRendererType
in class Hyperlink
public ImageComponent getImageFacet()
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
getImageURL()
getIcon()
getAlign()
getBorder()
getAlt()
getHeight()
getHspace()
getVspace()
getWidth()
getDisabled
getType()
The returned ImageComponent
or Icon
component is created every time this method is called.
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.
getOnDblClick
in class Hyperlink
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.
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.
getAlign()
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.
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.
getAlt()
public int getBorder()
Specifies the width of the img border in pixels. The default value for this attribute depends on the client browser
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
getBorder()
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.
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.
getHeight()
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.
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.
getHspace()
public java.lang.String getIcon()
The identifier of the desired theme image.
public void setIcon(java.lang.String icon)
The identifier of the desired theme image.
getIcon()
public java.lang.String getImageURL()
Absolute or relative URL to the image to be rendered.
public void setImageURL(java.lang.String imageURL)
Absolute or relative URL to the image to be rendered.
getImageURL()
public java.lang.String getTextPosition()
Specifies where the text will be placed relative to the image. The valid values currently are "right" or "left".
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".
getTextPosition()
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.
isVisible
in class Hyperlink
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.
setVisible
in class Hyperlink
isVisible()
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.
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.
getVspace()
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.
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.
getWidth()
public void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
Restore the state of this component.
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class Hyperlink
public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Save the state of this component.
saveState
in interface javax.faces.component.StateHolder
saveState
in class Hyperlink
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |