com.sun.webui.jsf.component
Class AlarmStatus

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by com.sun.webui.jsf.component.WebuiCommand
                  extended by com.sun.webui.jsf.component.Hyperlink
                      extended by com.sun.webui.jsf.component.ImageHyperlink
                          extended by com.sun.webui.jsf.component.AlarmStatus
All Implemented Interfaces:
com.sun.webui.jsf.component.ComplexComponent, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.NamingContainer, javax.faces.component.StateHolder

Deprecated. See tld documentation for more information on how to create alarmStatus without using the alarmStatus component.

public class AlarmStatus
extends ImageHyperlink

The AlarmStatus component is used to display alarm information in the Masthead component.


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
AlarmStatus()
          Deprecated. Creates a new instance of AlarmStatus
 
Method Summary
 java.lang.String getCriticalIcon()
          Deprecated. The key identifier for the theme image to use for the critical alarms icon.
 java.lang.String getDownIcon()
          Deprecated. The key identifier for the theme image to use for the down alarms icon.
 java.lang.String getFamily()
          Deprecated. Return the family for this component.
 java.lang.String getIcon()
          Deprecated. The identifier of the desired theme image.
 java.lang.String getMajorIcon()
          Deprecated. The key identifier for the theme image to use for the major alarms icon.
 java.lang.String getMinorIcon()
          Deprecated. The key identifier for the theme image to use for the minor alarms icon.
 int getNumCriticalAlarms()
          Deprecated. The number of critical alarms, to display next to the appropriate icon.
 int getNumDownAlarms()
          Deprecated. The number of down alarms, to display next to the appropriate icon.
 int getNumMajorAlarms()
          Deprecated. The number of major alarms, can be displayed next to the appropriate icon.
 int getNumMinorAlarms()
          Deprecated. The number of minor alarms that can be displayed next to the appropriate icon.
 java.lang.String getOnDblClick()
          Deprecated. Scripting code that is executed when a mouse double-click occurs over this component.
 java.lang.String getStyle()
          Deprecated. CSS style or styles to be applied to the outermost HTML element when this component is rendered.
 java.lang.String getStyleClass()
          Deprecated. CSS style class or classes to be applied to the outermost HTML element when this component is rendered.
 java.lang.String getTextPosition()
          Deprecated. Specifies where the text will be placed relative to the image.
 java.lang.Object getValue()
          Deprecated. The current value of this component.
 boolean isCriticalAlarms()
          Deprecated. Specifies if the critical alarm count should be displayed.
 boolean isDownAlarms()
          Deprecated. Specifies if the down alarm count should be displayed.
 boolean isMajorAlarms()
          Deprecated. Specify if the major alarm count should be displayed.
 boolean isMinorAlarms()
          Deprecated. Specifies if the minor alarm count should be displayed.
 boolean isVisible()
          Deprecated. Indicates 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)
          Deprecated. Restore the state of this component.
 java.lang.Object saveState(javax.faces.context.FacesContext _context)
          Deprecated. Save the state of this component.
 void setCriticalAlarms(boolean criticalAlarms)
          Deprecated. Specifies if the critical alarm count should be displayed.
 void setCriticalIcon(java.lang.String criticalIcon)
          Deprecated. The key identifier for the theme image to use for the critical alarms icon.
 void setDownAlarms(boolean downAlarms)
          Deprecated. Specifies if the down alarm count should be displayed.
 void setDownIcon(java.lang.String downIcon)
          Deprecated. The key identifier for the theme image to use for the down alarms icon.
 void setMajorAlarms(boolean majorAlarms)
          Deprecated. Specify if the major alarm count should be displayed.
 void setMajorIcon(java.lang.String majorIcon)
          Deprecated. The key identifier for the theme image to use for the major alarms icon.
 void setMinorAlarms(boolean minorAlarms)
          Deprecated. Specifies if the minor alarm count should be displayed.
 void setMinorIcon(java.lang.String minorIcon)
          Deprecated. The key identifier for the theme image to use for the minor alarms icon.
 void setNumCriticalAlarms(int numCriticalAlarms)
          Deprecated. The number of critical alarms, to display next to the appropriate icon.
 void setNumDownAlarms(int numDownAlarms)
          Deprecated. The number of down alarms, to display next to the appropriate icon.
 void setNumMajorAlarms(int numMajorAlarms)
          Deprecated. The number of major alarms, can be displayed next to the appropriate icon.
 void setNumMinorAlarms(int numMinorAlarms)
          Deprecated. The number of minor alarms that can be displayed next to the appropriate icon./p>
 void setStyle(java.lang.String style)
          Deprecated. CSS style or styles to be applied to the outermost HTML element when this component is rendered.
 void setStyleClass(java.lang.String styleClass)
          Deprecated. CSS style class or classes to be applied to the outermost HTML element when this component is rendered.
 void setVisible(boolean visible)
          Deprecated. Indicates whether the component should be viewable by the user in the rendered HTML page.
 
