summaryrefslogtreecommitdiff
path: root/webapps/qooxdoo-0.6.3-sdk/frontend/framework/source/class/qx/ui/table/DataCellRenderer.js
blob: 46f808df32f2db85043b4360d5db8635b4e9f2c4 (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
70
71
72
73
74
75
76
77
78
79
80
/* ************************************************************************

   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 data cells.
 */
qx.OO.defineClass("qx.ui.table.DataCellRenderer", qx.core.Object,
function() {
  qx.core.Object.call(this);
});


/**
 * Creates the HTML for a data cell.
 * <p>
 * The cellInfo map contains the following properties:
 * <ul>
 * <li>value (var): the cell's value.</li>
 * <li>rowData (var): contains the row data for the row, the cell belongs to.
 *   The kind of this object depends on the table model, see
 *   {@link TableModel#getRowData()}</li>
 * <li>row (int): the model index of the row the cell belongs to.</li>
 * <li>col (int): the model index of the column the cell belongs to.</li>
 * <li>table (qx.ui.table.Table): the table the cell belongs to.</li>
 * <li>xPos (int): the x position of the cell in the table pane.</li>
 * <li>selected (boolean): whether the cell is selected.</li>
 * <li>focusedCol (boolean): whether the cell is in the same column as the
 *   focused cell.</li>
 * <li>focusedRow (boolean): whether the cell is in the same row as the
 *   focused cell.</li>
 * <li>editable (boolean): whether the cell is editable.</li>
 * <li>style (string): The CSS styles that should be applied to the outer HTML
 *   element.</li>
 * </ul>
 *
 * @param cellInfo {Map} A map containing the information about the cell to
 *    create.
 * @return {string} the HTML of the data cell.
 */
qx.Proto.createDataCellHtml = function(cellInfo) {
  throw new Error("createDataCellHtml is abstract");
}


/**
 * Updates a data cell.
 *
 * @param cellInfo {Map} A map containing the information about the cell to
 *    create. This map has the same structure as in {@link #createDataCell}.
 * @param cellElement {element} the DOM element that renders the data cell. This
 *    is the same element formally created by the HTML from {@link #createDataCell}.
 */
qx.Proto.updateDataCellElement = function(cellInfo, cellElement) {
  throw new Error("updateDataCellElement is abstract");
}


qx.Proto.createDataCellHtml_array_join = function(cellInfo, htmlArr) {
  throw new Error("createDataCellHtml_array_join is abstract");
}