blob: 06c426d31dd6820d528940964dc71464a639eabf [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<ui:composition xmlns="http://www.w3.org/1999/xhtml"
xmlns:ui="http://java.sun.com/jsf/facelets"
xmlns:tr="http://myfaces.apache.org/trinidad">
The progress is tracked from the org.apache.myfaces.trinidad.model.BoundedRangeModel
attached to this component through its 'value' attribute. The progressIndicator element goes to an indeterminate
mode and shows up as a spinner animation if the 'value' or 'maximum' from the BoundedRangeModel is unknown.
When these gets known the component switches to a determinate mode and renders a progress bar indicating
percentage of task completion. Once the task is complete, ActionEvent is queued and, the page indicated by
outcome of 'action' attribute is navigated to.
<br/>
<tr:outputText value="The progressIndicator component needs to have a poll component from the page as a partial
trigger, in order that it be updated at regular intervals in PPR mode as determined by the pollInterval from the
poll component. "/>
</ui:composition>