ICEfaces-EE ACE Components
Tag submitMonitor


Monitors submits to the server, and indicates the status of the submits, server and network connection, and session validity. Examples of supported submit methods are: components doing full form submits, singleSubmit(s) such as via icecore:singleSubmit, partialSubmit(s) by ice: components, f:ajax submits by h: components, ace:ajax submits by ace: components, and direct use of ICEfaces javascript submit APIs. Supports configurable text labels and image state indicators, or facets for a fully configurable UI. Optionally uses an overlay for UI blocking during submits. Can be set to monitor a portion of the page, in tandem with other submitMonitors each monitoring their own distinct portions.

For more information, see the SubmitMonitor Wiki Documentation.


Facets
idleAllows rendering of nested components as label for idle state.
activeAllows rendering of nested components as label for active state.
serverErrorAllows rendering of nested components as label for serverError state.
networkErrorAllows rendering of nested components as label for networkError state.
sessionExpiredAllows rendering of nested components as label for sessionExpired state.



Tag Information
Tag Classorg.icefaces.ace.component.submitmonitor.SubmitMonitorTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
activeLabelnotruejava.lang.StringLabel to be displayed on the submitMonitor while a submit is in progress.
autoCenternotruejava.lang.BooleanWhen blockUI is enabled, and this property is true, the submitMonitor will display centered over the translucent overlay. Default = 'true'.
bindingnotruejavax.el.ValueExpressionUsing an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
blockUInotruejava.lang.StringWhen enabled, display a translucent overlay on a portion of the window, and only show the submitMonitor UI when the connection is not idle and a submit is underway. This property specifies on what portion of the window to show the overlay: "@all" means the whole document body, "@source" means only over the component that originated the request, or a for style component search string may be given to specify a component. Finally, "@none" means to disable the overlay and have the submitMonitor UI always present where it has been placed in the page. Default = '@all'.
fornotruejava.lang.StringSpecify space separated list of components, by their for property format search strings, so that those components and, recursively, all of their children, will be monitored by this component when they act as the source for submits. When this property is empty or unspecified, this component will monitor all submits from all sources. This property allows for different submitMonitor components to co-exist on a page, and each monitor different, non-overlapping, regions of the page, and be shown with their own unique labels etc.
idnotruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
idleLabelnotruejava.lang.StringLabel to be displayed on the submitMonitor when no submit is in progress. This is only shown if blockUI="@none", since with the popup cases, the submitMonitor is not shown when idle.
networkErrorLabelnotruejava.lang.StringLabel to be displayed on the submitMonitor when there is a network error.
preloadnotruejava.lang.BooleanWhen using images to indicate a server or network error, they may need to be preloaded while the server is still accessible. This preloads theme images when facets are not used. Default = 'true'.
renderednotruebooleanReturn true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
serverErrorLabelnotruejava.lang.StringLabel to be displayed on the submitMonitor when there is a server error.
sessionExpiredLabelnotruejava.lang.StringLabel to be displayed on the submitMonitor when the session is expired.
styleClassnotruejava.lang.StringStyle class of the container element.

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.