| com.sun.rave.web.ui.component.HyperlinkBase
 com.sun.rave.web.ui.component.Hyperlink
com.sun.rave.web.ui.component.ImageHyperlinkBase
All known Subclasses: com.sun.rave.web.ui.component.ImageHyperlink,
| ImageHyperlinkBase | | abstract public class ImageHyperlinkBase extends com.sun.rave.web.ui.component.Hyperlink (Code) | | 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 /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
HTML
Elements and Layout
The rendered HTML page
contains
an XHTML <a>
element with an <img>
element inside. 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!
|
| Method Summary | |
| public String | getAlign()
Specifies the position of the image with respect to its context. | | public String | getAlt()
| | public int | getBorder()
Specifies the width of the img border in pixels. | | public String | getFamily()
Return the identifier of the component family to which this
component belongs. | | 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. | | public int | getHspace()
Specifies the amount of white space in pixels to be inserted to the left and
right of the image. | | public String | getIcon()
| | public String | getImageURL()
| | public String | getTextPosition()
Specifies where the text will be placed relative to the image. | | public int | getVspace()
Specifies the amount of white space in pixels to be inserted above and below the
image. | | public int | getWidth()
Image width override. | | public boolean | isVisible()
Use the visible attribute to indicate whether the component should be
viewable by the user in the rendered HTML page. | | public void | restoreState(FacesContext _context, Object _state)
| | public Object | saveState(FacesContext _context)
| | public void | setAlign(String align)
Specifies the position of the image with respect to its context. | | public void | setAlt(String alt)
| | public void | setBorder(int border)
Specifies the width of the img border in pixels. | | 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. | | public void | setHspace(int hspace)
Specifies the amount of white space in pixels to be inserted to the left and
right of the image. | | public void | setIcon(String icon)
| | public void | setImageURL(String imageURL)
| | public void | setTextPosition(String textPosition)
Specifies where the text will be placed relative to the image. | | 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. | | public void | setVspace(int vspace)
Specifies the amount of white space in pixels to be inserted above and below the
image. | | public void | setWidth(int width)
Image width override. |
| ImageHyperlinkBase | | public ImageHyperlinkBase()(Code) | | Construct a new ImageHyperlinkBase.
|
| getAlign | | public String getAlign()(Code) | | Specifies the position of the image with respect to its context.
Valid values are: bottom (the default); middle; top; left; right.
|
| getAlt | | public String getAlt()(Code) | | Alternative text description used by screen reader tools
|
| getBorder | | public int getBorder()(Code) | | Specifies the width of the img border in pixels.
The default value for this attribute depends on the client browser
|
| getFamily | | public String getFamily()(Code) | | Return the identifier of the component family to which this
component belongs. This identifier, in conjunction with the value
of the rendererType property, may be used to select
the appropriate
Renderer for this component instance.
|
| getHeight | | public int getHeight()(Code) | | 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.
|
| getHspace | | public int getHspace()(Code) | | 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.
|
| getIcon | | public String getIcon()(Code) | | The identifier of the desired theme image.
|
| getImageURL | | public String getImageURL()(Code) | | Absolute or relative URL to the image to be rendered.
|
| getTextPosition | | public String getTextPosition()(Code) | | 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".
|
| getVspace | | public int getVspace()(Code) | | 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.
|
| getWidth | | public int getWidth()(Code) | | 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.
|
| isVisible | | public boolean isVisible()(Code) | | 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.
|
| restoreState | | public void restoreState(FacesContext _context, Object _state)(Code) | | Restore the state of this component.
|
| saveState | | public Object saveState(FacesContext _context)(Code) | | Save the state of this component.
|
| setAlign | | public void setAlign(String align)(Code) | | Specifies the position of the image with respect to its context.
Valid values are: bottom (the default); middle; top; left; right.
See Also: ImageHyperlinkBase.getAlign() |
| setBorder | | public void setBorder(int border)(Code) | | Specifies the width of the img border in pixels.
The default value for this attribute depends on the client browser
See Also: ImageHyperlinkBase.getBorder() |
| setHeight | | public void setHeight(int height)(Code) | | 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: ImageHyperlinkBase.getHeight() |
| setHspace | | public void setHspace(int hspace)(Code) | | 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: ImageHyperlinkBase.getHspace() |
| setTextPosition | | public void setTextPosition(String textPosition)(Code) | | 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: ImageHyperlinkBase.getTextPosition() |
| setVisible | | public void setVisible(boolean visible)(Code) | | 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.
See Also: ImageHyperlinkBase.isVisible() |
| setVspace | | public void setVspace(int vspace)(Code) | | 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: ImageHyperlinkBase.getVspace() |
| setWidth | | public void setWidth(int width)(Code) | | 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: ImageHyperlinkBase.getWidth() |
|
|