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 package org.apache.myfaces.custom.panelstack;
20
21 import javax.faces.component.UIPanel;
22
23
24 /**
25 * A stack of panels, to switch panels dynamically.
26 *
27 * Manage a stack of JSF components and allow for one child component to be choosen for rendering. The behaviour
28 * is similar to the CardLayout of Java Swing. Property <code>selectedPanel</code> defines the id of the child
29 * to be rendered. If no child panel is selected or if the selected panel can not be found the first child is rendered.
30 *
31 * Unless otherwise specified, all attributes accept static values or EL expressions.
32 *
33 * @JSFComponent
34 * name = "t:panelStack"
35 * class = "org.apache.myfaces.custom.panelstack.HtmlPanelStack"
36 * tagClass = "org.apache.myfaces.custom.panelstack.PanelStackTag"
37 * @since 1.1.7
38 * @author <a href="mailto:oliver@rossmueller.com">Oliver Rossmueller</a>
39 * @version $Revision: 691856 $ $Date: 2008-09-03 21:40:30 -0500 (Wed, 03 Sep 2008) $
40 */
41 public abstract class AbstractHtmlPanelStack extends UIPanel
42 {
43
44 public static final String COMPONENT_TYPE = "org.apache.myfaces.HtmlPanelStack";
45 public static final String COMPONENT_FAMILY = "javax.faces.Panel";
46 private static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.PanelStack";
47
48 /**
49 * @JSFProperty
50 * required="true"
51 */
52 public abstract String getSelectedPanel();
53
54 }