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