Methods inherited from class com.sun.webui.jsf.component.ImageHyperlink
getAlign, getAlt, getBorder, getHeight, getHspace, getImageFacet, getImageURL, getRendererType, getVspace, getWidth, setAlign, setAlt, setBorder, setHeight, setHspace, setIcon, setImageURL, setTextPosition, setVspace, setWidth
 
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, getTabIndex, getTarget, getText, getToolTip, getType, getUrl, getUrlLang, getValueExpression, isDisabled, setDisabled, setHtmlTemplate, setOnBlur, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setShape, 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

AlarmStatus

public AlarmStatus()
Deprecated. 
Creates a new instance of AlarmStatus

Method Detail

getFamily

public java.lang.String getFamily()
Deprecated. 

Return the family for this component.

Overrides:
getFamily in class ImageHyperlink

getOnDblClick

public java.lang.String getOnDblClick()
Deprecated. 
Scripting code that is executed when a mouse double-click occurs over this component.

Overrides:
getOnDblClick in class ImageHyperlink

getValue

public java.lang.Object getValue()
Deprecated. 
The current value of this component.

Overrides:
getValue in class Hyperlink

getTextPosition

public java.lang.String getTextPosition()
Deprecated. 
Description copied from class: ImageHyperlink

Specifies where the text will be placed relative to the image. The valid values currently are "right" or "left".

Overrides:
getTextPosition in class ImageHyperlink

getIcon

public java.lang.String getIcon()
Deprecated. 
Description copied from class: ImageHyperlink

The identifier of the desired theme image.

Overrides:
getIcon in class ImageHyperlink

isCriticalAlarms

public boolean isCriticalAlarms()
Deprecated. 

Specifies if the critical alarm count should be displayed. Is false to prevent display of critical alarm count and icon.


setCriticalAlarms

public void setCriticalAlarms(boolean criticalAlarms)
Deprecated. 

Specifies if the critical alarm count should be displayed. Is false to prevent display of critical alarm count and icon.

See Also:
isCriticalAlarms()

getCriticalIcon

public java.lang.String getCriticalIcon()
Deprecated. 

The key identifier for the theme image to use for the critical alarms icon.


setCriticalIcon

public void setCriticalIcon(java.lang.String criticalIcon)
Deprecated. 

The key identifier for the theme image to use for the critical alarms icon.

See Also:
getCriticalIcon()

isDownAlarms

public boolean isDownAlarms()
Deprecated. 

Specifies if the down alarm count should be displayed. Is false to prevent display of down alarm count and icon.


setDownAlarms

public void setDownAlarms(boolean downAlarms)
Deprecated. 

Specifies if the down alarm count should be displayed. Is false to prevent display of down alarm count and icon.

See Also:
isDownAlarms()

getDownIcon

public java.lang.String getDownIcon()
Deprecated. 

The key identifier for the theme image to use for the down alarms icon.


setDownIcon

public void setDownIcon(java.lang.String downIcon)
Deprecated. 

The key identifier for the theme image to use for the down alarms icon.

See Also:
getDownIcon()

isMajorAlarms

public boolean isMajorAlarms()
Deprecated. 

Specify if the major alarm count should be displayed. Set to false to prevent display of minor alarm count and icon.


setMajorAlarms

public void setMajorAlarms(boolean majorAlarms)
Deprecated. 

Specify if the major alarm count should be displayed. Set to false to prevent display of minor alarm count and icon.

