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