View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  
20  package org.apache.myfaces.tobago.internal.taglib.component;
21  
22  import org.apache.myfaces.tobago.apt.annotation.DynamicExpression;
23  import org.apache.myfaces.tobago.apt.annotation.Facet;
24  import org.apache.myfaces.tobago.apt.annotation.Tag;
25  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
26  import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
27  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
28  import org.apache.myfaces.tobago.component.Facets;
29  import org.apache.myfaces.tobago.component.RendererTypes;
30  import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
31  import org.apache.myfaces.tobago.internal.taglib.declaration.HasTip;
32  import org.apache.myfaces.tobago.internal.taglib.declaration.IsVisual;
33  
34  import javax.faces.component.UIOutput;
35  
36  /**
37   * Renders a progress bar.
38   */
39  @Tag(name = "progress")
40  @UIComponentTag(
41      uiComponent = "org.apache.myfaces.tobago.component.UIProgress",
42      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUIProgress",
43      uiComponentFacesClass = "javax.faces.component.UIOutput",
44      componentFamily = UIOutput.COMPONENT_FAMILY,
45      rendererType = RendererTypes.PROGRESS,
46      allowedChildComponenents = "NONE",
47      facets = {@Facet(
48          name= Facets.COMPLETE,
49          description =
50              "Contains an instance of UICommand (tc:command). The action is invoked if the full progress has reached",
51          allowedChildComponenents = "org.apache.myfaces.tobago.Command")})
52          
53  public interface ProgressTagDeclaration extends HasIdBindingAndRendered, HasTip, IsVisual {
54  
55    /**
56     * The current value of this component. May be a java.lang.Number or a javax.swing.BoundedRangeModel
57     */
58    @TagAttribute
59    @UIComponentTagAttribute(
60        type = { "javax.swing.BoundedRangeModel", "java.lang.Double" },
61        expression = DynamicExpression.VALUE_EXPRESSION_REQUIRED)
62    void setValue(String value);
63  
64    /**
65     * The maximum of the value of the progress.
66     */
67    @TagAttribute
68    @UIComponentTagAttribute(
69        type = { "java.lang.Double" })
70    void setMax(String max);
71  }