See Also:
isMajorAlarms()

getMajorIcon

public java.lang.String getMajorIcon()
Deprecated. 

The key identifier for the theme image to use for the major alarms icon.


setMajorIcon

public void setMajorIcon(java.lang.String majorIcon)
Deprecated. 

The key identifier for the theme image to use for the major alarms icon.

See Also:
getMajorIcon()

isMinorAlarms

public boolean isMinorAlarms()
Deprecated. 

Specifies if the minor alarm count should be displayed. Is false to prevent display of minor alarm count and icon.


setMinorAlarms

public void setMinorAlarms(boolean minorAlarms)
Deprecated. 

Specifies if the minor alarm count should be displayed. Is false to prevent display of minor alarm count and icon.

See Also:
isMinorAlarms()

getMinorIcon

public java.lang.String getMinorIcon()
Deprecated. 

The key identifier for the theme image to use for the minor alarms icon.


setMinorIcon

public void setMinorIcon(java.lang.String minorIcon)
Deprecated. 

The key identifier for the theme image to use for the minor alarms icon.

See Also:
getMinorIcon()

getNumCriticalAlarms

public int getNumCriticalAlarms()
Deprecated. 

The number of critical alarms, to display next to the appropriate icon.


setNumCriticalAlarms

public void setNumCriticalAlarms(int numCriticalAlarms)
Deprecated. 

The number of critical alarms, to display next to the appropriate icon.

See Also:
getNumCriticalAlarms()

getNumDownAlarms

public int getNumDownAlarms()
Deprecated. 

The number of down alarms, to display next to the appropriate icon.


setNumDownAlarms

public void setNumDownAlarms(int numDownAlarms)
Deprecated. 

The number of down alarms, to display next to the appropriate icon.

See Also:
getNumDownAlarms()

getNumMajorAlarms

public int getNumMajorAlarms()
Deprecated. 

The number of major alarms, can be displayed next to the appropriate icon.


setNumMajorAlarms

public void setNumMajorAlarms(int numMajorAlarms)
Deprecated. 

The number of major alarms, can be displayed next to the appropriate icon.

See Also:
getNumMajorAlarms()

getNumMinorAlarms

public int getNumMinorAlarms()
Deprecated. 

The number of minor alarms that can be displayed next to the appropriate icon.


setNumMinorAlarms

public void setNumMinorAlarms(int numMinorAlarms)
Deprecated. 

The number of minor alarms that can be displayed next to the appropriate icon./p>

See Also:
getNumMinorAlarms()

getStyle

public java.lang.String getStyle()
Deprecated. 

CSS style or styles to be applied to the outermost HTML element when this component is rendered.

Overrides:
getStyle in class Hyperlink

setStyle

public void setStyle(java.lang.String style)
Deprecated. 

CSS style or styles to be applied to the outermost HTML element when this component is rendered.

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

getStyleClass

public java.lang.String getStyleClass()
Deprecated. 

CSS style class or classes to be applied to the outermost HTML element when this component is rendered.

Overrides:
getStyleClass in class Hyperlink

setStyleClass

public void setStyleClass(java.lang.String styleClass)
Deprecated. 

CSS style class or classes to be applied to the outermost HTML element when this component is rendered.

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

isVisible

public boolean isVisible()
Deprecated. 

Indicates whether the component should be viewable by the user in the rendered HTML page. If false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, this setting is true, so HTML for the component HTML is included and visible to the user. If the AlarmStatus component is not visible, it can still be processed on subsequent form submissions because the HTML is present.

Overrides:
isVisible in class ImageHyperlink

setVisible

public void setVisible(boolean visible)
Deprecated. 

Indicates whether the component should be viewable by the user in the rendered HTML page. If false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, this setting is true, so HTML for the component HTML is included and visible to the user. If the AlarmStatus component is not visible, it can still be processed on subsequent form submissions because the HTML is present.

Overrides:
setVisible in class ImageHyperlink
See Also:
isVisible()

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)
Deprecated. 

Restore the state of this component.

Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class ImageHyperlink

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Deprecated. 

Save the state of this component.

Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class ImageHyperlink


Copyright © 2008 Sun Microsystems, Inc. All Rights Reserved.