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 set of radio buttons.
30   *
31   * @since 1.0.13
32   *
33   * @deprecated since Tobago 3.0. The tx-library is deprecated, please use the tc-library.
34   */
35  @Tag(name = "selectOneRadio")
36  @ExtensionTag(
37      baseClassName = "org.apache.myfaces.tobago.internal.taglib.SelectOneRadioTag",
38      faceletHandler = "org.apache.myfaces.tobago.facelets.extension.SelectOneRadioExtensionHandler")
39  public interface SelectOneRadioExtensionTag {
40  
41    /**
42     * Flag indicating that a value is required.
43     * If the value is an empty string a
44     * ValidationError occurs and a Error Message is rendered.
45     */
46    @TagAttribute
47    @UIComponentTagAttribute(type = "boolean", defaultValue = "false")
48    void setRequired(final javax.el.ValueExpression required);
49  
50    /**
51     * The current value of this component.
52     */
53    @TagAttribute
54    @UIComponentTagAttribute(type = "java.lang.Object")
55    void setValue(final javax.el.ValueExpression value);
56  
57    /**
58     * MethodExpression representing a value change listener method
59     * that will be notified when a new value has been set for this input component.
60     * The expression must evaluate to a public method that takes a ValueChangeEvent
61     * parameter, with a return type of void.
62     */
63    @TagAttribute
64    @UIComponentTagAttribute(
65        type = {},
66        expression = DynamicExpression.METHOD_EXPRESSION_REQUIRED,
67        methodSignature = "javax.faces.event.ValueChangeEvent")
68    void setValueChangeListener(final javax.el.MethodExpression valueChangeListener);
69  
70    /**
71     * A method binding EL expression,
72     * accepting FacesContext, UIComponent,
73     * and Object parameters, and returning void, that validates
74     * the component's local value.
75     */
76    @TagAttribute
77    @UIComponentTagAttribute(type = {},
78        expression = DynamicExpression.METHOD_EXPRESSION,
79        methodSignature = {"javax.faces.context.FacesContext", "javax.faces.component.UIComponent", "java.lang.Object"})
80    void setValidator(final javax.el.MethodExpression validator);
81  
82    /**
83     * Flag indicating that this element is disabled.
84     */
85    @TagAttribute()
86    @UIComponentTagAttribute(type = "boolean", defaultValue = "false")
87    void setDisabled(final javax.el.ValueExpression disabled);
88  
89    /**
90     * Flag indicating that this component will prohibit changes by the user.
91     */
92    @TagAttribute
93    @UIComponentTagAttribute(type = "boolean", defaultValue = "false")
94    void setReadonly(final javax.el.ValueExpression readonly);
95  
96    /**
97     * Clientside script function to add to this component's onchange handler.
98     */
99    @TagAttribute
100   @UIComponentTagAttribute()
101   void setOnchange(final javax.el.ValueExpression onchange);
102 
103   /**
104    * An expression that specifies the Converter for this component.
105    * If the value binding expression is a String,
106    * the String is used as an ID to look up a Converter.
107    * If the value binding expression is a Converter,
108    * uses that instance as the converter.
109    * The value can either be a static value (ID case only)
110    * or an EL expression.
111    */
112   @TagAttribute
113   @UIComponentTagAttribute(type = "javax.faces.convert.Converter",
114       expression = DynamicExpression.VALUE_EXPRESSION)
115   void setConverter(final javax.el.ValueExpression converter);
116 
117   /**
118    * Flag indicating this component should rendered as an inline element.
119    */
120   @TagAttribute
121   @UIComponentTagAttribute(type = "boolean", defaultValue = "false")
122   void setInline(final javax.el.ValueExpression inline);
123 
124   /**
125    * Text value to display as label.
126    * If text contains an underscore the next character is used as accesskey.
127    */
128   @TagAttribute
129   @UIComponentTagAttribute()
130   void setLabel(final javax.el.ValueExpression label);
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   @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    * Range of items to render.
177    */
178   @TagAttribute
179   @UIComponentTagAttribute()
180   void setRenderRange(final javax.el.ValueExpression renderRange);
181 
182   /**
183    * An expression that specifies the validator message
184    */
185   @TagAttribute
186   @UIComponentTagAttribute()
187   void setValidatorMessage(final javax.el.ValueExpression validatorMessage);
188 
189   /**
190    * An expression that specifies the converter message
191    */
192   @TagAttribute
193   @UIComponentTagAttribute()
194   void setConverterMessage(final javax.el.ValueExpression converterMessage);
195 
196   /**
197    * An expression that specifies the required message
198    */
199   @TagAttribute
200   @UIComponentTagAttribute()
201   void setRequiredMessage(final javax.el.ValueExpression requiredMessage);
202 
203   /**
204    * Indicate markup of this component.
205    * Possible value is 'none'. But this can be overridden in the theme.
206    */
207   @TagAttribute
208   @UIComponentTagAttribute(defaultValue = "none", type = "java.lang.String[]")
209   void setMarkup(final javax.el.ValueExpression markup);
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 }