ICEfaces ICE Components 3.3.0
Java API Documentation

com.icesoft.faces.component.outputconnectionstatus
Class OutputConnectionStatus

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIPanel
              extended by javax.faces.component.html.HtmlPanelGroup
                  extended by com.icesoft.faces.component.outputconnectionstatus.OutputConnectionStatus
All Implemented Interfaces:
java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class OutputConnectionStatus
extends javax.faces.component.html.HtmlPanelGroup

OutputConnectionStatus is a JSF component class representing an ICEfaces output connection status state indicator.

This component extends the JSF HtmlPanelGroup component.

By default the OutputConnectionStatus is rendered by the "com.icesoft.faces.OutputConnectionStatusRenderer" renderer type.


Nested Class Summary
 
Nested classes/interfaces inherited from class javax.faces.component.html.HtmlPanelGroup
javax.faces.component.html.HtmlPanelGroup.PropertyKeys
 
Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String RENDERER_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
 
Constructor Summary
OutputConnectionStatus()
           
 
Method Summary
 java.lang.String getActiveClass()
          Return the value of the activeClass property.
 java.lang.String getActiveLabel()
          Return the value of the activeLabel property.
 java.lang.String getCautionClass()
          Return the value of the cautionClass property.
 java.lang.String getCautionLabel()
          Return the value of the cautionLabel property.
 java.lang.String getComponentType()
          Return the value of the COMPONENT_TYPE of this component.
 java.lang.String getDisconnectedClass()
          Return the value of the disconnectedClass property.
 java.lang.String getDisconnectedLabel()
          Return the value of the disconnectedLabel property.
 java.lang.String getFamily()
          Return the value of the COMPONENT_FAMILY of this component.
 java.lang.String getInactiveClass()
          Return the value of the inactiveClass property.
 java.lang.String getInactiveLabel()
          Return the value of the inactiveLabel property.
 java.lang.String getRenderedOnUserRole()
          Return the value of the renderedOnUserRole property.
 java.lang.String getRendererType()
          Return the value of the RENDERER_TYPE of this component.
 java.lang.String getStyle()
          Return the value of the style property.
 java.lang.String getStyleClass()
          Return the value of the styleClass property.
 boolean isDisplayHourglassWhenActive()
           
 boolean isRendered()
          Return the value of the rendered property.
 boolean isShowPopupOnDisconnect()
           
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
          Perform any processing required to restore the state from the entries in the state Object.
 java.lang.Object saveState(javax.faces.context.FacesContext context)
          Gets the state of the instance as a Serializable Object.
 void setActiveLabel(java.lang.String activeLabel)
          Set the value of the activeLabel property.
 void setCautionLabel(java.lang.String cautionLabel)
          Set the value of the cautionLabel property.
 void setDisconnectedLabel(java.lang.String disconnectedLabel)
          Set the value of the disconnectedLabel property.
 void setDisplayHourglassWhenActive(boolean displayHourglassWhenActive)
           
 void setInactiveLabel(java.lang.String inactiveLabel)
          Set the value of the inactiveLabel property.
 void setRenderedOnUserRole(java.lang.String renderedOnUserRole)
          Set the value of the renderedOnUserRole property.
 void setShowPopupOnDisconnect(boolean showPopupOnDisconnect)
           
 void setStyle(java.lang.String style)
          Set the value of the style property.
 void setStyleClass(java.lang.String styleClass)
          Set the value of the styleClass property.
 
Methods inherited from class javax.faces.component.html.HtmlPanelGroup
getLayout, setLayout
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values
Constructor Detail

OutputConnectionStatus

public OutputConnectionStatus()
Method Detail

getFamily

public java.lang.String getFamily()

Return the value of the COMPONENT_FAMILY of this component.

Overrides:
getFamily in class javax.faces.component.UIPanel

getRendererType

public java.lang.String getRendererType()

Return the value of the RENDERER_TYPE of this component.

Overrides:
getRendererType in class javax.faces.component.UIComponentBase

getComponentType

public java.lang.String getComponentType()

Return the value of the COMPONENT_TYPE of this component.


getActiveClass

public java.lang.String getActiveClass()

Return the value of the activeClass property.


setActiveLabel

public void setActiveLabel(java.lang.String activeLabel)

Set the value of the activeLabel property.


getActiveLabel

public java.lang.String getActiveLabel()

Return the value of the activeLabel property.


getCautionClass

public java.lang.String getCautionClass()

Return the value of the cautionClass property.


setCautionLabel

public void setCautionLabel(java.lang.String cautionLabel)

Set the value of the cautionLabel property.


getCautionLabel

public java.lang.String getCautionLabel()

Return the value of the cautionLabel property.


getDisconnectedClass

public java.lang.String getDisconnectedClass()

Return the value of the disconnectedClass property.


setDisconnectedLabel

public void setDisconnectedLabel(java.lang.String disconnectedLabel)

Set the value of the disconnectedLabel property.


getDisconnectedLabel

public java.lang.String getDisconnectedLabel()

Return the value of the disconnectedLabel property.


getInactiveClass

public java.lang.String getInactiveClass()

Return the value of the inactiveClass property.


setInactiveLabel

public void setInactiveLabel(java.lang.String inactiveLabel)

Set the value of the inactiveLabel property.


getInactiveLabel

public java.lang.String getInactiveLabel()

Return the value of the inactiveLabel property.


setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Overrides:
setStyle in class javax.faces.component.html.HtmlPanelGroup

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Overrides:
getStyle in class javax.faces.component.html.HtmlPanelGroup

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Overrides:
setStyleClass in class javax.faces.component.html.HtmlPanelGroup

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Overrides:
getStyleClass in class javax.faces.component.html.HtmlPanelGroup

setRenderedOnUserRole

public void setRenderedOnUserRole(java.lang.String renderedOnUserRole)

Set the value of the renderedOnUserRole property.


getRenderedOnUserRole

public java.lang.String getRenderedOnUserRole()

Return the value of the renderedOnUserRole property.


isRendered

public boolean isRendered()

Return the value of the rendered property.

Overrides:
isRendered in class javax.faces.component.UIComponentBase

saveState

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

Gets the state of the instance as a Serializable Object.

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

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)

Perform any processing required to restore the state from the entries in the state Object.

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

isShowPopupOnDisconnect

public boolean isShowPopupOnDisconnect()

setShowPopupOnDisconnect

public void setShowPopupOnDisconnect(boolean showPopupOnDisconnect)

isDisplayHourglassWhenActive

public boolean isDisplayHourglassWhenActive()

setDisplayHourglassWhenActive

public void setDisplayHourglassWhenActive(boolean displayHourglassWhenActive)

ICEfaces ICE Components 3.3.0
Java API Documentation

Copyright 2013 ICEsoft Technologies Canada Corp., All Rights Reserved.