summaryrefslogtreecommitdiff
path: root/webapps/qooxdoo-0.6.3-sdk/frontend/framework/source/class/qx/ui/table/HeaderCellRenderer.js
blob: 2108778efbe68d8e266626ceaa7e4dbc9398f668 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/* ************************************************************************

   qooxdoo - the new era of web development

   http://qooxdoo.org

   Copyright:
     2006 by STZ-IDA, Germany, http://www.stz-ida.de

   License:
     LGPL 2.1: http://www.gnu.org/licenses/lgpl.html

   Authors:
     * Til Schneider (til132)

************************************************************************ */

/* ************************************************************************

#module(ui_table)

************************************************************************ */

/**
 * A cell renderer for header cells.
 */
qx.OO.defineClass("qx.ui.table.HeaderCellRenderer", qx.core.Object,
function() {
  qx.core.Object.call(this);
});


/**
 * Creates a header cell.
 * <p>
 * The cellInfo map contains the following properties:
 * <ul>
 * <li>col (int): the model index of the column.</li>
 * <li>xPos (int): the x position of the column in the table pane.</li>
 * <li>name (string): the name of the column.</li>
 * <li>editable (boolean): whether the column is editable.</li>
 * <li>sorted (boolean): whether the column is sorted.</li>
 * <li>sortedAscending (boolean): whether sorting is ascending.</li>
 * </ul>
 *
 * @param cellInfo {Map} A map containing the information about the cell to
 *    create.
 * @return {qx.ui.core.Widget} the widget that renders the header cell.
 */
qx.Proto.createHeaderCell = function(cellInfo) {
  throw new Error("createHeaderCell is abstract");
}


/**
 * Updates a header cell.
 *
 * @param cellInfo {Map} A map containing the information about the cell to
 *    create. This map has the same structure as in {@link #createHeaderCell}.
 * @param cellWidget {qx.ui.core.Widget} the widget that renders the header cell. This is
 *    the same widget formally created by {@link #createHeaderCell}.
 */
qx.Proto.updateHeaderCell = function(cellInfo, cellWidget) {
  throw new Error("updateHeaderCell is abstract");
}


/** The preferred height of cells created by this header renderer. */
qx.OO.addProperty({ name:"prefferedCellHeight", type:"number", defaultValue:16, allowNull:false });