Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.sun.rave.web.ui.component
Class AlarmBase

java.lang.Object
  extended byjavax.faces.component.UIComponent
      extended byjavax.faces.component.UIComponentBase
          extended byjavax.faces.component.UIGraphic
              extended bycom.sun.rave.web.ui.component.ImageComponentBase
                  extended bycom.sun.rave.web.ui.component.ImageComponent
                      extended bycom.sun.rave.web.ui.component.AlarmBase
All Implemented Interfaces:
javax.faces.component.StateHolder
Direct Known Subclasses:
Alarm
public abstract class AlarmBase
extends ImageComponent

Use the 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!

Field Summary
 
Fields inherited from class javax.faces.component.UIGraphic
COMPONENT_FAMILY, COMPONENT_TYPE
 
Constructor Summary
AlarmBase()
          Construct a new AlarmBase.
 
Method Summary
 java.lang.String getAlt()
          Alternative text description used by screen reader tools
 java.lang.String getFamily()
          Return the family for this component.
 java.lang.String getOnClick()
          Scripting code executed when a mouse click occurs over this component.
 java.lang.String getOnDblClick()
          Scripting code executed when a mouse double click occurs over this component.
 java.lang.String getOnKeyDown()
          Scripting code executed when the user presses down on a key while the component has focus.
 java.lang.String getOnKeyPress()
          Scripting code executed when the user presses and releases a key while the component has focus.
 java.lang.String getOnKeyUp()
          Scripting code executed when the user releases a key while the component has focus.
 java.lang.String getOnMouseDown()
          Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.
 java.lang.String getOnMouseMove()
          Scripting code executed when the user moves the mouse pointer while over the component.
 java.lang.String getOnMouseOut()
          Scripting code executed when a mouse out movement occurs over this component.
 java.lang.String getOnMouseOver()
          Scripting code executed when the user moves the mouse pointer into the boundary of this component.
 java.lang.String getOnMouseUp()
          Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.
 java.lang.String getSeverity()
          Specifies the severity of the alarm.
 java.lang.String getStyle()
          CSS style(s) to be applied when this component is rendered.
 java.lang.String getStyleClass()
          CSS style class(es) to be applied when this component is rendered.
 java.lang.String getToolTip()
          Display the text as a tooltip for this component
 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 setAlt(java.lang.String alt)
          Alternative text description used by screen reader tools
 void setOnClick(java.lang.String onClick)
          Scripting code executed when a mouse click occurs over this component.
 void setOnDblClick(java.lang.String onDblClick)
          Scripting code executed when a mouse double click occurs over this component.
 void setOnKeyDown(java.lang.String onKeyDown)
          Scripting code executed when the user presses down on a key while the component has focus.
 void setOnKeyPress(java.lang.String onKeyPress)
          Scripting code executed when the user presses and releases a key while the component has focus.
 void setOnKeyUp(java.lang.String onKeyUp)
          Scripting code executed when the user releases a key while the component has focus.
 void setOnMouseDown(java.lang.String onMouseDown)
          Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.
 void setOnMouseMove(java.lang.String onMouseMove)
          Scripting code executed when the user moves the mouse pointer while over the component.
 void setOnMouseOut(java.lang.String onMouseOut)
          Scripting code executed when a mouse out movement occurs over this component.
 void setOnMouseOver(java.lang.String onMouseOver)
          Scripting code executed when the user moves the mouse pointer into the boundary of this component.
 void setOnMouseUp(java.lang.String onMouseUp)
          Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.
 void setSeverity(java.lang.String severity)
          Specifies the severity of the alarm.
 void setStyle(java.lang.String style)
          CSS style(s) to be applied when this component is rendered.
 void setStyleClass(java.lang.String styleClass)
          CSS style class(es) to be applied when this component is rendered.
 void setToolTip(java.lang.String toolTip)
          Display the text as a tooltip for this component
 void setVisible(boolean visible)
          Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.
 
Methods inherited from class com.sun.rave.web.ui.component.ImageComponentBase
getAlign, getBorder, getHeight, getHspace, getIcon, getLongDesc, getUrl, getValueBinding, getVspace, getWidth, setAlign, setBorder, setHeight, setHspace, setIcon, setLongDesc, setUrl, setValueBinding, setVspace, setWidth
 
Methods inherited from class javax.faces.component.UIGraphic
getValue, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AlarmBase

public AlarmBase()

Construct a new AlarmBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Overrides:
getFamily in class ImageComponentBase

getAlt

public java.lang.String getAlt()

Alternative text description used by screen reader tools

Overrides:
getAlt in class ImageComponentBase

setAlt

public void setAlt(java.lang.String alt)

Alternative text description used by screen reader tools

Overrides:
setAlt in class ImageComponentBase
See Also:
getAlt()

getOnClick

public java.lang.String getOnClick()

Scripting code executed when a mouse click occurs over this component.

