View Javadoc

1   // WARNING: This file was automatically generated. Do not edit it directly,
2   //          or you will lose your changes.
3   
4   /*
5    * Licensed to the Apache Software Foundation (ASF) under one
6    * or more contributor license agreements.  See the NOTICE file
7    * distributed with this work for additional information
8    * regarding copyright ownership.  The ASF licenses this file
9    * to you under the Apache License, Version 2.0 (the
10   * "License"); you may not use this file except in compliance
11   * with the License.  You may obtain a copy of the License at
12   *
13   *   http://www.apache.org/licenses/LICENSE-2.0
14   *
15   * Unless required by applicable law or agreed to in writing,
16   * software distributed under the License is distributed on an
17   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18   * KIND, either express or implied.  See the License for the
19   * specific language governing permissions and limitations
20   * under the License.
21  */
22  package org.apache.myfaces.trinidad.component;
23  
24  import org.apache.myfaces.trinidad.bean.FacesBean;
25  import org.apache.myfaces.trinidad.bean.PropertyKey;
26  import org.apache.myfaces.trinidad.util.ComponentUtils;
27  
28  /**
29   *
30   * <h4>Events:</h4>
31   * <table border="1" width="100%" cellpadding="3" summary="">
32   * <tr bgcolor="#CCCCFF" class="TableHeadingColor">
33   * <th align="left">Type</th>
34   * <th align="left">Phases</th>
35   * <th align="left">Description</th>
36   * </tr>
37   * <tr class="TableRowColor">
38   * <td valign="top"><code>org.apache.myfaces.trinidad.event.AttributeChangeEvent</code></td>
39   * <td valign="top" nowrap>Invoke<br>Application<br>Apply<br>Request<br>Values</td>
40   * <td valign="top">Event delivered to describe an attribute change.  Attribute change events are not delivered for any programmatic change to a property.  They are only delivered when a renderer changes a property without the application's specific request.  An example of an attribute change event might include the width of a column that supported client-side resizing.</td>
41   * </tr>
42   * </table>
43   */
44  public class UIXMessage extends UIXComponentBase
45  {
46    static public final FacesBean.Type TYPE = new FacesBean.Type(
47      UIXComponentBase.TYPE);
48    static public final PropertyKey FOR_KEY =
49      TYPE.registerKey("for", String.class);
50  
51    static public final String COMPONENT_FAMILY =
52      "org.apache.myfaces.trinidad.Message";
53    static public final String COMPONENT_TYPE =
54      "org.apache.myfaces.trinidad.Message";
55  
56    /**
57     * Construct an instance of the UIXMessage.
58     */
59    public UIXMessage()
60    {
61      super("org.apache.myfaces.trinidad.Message");
62    }
63  
64    /**
65     * Gets the relative ID from this component to the component whose messages will be displayed
66     *
67     * @return  the new for value
68     */
69    final public String getFor()
70    {
71      return ComponentUtils.resolveString(getProperty(FOR_KEY));
72    }
73  
74    /**
75     * Sets the relative ID from this component to the component whose messages will be displayed
76     * 
77     * @param forParam  the new for value
78     */
79    final public void setFor(String forParam)
80    {
81      setProperty(FOR_KEY, (forParam));
82    }
83  
84    @Override
85    public String getFamily()
86    {
87      return COMPONENT_FAMILY;
88    }
89  
90    @Override
91    protected FacesBean.Type getBeanType()
92    {
93      return TYPE;
94    }
95  
96    /**
97     * Construct an instance of the UIXMessage.
98     */
99    protected UIXMessage(
100     String rendererType
101     )
102   {
103     super(rendererType);
104   }
105 
106   static
107   {
108     TYPE.lockAndRegister("org.apache.myfaces.trinidad.Message","org.apache.myfaces.trinidad.Message");
109   }
110 }