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  package javax.faces.component;
20  
21  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFComponent;
22  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFProperty;
23  
24  /**
25   * This tag associates a parameter name-value pair with the nearest
26   * parent UIComponent. A UIComponent is created to represent this
27   * name-value pair, and stored as a child of the parent component; what
28   * effect this has depends upon the renderer of that parent component.
29   * <p>
30   * Unless otherwise specified, all attributes accept static values
31   * or EL expressions.
32   * </p>
33   */
34  @JSFComponent
35  (clazz = "javax.faces.component.UIParameter",template=true,
36  name = "f:param",
37  tagClass="org.apache.myfaces.taglib.core.ParamTag")
38  abstract class _UIParameter extends UIComponentBase
39  {
40  
41    static public final String COMPONENT_FAMILY =
42      "javax.faces.Parameter";
43    static public final String COMPONENT_TYPE =
44      "javax.faces.Parameter";
45  
46    /**
47     * Disable this property; although this class extends a base-class that
48     * defines a read/write rendered property, this particular subclass
49     * does not support setting it. Yes, this is broken OO design: direct
50     * all complaints to the JSF spec group.
51     */
52    @JSFProperty(tagExcluded=true)
53    public void setRendered(boolean state) {
54        super.setRendered(state);
55        //call parent method due TCK problems
56        //throw new UnsupportedOperationException();
57    }
58    
59    /**
60     * The value of this component.
61     *
62     * @return  the new value value
63     */
64    @JSFProperty
65    public abstract Object getValue();
66  
67    /**
68     * The name under which the value is stored.
69     *
70     * @return  the new name value
71     */
72    @JSFProperty
73    public abstract String getName();
74  
75  }