Overrides:
getOnClick in class ImageComponentBase

setOnClick

public void setOnClick(java.lang.String onClick)

Scripting code executed when a mouse click occurs over this component.

Overrides:
setOnClick in class ImageComponentBase
See Also:
getOnClick()

getOnDblClick

public java.lang.String getOnDblClick()

Scripting code executed when a mouse double click occurs over this component.

Overrides:
getOnDblClick in class ImageComponentBase

setOnDblClick

public void setOnDblClick(java.lang.String onDblClick)

Scripting code executed when a mouse double click occurs over this component.

Overrides:
setOnDblClick in class ImageComponentBase
See Also:
getOnDblClick()

getOnKeyDown

public java.lang.String getOnKeyDown()

Scripting code executed when the user presses down on a key while the component has focus.

setOnKeyDown

public void setOnKeyDown(java.lang.String onKeyDown)

Scripting code executed when the user presses down on a key while the component has focus.

See Also:
getOnKeyDown()

getOnKeyPress

public java.lang.String getOnKeyPress()

Scripting code executed when the user presses and releases a key while the component has focus.

setOnKeyPress

public void setOnKeyPress(java.lang.String onKeyPress)

Scripting code executed when the user presses and releases a key while the component has focus.

See Also:
getOnKeyPress()

getOnKeyUp

public java.lang.String getOnKeyUp()

Scripting code executed when the user releases a key while the component has focus.

setOnKeyUp

public void setOnKeyUp(java.lang.String onKeyUp)

Scripting code executed when the user releases a key while the component has focus.

See Also:
getOnKeyUp()

getOnMouseDown

public java.lang.String getOnMouseDown()

Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.

Overrides:
getOnMouseDown in class ImageComponentBase

setOnMouseDown

public void setOnMouseDown(java.lang.String onMouseDown)

Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.

Overrides:
setOnMouseDown in class ImageComponentBase
See Also:
getOnMouseDown()

getOnMouseMove

public java.lang.String getOnMouseMove()

Scripting code executed when the user moves the mouse pointer while over the component.

Overrides:
getOnMouseMove in class ImageComponentBase

setOnMouseMove

public void setOnMouseMove(java.lang.String onMouseMove)

Scripting code executed when the user moves the mouse pointer while over the component.

Overrides:
setOnMouseMove in class ImageComponentBase
See Also:
getOnMouseMove()

getOnMouseOut

public java.lang.String getOnMouseOut()

Scripting code executed when a mouse out movement occurs over this component.

Overrides:
getOnMouseOut in class ImageComponentBase

setOnMouseOut

public void setOnMouseOut(java.lang.String onMouseOut)

Scripting code executed when a mouse out movement occurs over this component.

Overrides:
setOnMouseOut in class ImageComponentBase
See Also:
getOnMouseOut()

getOnMouseOver

public java.lang.String getOnMouseOver()

Scripting code executed when the user moves the mouse pointer into the boundary of this component.

Overrides:
getOnMouseOver in class ImageComponentBase

setOnMouseOver

public void setOnMouseOver(java.lang.String onMouseOver)

Scripting code executed when the user moves the mouse pointer into the boundary of this component.

Overrides:
setOnMouseOver in class ImageComponentBase
See Also:
getOnMouseOver()

getOnMouseUp

public java.lang.String getOnMouseUp()

Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.

Overrides:
getOnMouseUp in class ImageComponentBase

setOnMouseUp

public void setOnMouseUp(java.lang.String onMouseUp)

Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.

Overrides:
setOnMouseUp in class ImageComponentBase
See Also:
getOnMouseUp()

getSeverity

public java.lang.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. This is the default value.

setSeverity

public void setSeverity(java.lang.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. This is the default value.

See Also:
getSeverity()

getStyle

public java.lang.String getStyle()

CSS style(s) to be applied when this component is rendered.

Overrides:
getStyle in class ImageComponentBase

setStyle

public void setStyle(java.lang.String style)

CSS style(s) to be applied when this component is rendered.

Overrides:
setStyle in class ImageComponentBase
See Also:
getStyle()

getStyleClass

public java.lang.String getStyleClass()

CSS style class(es) to be applied when this component is rendered.

Overrides:
getStyleClass in class ImageComponentBase

setStyleClass

public void setStyleClass(java.lang.String styleClass)

CSS style class(es) to be applied when this component is rendered.

Overrides:
setStyleClass in class ImageComponentBase
See Also:
getStyleClass()

getToolTip

public java.lang.String getToolTip()

Display the text as a tooltip for this component

Overrides:
getToolTip in class ImageComponentBase

setToolTip

public void setToolTip(java.lang.String toolTip)

Display the text as a tooltip for this component

Overrides:
setToolTip in class ImageComponentBase
See Also:
getToolTip()

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 ImageComponentBase

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 ImageComponentBase
See Also:
isVisible()

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 ImageComponentBase

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 ImageComponentBase
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD