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.Markup;
23  import org.apache.myfaces.tobago.apt.annotation.Tag;
24  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
25  import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
26  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
27  import org.apache.myfaces.tobago.component.RendererTypes;
28  import org.apache.myfaces.tobago.internal.component.AbstractUIPopup;
29  import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
30  import org.apache.myfaces.tobago.internal.taglib.declaration.HasTip;
31  import org.apache.myfaces.tobago.internal.taglib.declaration.IsVisual;
32  import org.apache.myfaces.tobago.model.CollapseMode;
33  
34  /**
35   * Renders a popup panel.
36   */
37  @Tag(name = "popup")
38  @UIComponentTag(
39      uiComponent = "org.apache.myfaces.tobago.component.UIPopup",
40      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUIPopup",
41      uiComponentFacesClass = "javax.faces.component.UIPanel",
42      componentFamily = AbstractUIPopup.COMPONENT_FAMILY,
43      interfaces = {
44          // As long as no behavior event names are defined, ClientBehaviorHolder must be implemented for Majorra.
45          "javax.faces.component.behavior.ClientBehaviorHolder"
46      },
47      rendererType = RendererTypes.POPUP,
48      markups = {
49          @Markup(
50              name = "large",
51              description = "Large popup"
52          ),
53          @Markup(
54              name = "small",
55              description = "Small popup"
56          )
57      })
58  public interface PopupTagDeclaration
59      extends HasIdBindingAndRendered, IsVisual, HasTip {
60  
61    /**
62     * Indicating the collapsed state of this component.
63     */
64    @TagAttribute
65    @UIComponentTagAttribute(type = "boolean", defaultValue = "true")
66    void setCollapsed(String collapsed);
67  
68    @TagAttribute
69    @UIComponentTagAttribute(
70        type = "org.apache.myfaces.tobago.model.CollapseMode",
71        defaultValue = CollapseMode.ABSENT,
72        defaultCode = "org.apache.myfaces.tobago.model.CollapseMode.absent")
73    void setCollapsedMode(String collapsed);
74  }