001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *   http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    
020    package org.apache.myfaces.tobago.taglib.component;
021    
022    import org.apache.myfaces.tobago.apt.annotation.Tag;
023    import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
024    import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
025    import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
026    import org.apache.myfaces.tobago.taglib.decl.HasIdBindingAndRendered;
027    
028    /*
029     * Date: 28.05.2006
030     * Time: 22:31:38
031     */
032    
033    /**
034     * Update the parent component
035     */
036    
037    @Tag(name = "reload")
038    @UIComponentTag(
039        uiComponent = "org.apache.myfaces.tobago.component.UIReload")
040    public interface ReloadTagDeclaration extends TobagoTagDeclaration, HasIdBindingAndRendered {
041    
042    
043      /**
044       * Time in milliseconds after which the parent component is automaticaly reloaded.
045       */
046      @TagAttribute
047      @UIComponentTagAttribute(type = "java.lang.Integer", defaultValue = "5000")
048      void setFrequency(String frequency);
049    
050      /**
051       * Is update required.
052       */
053      @TagAttribute
054      @UIComponentTagAttribute(type = "java.lang.Boolean", defaultValue = "true")
055      void setUpdate(String update);
056    
057      /**
058       * Flag indicating that
059       * the update check should be performed
060       * immediately (that is, during Apply Request Values phase) rather than
061       * waiting until Render Response phase.
062       */
063      @TagAttribute
064      @UIComponentTagAttribute(type = "java.lang.Boolean", defaultValue = "false")
065      void setImmediate(String immediate);
066    }