|
| |
|
| com.sun.rave.web.ui.component.ImageComponentBase
All known Subclasses: com.sun.rave.web.ui.component.ImageComponent,
| ImageComponentBase | | abstract public class ImageComponentBase extends javax.faces.component.UIGraphic (Code) | | ui:image
tag to display an inline image in the rendered
HTML page. The url attribute is used to specify the URL to the image
file that
is to be displayed. If you use an image that is a
PNG type and ends with ".png " this tag will output the correct format
for an <img> tag to display a PNG correctly in Internet
Explorer. In order to use this feature you must set the
height and width properties of this tag..
The ui:image
tag can be used to display a theme-specific image in the
rendered HTML page. The icon attribute used in the ui:image
tag is
a key value that is mapped to a URL in theme properties file. The key
is used
to look up the appropriate image source and related attributes from the
current
theme. By specifying a key, you avoid the need to specify predefined
constants
such as height and width. The image can also be seamlessly changed when
a
different theme is selected.
Note: 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 specify
ALARM_CRITICAL_SMALL
as the value of the icon attribute of the
ui:icon
tag. A list of supported icon values will be published in
the near future.
HTML Elements and Layout
The rendered HTML page displays an XHTML compliant <img>
element with any applicable element attributes. The attributes can be
specified
through the <ui:image>
tag attributes.
Client Side Javascript
Functions
None.
Examples
Example 1: Create an image
<ui:image id="image1"
url="../images/dot.gif" />
This will generate the
following markup:
<img
src="../images/dot.gif" alt="" />
Example 2: Create a theme
specific image
<ui:image id="image2"
icon="ALARM_CRITICAL_SMALL"
/>
Auto-generated component class.
Do NOT modify; all changes
will be lost!
|
| ImageComponentBase | | public ImageComponentBase()(Code) | | Construct a new ImageComponentBase.
|
| 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 web 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 web browsers
to override the natural image or object size in favor of these values
|
| 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.
|
| getLongDesc | | public String getLongDesc()(Code) | | A verbose description of this image
|
| getOnClick | | public String getOnClick()(Code) | | Scripting code executed when a mouse click
occurs over this component.
|
| getOnDblClick | | public String getOnDblClick()(Code) | | Scripting code executed when a mouse double click
occurs over this component.
|
| getOnMouseDown | | public String getOnMouseDown()(Code) | | Scripting code executed when the user presses a mouse button while the
mouse pointer is on the component.
|
| getOnMouseMove | | public String getOnMouseMove()(Code) | | Scripting code executed when the user moves the mouse pointer while
over the component.
|
| getOnMouseOut | | public String getOnMouseOut()(Code) | | Scripting code executed when a mouse out movement
occurs over this component.
|
| getOnMouseOver | | public String getOnMouseOver()(Code) | | Scripting code executed when the user moves the mouse pointer into
the boundary of this component.
|
| getOnMouseUp | | public String getOnMouseUp()(Code) | | Scripting code executed when the user releases a mouse button while
the mouse pointer is on the component.
|
| getStyle | | public String getStyle()(Code) | | CSS style(s) to be applied when this component is rendered.
|
| getStyleClass | | public String getStyleClass()(Code) | | CSS style class(es) to be applied when this component is rendered.
|
| getToolTip | | public String getToolTip()(Code) | | Display the text as a tooltip for this component
|
| getUrl | | public String getUrl()(Code) | | Absolute or relative URL to the image to be rendered.
|
| getValueBinding | | public ValueBinding getValueBinding(String name)(Code) | | Return the ValueBinding stored for the
specified name (if any), respecting any property aliases.
Parameters:
name - Name of value binding to retrieve |
| 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 web browsers to override the natural image or object size in favor
of these values, specified in pixels. Some browsers might not support
this behavior.
|
| 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: ImageComponentBase.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 web browser
See Also: ImageComponentBase.getBorder() |
| setHeight | | public void setHeight(int height)(Code) | | When specified, the width and height attributes tell web browsers
to override the natural image or object size in favor of these values
See Also: ImageComponentBase.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: ImageComponentBase.getHspace() |
| setValueBinding | | public void setValueBinding(String name, ValueBinding binding)(Code) | | Set the ValueBinding stored for the
specified name (if any), respecting any property
aliases.
Parameters:
name - Name of value binding to set
Parameters:
binding - ValueBinding to set, or null to remove |
| 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: ImageComponentBase.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: ImageComponentBase.getVspace() |
| setWidth | | public void setWidth(int width)(Code) | | Image width override. When specified, the width and height attributes
tell web browsers 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: ImageComponentBase.getWidth() |
|
|
|