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.Facet;
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.Facets;
28  import org.apache.myfaces.tobago.component.RendererTypes;
29  import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
30  import org.apache.myfaces.tobago.internal.taglib.declaration.IsVisual;
31  
32  import javax.faces.component.UIPanel;
33  
34  /**
35   * Renders a popup panel.
36   * The popup gets a grid layout manager with columns="auto" and rows="auto" as definition.
37   * So a popup should contain only one layout component.
38   * The default layout manager can be overwritten with the layout facet.
39   */
40  @Tag(name = "popup")
41  @UIComponentTag(
42      uiComponent = "org.apache.myfaces.tobago.component.UIPopup",
43      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUIPopup",
44      uiComponentFacesClass = "javax.faces.component.UIPanel",
45      componentFamily = UIPanel.COMPONENT_FAMILY,
46      rendererType = RendererTypes.POPUP,
47      facets = {
48          @Facet(name = Facets.LAYOUT, description = "Deprecated. Contains an layout manager. "
49              + "The layout manager tag should surround the content instead.")}
50  )
51  public interface PopupTagDeclaration
52      extends HasIdBindingAndRendered, IsVisual {
53  
54    /**
55     * The rest of the page will be faded off for the time the popup is displayed.
56     * <br>
57     * XXX Currently (since 3.0 branch) non-modal is not supported.
58     */
59    @TagAttribute
60    @UIComponentTagAttribute(type = "boolean", defaultValue = "true")
61    void setModal(String modal);
62  
63  }