ICEfaces Tag Reference - Output Connection Status

Contents

10. ICEfaces Tag Reference

ice:outputConnectionStatus

The ice:outputConnectionStatus tag component displays the information about the status of the network connection between the client browser and the server. The component displays one of the 4 following possible states:

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. Of particularly importance is to inform users when the application is busy sending and receiving data in response to a user-initiated action in order 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.

Example

<ice:outputConnectionStatus></ice:outputConnectionStatus>

Rendered Output

Tag Attributes

activeLabel	Text

The activeLabel attribute sets the text that is displayed when the connection is alive and a request is pending.

binding	Expression

The value-binding expression linking this component tag to a backing bean property.

cautionLabel	Text

The cautionLabel attribute sets the text that is displayed when the connection state is unknown because a heartbeat ping has not been acknowleged and connection recovery activities, which will change the state to either "Connected" or "Disconnected" status, are in progress.

disconnectedLabel	Text

The disconnectedLabel attribute sets the text that is displayed when the connection has been lost, either due to network error or the application session expiring.

id	Text

The unique identifier value for this component. The value must be unique within the closest naming container.

inactiveLabel	Text

The inactiveLabel attribute sets the text that is displayed when the connection is alive and there is no pending activity.

rendered	Boolean

A value-binding expression that evaluates to a Boolean condition indicating if this component should be rendered.

renderedOnUserRole	Text

The renderedOnUserRole attribute is a boolean flag that when set to "true" and if a role has been configured for the user, then the component will be displayed. If the user does not have a role, then the component will not be displayed.

style	CSS Style

The style attribute sets the CSS style definition to be applied to this component when it is rendered.

styleClass	CSS Class

The styleClass attribute sets the CSS class to apply to this component when it is rendered.