ice
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 |
| id | false | false | java.lang.String | Every component may have an unique id. Automatically created if omitted. |
| rendered | false | false | java.lang.String | If false, this component will not be rendered. |
| style | false | false | java.lang.String |
CSS style(s) to be applied when this component is rendered.
|
| styleClass | false | false | java.lang.String |
Defines the base class name for all style classes used in outputConnectionStatus. Default value is iceOutConStat
- iceOutConStatInactive
- iceOutConStatActive
- iceOutConStatCaution
- iceOutConStatDisconnect
|
| 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.
|
| 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.
|
| 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 acknowleged.
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.
|
| Variables |
No Variables Defined. |
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.