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.BodyContentDescription;
23  import org.apache.myfaces.tobago.apt.annotation.DynamicExpression;
24  import org.apache.myfaces.tobago.apt.annotation.Tag;
25  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
26  import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
27  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
28  import org.apache.myfaces.tobago.component.RendererTypes;
29  import org.apache.myfaces.tobago.internal.taglib.declaration.HasCurrentMarkup;
30  import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
31  import org.apache.myfaces.tobago.internal.taglib.declaration.HasMarkup;
32  import org.apache.myfaces.tobago.internal.taglib.declaration.IsGridLayoutComponent;
33  import org.apache.myfaces.tobago.internal.taglib.declaration.IsGridLayoutContainer;
34  
35  import javax.faces.component.UIPanel;
36  
37  // XXX check if JSP will be supported for the wizard
38  
39  /**
40   * Renders a flexible wizard.
41   */
42  @Tag(name = "wizard")
43  @BodyContentDescription(anyTagOf = "facestag")
44  @UIComponentTag(
45      uiComponent = "org.apache.myfaces.tobago.component.UIWizard",
46      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUIWizard",
47      uiComponentFacesClass = "javax.faces.component.UIPanel",
48      componentFamily = UIPanel.COMPONENT_FAMILY,
49      rendererType = RendererTypes.WIZARD)
50  public interface WizardTagDeclaration 
51      extends HasIdBindingAndRendered, IsGridLayoutComponent, IsGridLayoutContainer, HasMarkup, HasCurrentMarkup {
52  
53    @TagAttribute(required = true)
54    @UIComponentTagAttribute(type = "org.apache.myfaces.tobago.model.Wizard",
55        expression = DynamicExpression.VALUE_EXPRESSION_REQUIRED)
56    void setController(String controller);
57  
58    /**
59     * Name of a request-scope attribute under which the model data will be exposed.
60     */
61    @TagAttribute(required = true)
62    @UIComponentTagAttribute(expression = DynamicExpression.PROHIBITED)
63    void setVar(String var);
64  
65    /**
66     * Outcome to navigate to this page.
67     */
68    @TagAttribute(required = true)
69    @UIComponentTagAttribute(expression = DynamicExpression.PROHIBITED)
70    void setOutcome(String outcome);
71  
72    /**
73     * Title of this page
74     */
75    @TagAttribute
76    @UIComponentTagAttribute
77    void setTitle(String title);
78  
79    /**
80     * Is a jump forward to following pages allowed?
81     */
82    @TagAttribute
83    @UIComponentTagAttribute(type = "boolean", defaultValue = "false")
84    void setAllowJumpForward(String allowJumpForward);
85  }