Overview | Library | Tag | Help
| FRAMES NO FRAMES

## ICE Components
Tag outputConnectionStatus

The outputConnectionStatus component displays the information about the status of the network connection between the client browser and the server. The component displays one of 4 possible states, which are as follows.

1. Active: The connection is alive and there is a request pending.
2. Inactive: The connection is alive and there is no pending activity.
3. Caution: The connection request/response latency has exceeded the configured threshold. Indicates that asynchronous updates from the server may not be received in a timely manner.
4. Disconnected: The connection has been lost, either due to network or application error (session expiry, etc.).

The outputConnectionStatus component provides an ideal mechanism to provide continuous real-time feedback to users of the status of their ICEfaces application. It is particularly important to inform users when the application is busy sending and receiving data in response to a user-initiated action to manage their expectations with respect to application readiness for additional user input. Generally, the outputConnectionStatus component should be located in a consistent location throughout an ICEfaces application.

NOTE: A web-page may only contain a single outputConnectionStatus component. Using more than one outputConnectionStatus component on the same web page will result in erratic results.

Tag Information
Tag Class | com.icesoft.faces.component.outputconnectionstatus.OutputConnectionStatusTag
TagExtraInfo Class | None
Body Content | JSP
Display Name | None

Attributes
Name | Required | Request-time | Type | Description
activeLabel | false | false | `java.lang.String` | The connection status component would show this label, when The connection is alive and there is a request pending.
binding | false | false | `java.lang.String` | The value binding expression linking this component to a property in a backing bean
cautionLabel | false | false | `java.lang.String` | The connection status component would show this label, when The connection state is unknown as a heartbeat ping has not been acknowledged. However, connection recovery activities are in progress which will change the state to either "Connected" or "Disconnected" status.
disconnectedLabel | false | false | `java.lang.String` | The connection status component would show this label, when The connection has been lost, either due to network error or the application session expiring.
displayHourglassWhenActive | false | false | `java.lang.String` | Whether to render hour-glass pointer together with the element corresponding to busy state.
id | false | false | `java.lang.String` | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
inactiveLabel | false | false | `java.lang.String` | The connection status component would show this label, when the connection is alive and there is no pending activity.
layout | false | false | `java.lang.String` | The type of layout markup to use when rendering this group. If the value is "block" the renderer must produce an HTML "div" element. Otherwise HTML "span" element must be produced.
rendered | false | false | `java.lang.String` | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
renderedOnUserRole | false | false | `java.lang.String` | If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.
showPopupOnDisconnect | false | false | `java.lang.String` | Whether to popup a reload dialog when connection is lost: true or false (default).
style | false | false | `java.lang.String` | CSS style(s) to be applied when this component is rendered.
styleClass | false | false | `java.lang.String` | Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup. Defines the base class name for all style classes. Default value is iceOutConStat iceOutConStat iceOutConStatInactv iceOutConStatActv iceOutConStatCaution iceOutConStatDisconnect

Variables
| No Variables Defined.

Overview | Library | Tag | Help
| FRAMES NO FRAMES

Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.