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.core;
23  
24  import org.apache.myfaces.trinidad.bean.FacesBean;
25  import org.apache.myfaces.trinidad.bean.PropertyKey;
26  import org.apache.myfaces.trinidad.component.UIXComponentBase;
27  
28  /**
29   *
30   * The importScript component supports importing the built-in scripts
31   *           provided by Apache Trinidad.  It can be used to ensure that a Javascript
32   *           function is available before using it in a Javascript handler.
33   *           Only the first reference to a script will result in its
34   *           being imported.
35   *
36   * <h4>Events:</h4>
37   * <table border="1" width="100%" cellpadding="3" summary="">
38   * <tr bgcolor="#CCCCFF" class="TableHeadingColor">
39   * <th align="left">Type</th>
40   * <th align="left">Phases</th>
41   * <th align="left">Description</th>
42   * </tr>
43   * <tr class="TableRowColor">
44   * <td valign="top"><code>org.apache.myfaces.trinidad.event.AttributeChangeEvent</code></td>
45   * <td valign="top" nowrap>Invoke<br>Application<br>Apply<br>Request<br>Values</td>
46   * <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>
47   * </tr>
48   * </table>
49   */
50  public class CoreImportScript extends UIXComponentBase
51  {
52    static public final FacesBean.Type TYPE = new FacesBean.Type(
53      UIXComponentBase.TYPE);
54    static public final PropertyKey NAMES_KEY =
55      TYPE.registerKey("names", String[].class);
56  
57    static public final String COMPONENT_FAMILY =
58      "org.apache.myfaces.trinidad.ImportScript";
59    static public final String COMPONENT_TYPE =
60      "org.apache.myfaces.trinidad.CoreImportScript";
61  
62    /**
63     * Construct an instance of the CoreImportScript.
64     */
65    public CoreImportScript()
66    {
67      super("org.apache.myfaces.trinidad.ImportScript");
68    }
69  
70    /**
71     * Gets a series of function names
72     *
73     * @return  the new names value
74     */
75    final public String[] getNames()
76    {
77      return (String[])getProperty(NAMES_KEY);
78    }
79  
80    /**
81     * Sets a series of function names
82     * 
83     * @param names  the new names value
84     */
85    final public void setNames(String[] names)
86    {
87      setProperty(NAMES_KEY, (names));
88    }
89  
90    @Override
91    public String getFamily()
92    {
93      return COMPONENT_FAMILY;
94    }
95  
96    @Override
97    protected FacesBean.Type getBeanType()
98    {
99      return TYPE;
100   }
101 
102   /**
103    * Construct an instance of the CoreImportScript.
104    */
105   protected CoreImportScript(
106     String rendererType
107     )
108   {
109     super(rendererType);
110   }
111 
112   static
113   {
114     TYPE.lockAndRegister("org.apache.myfaces.trinidad.ImportScript","org.apache.myfaces.trinidad.ImportScript");
115   }
116 }