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