| com.sun.rave.web.ui.component.ImageComponentBase
 com.sun.rave.web.ui.component.ImageComponent
com.sun.rave.web.ui.component.AlarmBase
All known Subclasses: com.sun.rave.web.ui.component.Alarm,
| AlarmBase | | abstract public class AlarmBase extends com.sun.rave.web.ui.component.ImageComponent (Code) | | ui:alarm
tag to display a theme-specific image in the rendered HTML page.
The severityattribute is used to specify the alarm severity which in turn is used to determine the theme-specific alarm icon to render.
The url attribute and (and other attributes related to an image) may be used to override the them-sepcific alarm icon.
HTML Elements and Layout
The rendered HTML page displays an XHTML compliant <img>
element with any applicable attributes.
Theme Identifiers
Alarm icons.
Client Side Javascript Functions
None.
Examples
Example 1: Create an alarm with critical severity.
<ui:alarm id="alarm1" severity="critical" />
Example 2: Create a alarm with major severity, but override the alarm image.
<ui:alarm id="alarm2" severity="major"
url="../images/major.gif" height="10" width="10"
alt="Processor Alarm: Major" />
Auto-generated component class.
Do NOT modify; all changes
will be lost!
|
| Method Summary | |
| public String | getAlt()
| | public String | getFamily()
Return the identifier of the component family to which this
component belongs. | | public String | getOnClick()
| | public String | getOnDblClick()
| | public String | getOnKeyDown()
| | public String | getOnKeyPress()
| | public String | getOnKeyUp()
| | public String | getOnMouseDown()
| | public String | getOnMouseMove()
| | public String | getOnMouseOut()
| | public String | getOnMouseOver()
| | public String | getOnMouseUp()
| | public String | getSeverity()
Specifies the severity of the alarm.
Valid values are: critical, major, minor, down, ok.
Note, a severity of ok renders no alarm icon. | | public String | getStyle()
| | public String | getStyleClass()
| | public String | getToolTip()
| | 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 | setAlt(String alt)
| | public void | setOnClick(String onClick)
| | public void | setOnDblClick(String onDblClick)
| | public void | setOnKeyDown(String onKeyDown)
| | public void | setOnKeyPress(String onKeyPress)
| | public void | setOnKeyUp(String onKeyUp)
| | public void | setOnMouseDown(String onMouseDown)
| | public void | setOnMouseMove(String onMouseMove)
| | public void | setOnMouseOut(String onMouseOut)
| | public void | setOnMouseOver(String onMouseOver)
| | public void | setOnMouseUp(String onMouseUp)
| | public void | setSeverity(String severity)
Specifies the severity of the alarm.
Valid values are: critical, major, minor, down, ok.
Note, a severity of ok renders no alarm icon. | | public void | setStyle(String style)
| | public void | setStyleClass(String styleClass)
| | public void | setToolTip(String toolTip)
| | 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. |
| AlarmBase | | public AlarmBase()(Code) | | Construct a new AlarmBase.
|
| getAlt | | public String getAlt()(Code) | | Alternative text description used by screen reader tools
|
| 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.
|
| 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.
|
| getOnKeyDown | | public String getOnKeyDown()(Code) | | Scripting code executed when the user presses down on a key while the
component has focus.
|
| getOnKeyPress | | public String getOnKeyPress()(Code) | | Scripting code executed when the user presses and releases a key while
the component has focus.
|
| getOnKeyUp | | public String getOnKeyUp()(Code) | | Scripting code executed when the user releases a key while the
component has focus.
|
| 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.
|
| getSeverity | | public String getSeverity()(Code) | | Specifies the severity of the alarm.
Valid values are: critical, major, minor, down, ok.
Note, a severity of ok renders no alarm icon. This is the default value.
|
| 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
|
| 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.
|
| setOnKeyDown | | public void setOnKeyDown(String onKeyDown)(Code) | | Scripting code executed when the user presses down on a key while the
component has focus.
See Also: AlarmBase.getOnKeyDown() |
| setOnKeyPress | | public void setOnKeyPress(String onKeyPress)(Code) | | Scripting code executed when the user presses and releases a key while
the component has focus.
See Also: AlarmBase.getOnKeyPress() |
| setOnKeyUp | | public void setOnKeyUp(String onKeyUp)(Code) | | Scripting code executed when the user releases a key while the
component has focus.
See Also: AlarmBase.getOnKeyUp() |
| setOnMouseDown | | public void setOnMouseDown(String onMouseDown)(Code) | | Scripting code executed when the user presses a mouse button while the
mouse pointer is on the component.
See Also: AlarmBase.getOnMouseDown() |
| setOnMouseMove | | public void setOnMouseMove(String onMouseMove)(Code) | | Scripting code executed when the user moves the mouse pointer while
over the component.
See Also: AlarmBase.getOnMouseMove() |
| setOnMouseOver | | public void setOnMouseOver(String onMouseOver)(Code) | | Scripting code executed when the user moves the mouse pointer into
the boundary of this component.
See Also: AlarmBase.getOnMouseOver() |
| setOnMouseUp | | public void setOnMouseUp(String onMouseUp)(Code) | | Scripting code executed when the user releases a mouse button while
the mouse pointer is on the component.
See Also: AlarmBase.getOnMouseUp() |
| setSeverity | | public void setSeverity(String severity)(Code) | | Specifies the severity of the alarm.
Valid values are: critical, major, minor, down, ok.
Note, a severity of ok renders no alarm icon. This is the default value.
See Also: AlarmBase.getSeverity() |
| 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: AlarmBase.isVisible() |
|
|