config

Table of Contents

Overview

You can use the icecore:config tag provided by ICEfaces to adjust behaviour on a per-page basis. These page-level settings take precedence over corresponding application global settings specified via context-param entries in the web.xml.

Getting Started

To use the icecore:config tag, first declare the core namespace:

<html ... xmlns:icecore="http://www.icefaces.org/icefaces/core">

Then add the icecore:config tag to your page markup, setting the desired attributes:

<h:body>
    <icecore:config />
    ...

Attributes

blockUIOnSubmit (since ICEfaces 2.0) Allows control of extra form submissions (double-submits) on a per-page basis. Setting blockUIOnSubmit to true tells ICEfaces that the user interface (UI) should block any subsequent requests until the current request has been processed. By using this setting in conjunction with the application-scoped org.icefaces.blockUIOnSubmit context parameter, you can control the lazy activation of Ajax Push on a per-page basis. See blockUIOnSubmit for additional details.

    <h:body>
        <icecore:config blockUIOnSubmit="true|false"/>
        ...

lazyPush (since ICEfaces 3.0) Allows control of lazy Ajax Push activation on a per-page basis. By default, when ICEpush is available, the Ajax Push feature will only activate when the first push request is called. By using this setting in conjunction with the application-scoped org.icefaces.lazyPush context parameter, you can control the lazy activation of Ajax Push on a per-page basis. See lazyPush for additional details.

    <h:body>
        <icecore:config lazyPush="true|false"/>
        ...

mandatoryResource (since ICEfaces 3.0) A space-delimited list of components that will have their requisite resources pre-loaded on this page. The pre-loading allows the components to function correctly even if they are later added to the page dynamically. The values "none" (which is the default) and "all" are also valid. The value of this attribute on a page takes precedence over the values specified by the context parameter org.icefaces.mandatoryResourceConfiguration. See mandatoryResourceConfiguration for additional details.

    <h:body>
        <icecore:config mandatoryResource="all|none|(space delimited list of components)"/>
        ...
Since ICEfaces 4.0 the use of mandatoryResource for dynamically added components is no longer necessary, so long as "org.icefaces.generateHeadUpdate='true'" (default). Note that it may still be desirable to specify mandatoryResource for certain components in order to force their resources to be loaded at page-load time instead of dynamically when they are first rendered.

messagePersistence (since ICEfaces 3.0) Allows control of ICEfaces' message persistence feature on a per-page basis. By default, ICEfaces will persist FacesMessages across different partial submits from the same page. This setting can be used to disable this behavior on a per-page basis. See messagePersistence for additional details.

    <h:body>
        <icecore:config messagePersistence="true|false"/>
        ...

render (since ICEfaces 2.0) Allows control of DOM rendering on a per-page basis. By default, when ICEfaces is available, DOM rendering and partial page updates are enabled for stock JSF components. By using this setting in in conjunction with the application-scoped org.icefaces.render.auto context parameter, you can control whether or not ICEfaces is active on an individual page. See render.auto for additional details.

    <h:body>
        <icecore:config render="true|false"/>
        ...

subtreeDiff (since ICEfaces 3.0) Allows control of DOM diffing on a per-page basis. By default, when using ICEfaces, Ajax-specified subtree diffing is always done. By using this setting in in conjunction with the application-scoped org.icefaces.subtreeDiff context parameter, you can control whether or not ICEfaces is active on an individual page. See render.auto for additional details.

    <h:body>
        <icecore:config subtreeDiff="true|false"/>
        ...
Please note that this setting is likely to change or be removed in a future release.

diffConfig (since ICEfaces 3.0) Allows tuning of DOM diffing on a per-page basis by forcing the coalescing of the updates when they reach a defined maximum number. By default, when using ICEfaces, DOM diffing is done without any limit on the number of generated updates. By using this setting the application-scoped org.icefaces.domDiff context parameter will be overridden.

    <h:body>
        <icecore:config domDiff="maxDiff=500|debugAB"/>
        ...
Please note that this setting is likely to change or be removed in a future release.

focusManaged Allows control of focus retention on a per-page basis. By default, when using ICEfaces, focus retention is enabled. By using this setting the application-scoped org.icefaces.focusManaged context parameter will be overridden.

    <h:body>
        <icecore:config focusManaged="true|false"/>
        ...
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

© Copyright 2014 ICEsoft Technologies Canada Corp.