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  @Tag(name = "reload")
32  @UIComponentTag(
33      uiComponent = "org.apache.myfaces.tobago.component.UIReload",
34      uiComponentFacesClass = "javax.faces.component.UIComponentBase",
35      componentFamily = "org.apache.myfaces.tobago.Reload",
36      allowedChildComponenents = "NONE")
37  public interface ReloadTagDeclaration extends HasIdBindingAndRendered {
38  
39  
40    /**
41     * Time in milliseconds after which the parent component is automatically reloaded.
42     */
43    @TagAttribute
44    @UIComponentTagAttribute(type = "java.lang.Integer", defaultValue = "5000")
45    void setFrequency(String frequency);
46  
47    /**
48     * Is update required.
49     */
50    @TagAttribute
51    @UIComponentTagAttribute(type = "boolean", defaultValue = "true")
52    void setUpdate(String update);
53  
54    /**
55     * Flag indicating that
56     * the update check should be performed
57     * immediately (that is, during Apply Request Values phase) rather than
58     * waiting until Render Response phase.
59     */
60    @TagAttribute
61    @UIComponentTagAttribute(type = "boolean", defaultValue = "true")
62    void setImmediate(String immediate);
63  }