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.extension;
21  
22  import org.apache.myfaces.tobago.apt.annotation.DynamicExpression;
23  import org.apache.myfaces.tobago.apt.annotation.ExtensionTag;
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.UIComponentTagAttribute;
27  
28  /**
29   * Render a group of checkboxes.
30   *
31   * @deprecated since Tobago 3.0. The tx-library is deprecated, please use the tc-library.
32   */
33  @Tag(name = "selectManyCheckbox")
34  @ExtensionTag(
35      baseClassName = "org.apache.myfaces.tobago.internal.taglib.SelectManyCheckboxTag",
36      faceletHandler = "org.apache.myfaces.tobago.facelets.extension.SelectManyCheckboxExtensionHandler")
37  public interface SelectManyCheckboxExtensionTag {
38  
39    /**
40     * Flag indicating that a value is required.
41     * If the value is an empty string a
42     * ValidationError occurs and a Error Message is rendered.
43     */
44    @TagAttribute
45    @UIComponentTagAttribute(type = "boolean", defaultValue = "false")
46    void setRequired(final javax.el.ValueExpression required);
47  
48    /**
49     * The current value of this component.
50     */
51    @TagAttribute
52    @UIComponentTagAttribute(type = "java.lang.Object")
53    void setValue(final javax.el.ValueExpression value);
54  
55    /**
56     * MethodExpression representing a value change listener method
57     * that will be notified when a new value has been set for this input component.
58     * The expression must evaluate to a public method that takes a ValueChangeEvent
59     * parameter, with a return type of void.
60     */
61    @TagAttribute
62    @UIComponentTagAttribute(
63        type = {},
64        expression = DynamicExpression.METHOD_EXPRESSION_REQUIRED,
65        methodSignature = "javax.faces.event.ValueChangeEvent")
66    void setValueChangeListener(final javax.el.MethodExpression valueChangeListener);
67  
68    /**
69     * Flag indicating that this element is disabled.
70     */
71    @TagAttribute()
72    @UIComponentTagAttribute(type = "boolean", defaultValue = "false")
73    void setDisabled(final javax.el.ValueExpression disabled);
74  
75    /**
76     * Flag indicating that this component will prohibit changes by the user.
77     */
78    @TagAttribute
79    @UIComponentTagAttribute(type = "boolean", defaultValue = "false")
80    void setReadonly(final javax.el.ValueExpression readonly);
81  
82    /**
83     * Clientside script function to add to this component's onchange handler.
84     */
85    @TagAttribute
86    @UIComponentTagAttribute()
87    void setOnchange(final javax.el.ValueExpression onchange);
88  
89    /**
90     * Flag indicating this component should rendered as an inline element.
91     */
92    @TagAttribute
93    @UIComponentTagAttribute(type = "boolean", defaultValue = "false")
94    void setInline(final javax.el.ValueExpression inline);
95  
96    /**
97     * Text value to display as label.
98     * If text contains an underscore the next character is used as accesskey.
99     */
100   @TagAttribute
101   @UIComponentTagAttribute()
102   void setLabel(final javax.el.ValueExpression label);
103 
104   /*void setHeight(String height) ; */
105 
106   /**
107    * A method binding EL expression,
108    * accepting FacesContext, UIComponent,
109    * and Object parameters, and returning void, that validates
110    * the component's local value.
111    */
112   @TagAttribute
113   @UIComponentTagAttribute(type = {},
114       expression = DynamicExpression.METHOD_EXPRESSION,
115       methodSignature = {"javax.faces.context.FacesContext", "javax.faces.component.UIComponent", "java.lang.Object"})
116   void setValidator(final javax.el.MethodExpression validator);
117 
118   /**
119    * An expression that specifies the Converter for this component.
120    * If the value binding expression is a String,
121    * the String is used as an ID to look up a Converter.
122    * If the value binding expression is a Converter,
123    * uses that instance as the converter.
124    * The value can either be a static value (ID case only)
125    * or an EL expression.
126    */
127   @TagAttribute
128   @UIComponentTagAttribute(type = "javax.faces.convert.Converter",
129       expression = DynamicExpression.VALUE_EXPRESSION)
130   void setConverter(final javax.el.ValueExpression converter);
131 
132   /**
133    * Flag indicating whether or not this component should be rendered
134    * (during Render Response Phase), or processed on any subsequent form submit.
135    */
136   @TagAttribute
137   @UIComponentTagAttribute(type = "boolean", defaultValue = "true")
138   void setRendered(final javax.el.ValueExpression rendered);
139 
140   /**
141    * The value binding expression linking this
142    * component to a property in a backing bean.
143    */
144   @TagAttribute
145   @UIComponentTagAttribute(type = "javax.faces.component.UIComponent")
146   void setBinding(final javax.el.ValueExpression binding);
147 
148   /**
149    * Text value to display as tooltip.
150    */
151   @TagAttribute
152   @UIComponentTagAttribute()
153   void setTip(final javax.el.ValueExpression tip);
154 
155   /**
156    * The width for the label component. Default: 'auto'.
157    * This value is used in the gridLayouts columns attribute.
158    * See gridLayout tag for valid values.
159    */
160   @TagAttribute
161   @UIComponentTagAttribute()
162   void setLabelWidth(final javax.el.ValueExpression labelWidth);
163 
164   /**
165    * Indicate markup of this component.
166    * Possible value is 'none'. But this can be overridden in the theme.
167    */
168   @TagAttribute
169   @UIComponentTagAttribute(defaultValue = "none", type = "java.lang.String[]")
170   void setMarkup(final javax.el.ValueExpression markup);
171 
172   @TagAttribute
173   @UIComponentTagAttribute(type = "java.lang.Integer")
174   void setTabIndex(final javax.el.ValueExpression tabIndex);
175 
176   /**
177    * Flag indicating this component should receive the focus.
178    */
179   @TagAttribute
180   @UIComponentTagAttribute(type = "boolean", defaultValue = "false")
181   void setFocus(final javax.el.ValueExpression focus);
182 
183   /**
184    * Range of items to render.
185    */
186   @TagAttribute
187   @UIComponentTagAttribute()
188   void setRenderRange(final javax.el.ValueExpression renderRange);
189 
190   /**
191    * An expression that specifies the validator message
192    */
193   @TagAttribute
194   @UIComponentTagAttribute()
195   void setValidatorMessage(final javax.el.ValueExpression validatorMessage);
196 
197   /**
198    * An expression that specifies the converter message
199    */
200   @TagAttribute
201   @UIComponentTagAttribute()
202   void setConverterMessage(final javax.el.ValueExpression converterMessage);
203 
204   /**
205    * An expression that specifies the required message
206    */
207   @TagAttribute
208   @UIComponentTagAttribute()
209   void setRequiredMessage(final javax.el.ValueExpression requiredMessage);
210 
211   /**
212    * The component identifier for the input field component inside of the container.
213    * This value must be unique within the closest parent component that is a naming container.
214    */
215   @TagAttribute(rtexprvalue = true)
216   @UIComponentTagAttribute
217   void setFieldId(final String fieldId);
218 
219   /**
220    * The component identifier for this component.
221    * This value must be unique within the closest parent component that is a naming container.
222    * For tx components the id will be set to the container (e. g. the panel).
223    * To set the id of the input field, you have to use the attribute "fieldId".
224    */
225   @TagAttribute(rtexprvalue = true)
226   @UIComponentTagAttribute
227   void setId(final String id);
228 }