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.declaration;
21  
22  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
23  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
24  
25  public interface IsOmit {
26    /**
27     * Flag indicating that the action of this element, will not be executed from client side
28     * (e. g. when the user clicks a button.
29     * When setting this value to true, the action will not be executed by the Tobago, but it can executed
30     * by JavaScript.
31     * This attribute is useful, when you want to add JavaScript event handlers to commands manually.
32     * In this case you usually don't want a submit with a full reload of the page.
33     */
34    @TagAttribute()
35    @UIComponentTagAttribute(type = "boolean", defaultValue = "false")
36    void setOmit(String omit);
37  }