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.output;
23
24 import org.apache.myfaces.trinidad.bean.FacesBean;
25 import org.apache.myfaces.trinidad.bean.PropertyKey;
26 import org.apache.myfaces.trinidad.component.UIXObject;
27 import org.apache.myfaces.trinidad.util.ComponentUtils;
28
29 /**
30 *
31 * <html:p>
32 * The separator creates a horizontal separator.
33 * </html:p>
34 *
35 * <h4>Events:</h4>
36 * <table border="1" width="100%" cellpadding="3" summary="">
37 * <tr bgcolor="#CCCCFF" class="TableHeadingColor">
38 * <th align="left">Type</th>
39 * <th align="left">Phases</th>
40 * <th align="left">Description</th>
41 * </tr>
42 * <tr class="TableRowColor">
43 * <td valign="top"><code>org.apache.myfaces.trinidad.event.AttributeChangeEvent</code></td>
44 * <td valign="top" nowrap>Invoke<br>Application<br>Apply<br>Request<br>Values</td>
45 * <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>
46 * </tr>
47 * </table>
48 */
49 public class CoreSeparator extends UIXObject
50 {
51 static public final FacesBean.Type TYPE = new FacesBean.Type(
52 UIXObject.TYPE);
53 static public final PropertyKey INLINE_STYLE_KEY =
54 TYPE.registerKey("inlineStyle", String.class);
55 static public final PropertyKey STYLE_CLASS_KEY =
56 TYPE.registerKey("styleClass", String.class);
57 static public final PropertyKey SHORT_DESC_KEY =
58 TYPE.registerKey("shortDesc", String.class);
59 static public final PropertyKey PARTIAL_TRIGGERS_KEY =
60 TYPE.registerKey("partialTriggers", String[].class, null, 0, PropertyKey.Mutable.RARELY);
61
62 static public final String COMPONENT_FAMILY =
63 "org.apache.myfaces.trinidad.Object";
64 static public final String COMPONENT_TYPE =
65 "org.apache.myfaces.trinidad.CoreSeparator";
66
67 /**
68 * Construct an instance of the CoreSeparator.
69 */
70 public CoreSeparator()
71 {
72 super("org.apache.myfaces.trinidad.Separator");
73 }
74
75 /**
76 * Gets the CSS styles to use for this component.
77 *
78 * @return the new inlineStyle value
79 */
80 final public String getInlineStyle()
81 {
82 return ComponentUtils.resolveString(getProperty(INLINE_STYLE_KEY));
83 }
84
85 /**
86 * Sets the CSS styles to use for this component.
87 *
88 * @param inlineStyle the new inlineStyle value
89 */
90 final public void setInlineStyle(String inlineStyle)
91 {
92 setProperty(INLINE_STYLE_KEY, (inlineStyle));
93 }
94
95 /**
96 * Gets a CSS style class to use for this component.
97 *
98 * @return the new styleClass value
99 */
100 final public String getStyleClass()
101 {
102 return ComponentUtils.resolveString(getProperty(STYLE_CLASS_KEY));
103 }
104
105 /**
106 * Sets a CSS style class to use for this component.
107 *
108 * @param styleClass the new styleClass value
109 */
110 final public void setStyleClass(String styleClass)
111 {
112 setProperty(STYLE_CLASS_KEY, (styleClass));
113 }
114
115 /**
116 * Gets The short description of the component. This text is commonly used by user agents to display tooltip help text.
117 *
118 * @return the new shortDesc value
119 */
120 final public String getShortDesc()
121 {
122 return ComponentUtils.resolveString(getProperty(SHORT_DESC_KEY));
123 }
124
125 /**
126 * Sets The short description of the component. This text is commonly used by user agents to display tooltip help text.
127 *
128 * @param shortDesc the new shortDesc value
129 */
130 final public void setShortDesc(String shortDesc)
131 {
132 setProperty(SHORT_DESC_KEY, (shortDesc));
133 }
134
135 /**
136 * Gets the IDs of the components that should trigger a partial update.
137 * <p>
138 * This component will listen on the trigger components. If one of the
139 * trigger components receives an event that will cause it to update
140 * in some way, this component will request to be updated too.</p>
141 * <p>
142 * Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
143 * </p>
144 * <p>
145 * Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
146 * or use multiple colons to move up through the NamingContainer. For example,
147 * "::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
148 * ":::" will pop out of two naming containers, etc. The search for
149 * the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
150 * component with id = commandButton1 after popping out of two naming containers relative to this component.
151 * To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
152 *
153 * @return the new partialTriggers value
154 */
155 final public String[] getPartialTriggers()
156 {
157 return (String[])getProperty(PARTIAL_TRIGGERS_KEY);
158 }
159
160 /**
161 * Sets the IDs of the components that should trigger a partial update.
162 * <p>
163 * This component will listen on the trigger components. If one of the
164 * trigger components receives an event that will cause it to update
165 * in some way, this component will request to be updated too.</p>
166 * <p>
167 * Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
168 * </p>
169 * <p>
170 * Identifiers must account for NamingContainers. You can use a single colon to start the search from the root,
171 * or use multiple colons to move up through the NamingContainer. For example,
172 * "::" will pop out of this component's naming container (it pops out of itself if it is a naming container),
173 * ":::" will pop out of two naming containers, etc. The search for
174 * the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the
175 * component with id = commandButton1 after popping out of two naming containers relative to this component.
176 * To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
177 *
178 * @param partialTriggers the new partialTriggers value
179 */
180 final public void setPartialTriggers(String[] partialTriggers)
181 {
182 setProperty(PARTIAL_TRIGGERS_KEY, (partialTriggers));
183 }
184
185 @Override
186 public String getFamily()
187 {
188 return COMPONENT_FAMILY;
189 }
190
191 @Override
192 protected FacesBean.Type getBeanType()
193 {
194 return TYPE;
195 }
196
197 /**
198 * Construct an instance of the CoreSeparator.
199 */
200 protected CoreSeparator(
201 String rendererType
202 )
203 {
204 super(rendererType);
205 }
206
207 static
208 {
209 TYPE.lockAndRegister("org.apache.myfaces.trinidad.Object","org.apache.myfaces.trinidad.Separator");
210 }
211 }