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  package org.apache.myfaces.custom.selectOneRow;
20  
21  import javax.faces.component.UIInput;
22  
23  import org.apache.myfaces.component.AlignProperty;
24  import org.apache.myfaces.component.ChangeSelectProperties;
25  import org.apache.myfaces.component.EventAware;
26  import org.apache.myfaces.component.FocusBlurProperties;
27  
28  /**
29   * Enhancement for a data-table to select one Row with a radio button. The row-index is stored in the vealu-binding
30   * 
31   * @JSFComponent
32   *   name = "t:selectOneRow"
33   *   class = "org.apache.myfaces.custom.selectOneRow.SelectOneRow"
34   *   tagClass = "org.apache.myfaces.custom.selectOneRow.SelectOneRowTag"
35   * @since 1.1.7
36   */
37  public abstract class AbstractSelectOneRow extends UIInput 
38      implements AlignProperty, EventAware, FocusBlurProperties, ChangeSelectProperties
39  {
40  
41      public static final String COMPONENT_TYPE = "org.apache.myfaces.SelectOneRow";
42  
43      public static final String COMPONENT_FAMILY = "org.apache.myfaces.SelectOneRow";
44  
45      public static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.SelectOneRow";
46  
47      /**
48       * The Name of the radio-button-group to use. If EL expressions are used,
49       * note that every time this is evaluated should lead to the same value
50       * in the scope used, that means the UIData instance used, otherwise
51       * it could lead to unwanted side effects.
52       * 
53       * @JSFProperty
54       */
55      public abstract String getGroupName();
56      
57      /**
58       * HTML: When true, this element cannot receive focus.
59       * 
60       * @JSFProperty
61       *   defaultValue = "false"
62       */
63      public abstract boolean isDisabled();   
64      
65      /**
66       * HTML: When true, indicates that this component cannot be modified by the user.
67       * The element may receive focus unless it has also been disabled.
68       * 
69       * @JSFProperty
70       *   defaultValue = "false"
71       */
72      public abstract boolean isReadonly();    
73      
74  }