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.table;
20  
21  import javax.faces.component.UIColumn;
22  
23  /**
24   * @JSFComponent
25   *   name = "s:sortableColumn"
26   *   class = "org.apache.myfaces.custom.table.SortableColumn"
27   *   tagClass = "org.apache.myfaces.custom.table.SortableColumnTag"
28   *   
29   * @author Thomas Spiegl
30   */
31  public abstract class AbstractSortableColumn extends UIColumn {
32      
33      public static final String COMPONENT_TYPE = "org.apache.myfaces.SortableColumn";
34  
35      /**
36       * see http://dojotoolkit.org org filterTable
37       * 
38       * @JSFProperty
39       */
40      public abstract String getField();
41  
42      /**
43       * default=String {Number,Date,html,String} see http://dojotoolkit.org org filterTable
44       * 
45       * @JSFProperty
46       */
47      public abstract String getDataType();
48  
49      /**
50       * {asc, desc} see http://dojotoolkit.org org filterTable
51       * 
52       * @JSFProperty
53       */
54      public abstract String getSort();
55  
56      /**
57       * {asc, desc} see http://dojotoolkit.org org filterTable
58       * 
59       * @JSFProperty
60       */
61      public abstract String getFormat();
62  
63      /**
64       * {asc, desc} see http://dojotoolkit.org org filterTable
65       * 
66       * @JSFProperty
67       */
68      public abstract String getAlign();
69  
70      /**
71       * {asc, desc} see http://dojotoolkit.org org filterTable
72       * 
73       * @JSFProperty
74       */
75      public abstract String getValign();
76  
77      /**
78       * column header text
79       * 
80       * @JSFProperty
81       */
82      public abstract String getText();
83  
84      /**
85       * default=true escape text
86       * 
87       * @JSFProperty
88       */
89      public abstract Boolean getEscape();
90  }