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.Tag;
23  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
24  import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
25  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
26  import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
27  
28  /**
29   * Update the parent component
30   *
31   * ********************* <br/>
32   * WARNING <br/>
33   * ********************* <br/>
34   * This feature is preliminary and may be subject of change in later versions!  <br/>
35   */
36  @Tag(name = "reload")
37  @UIComponentTag(
38      uiComponent = "org.apache.myfaces.tobago.component.UIReload",
39      componentFamily = "org.apache.myfaces.tobago.Reload",
40      allowedChildComponenents = "NONE")
41  public interface ReloadTagDeclaration extends HasIdBindingAndRendered {
42  
43  
44    /**
45     * Time in milliseconds after which the parent component is automatically reloaded.
46     */
47    @TagAttribute
48    @UIComponentTagAttribute(type = "java.lang.Integer", defaultValue = "5000")
49    void setFrequency(String frequency);
50  
51    /**
52     * Is update required.
53     */
54    @TagAttribute
55    @UIComponentTagAttribute(type = "boolean", defaultValue = "true")
56    void setUpdate(String update);
57  
58    /**
59     * Flag indicating that
60     * the update check should be performed
61     * immediately (that is, during Apply Request Values phase) rather than
62     * waiting until Render Response phase.
63     */
64    @TagAttribute
65    @UIComponentTagAttribute(type = "boolean", defaultValue = "true")
66    void setImmediate(String immediate);
67  }