The goog.editor.Table Class

goog.editor.Table(node)

Class providing high level table editing functions.

node {Element}
Element that is a table or descendant of a table.

.DEFAULT_BORDER_COLOR {string}

Default color for table borders.

.OPTIMUM_EMPTY_CELL_WIDTH {number}

Optimum size of empty cells (in pixels), if possible.

.OPTIMUM_MAX_NEW_TABLE_WIDTH {number}

Maximum width for new tables.

.createDomTable(doc, columns, rows, opt_tableStyle)

Creates a new table element, populated with cells and formatted.

doc {Document}
Document in which to create the table element.
columns {number}
Number of columns in the table.
rows {number}
Number of rows in the table.
opt_tableStyle {Object=}
Object containing borderWidth and borderColor properties, used to set the inital style of the table.
returns {Element}
a table element.

.createEmptyTd()

Creates an empty TD element and fill it with some empty content so it will show up with borders even in IE pre-7 or if empty-cells is set to 'hide'

returns {Element}
a new TD element.

.getChildCellElements(tr)

Returns all child elements of a TR element that are of type TD or TH.

tr {Element}
TR element in which to find children.
returns {Array.<Element>}
array of child cell elements.

.insertCellElement(td, rowIndex, colIndex)

Inserts a cell element at the given position. The colIndex is the logical column index, not the position in the dom. This takes into consideration that cells in a given logical row may actually be children of a previous DOM row that have used rowSpan to extend into the row.

td {Element}
The new cell element to insert.
rowIndex {number}
Row in which to insert the element.
colIndex {number}
Column in which to insert the element.

.insertColumn(opt_colIndex)

Inserts a new column in the table. The column will be created by inserting new TD elements in each row, or extending the colspan of existing TD elements.

opt_colIndex {number=}
Index at which to insert the column. If this is omitted the column will be appended to the right side of the table.
returns {Array.<Element>}
Array of new cell elements that were created to populate the new column.

.insertRow(opt_rowIndex)

Inserts a new row in the table. The row will be populated with new cells, and existing rowspanned cells that overlap the new row will be extended.

opt_rowIndex {number=}
Index at which to insert the row. If this is omitted the row will be appended to the end of the table.
returns {Element}
The new row.

.mergeCells(startRowIndex, startColIndex, endRowIndex, endColIndex)

Merges multiple cells into a single cell, and sets the rowSpan and colSpan attributes of the cell to take up the same space as the original cells.

startRowIndex {number}
Top coordinate of the cells to merge.
startColIndex {number}
Left coordinate of the cells to merge.
endRowIndex {number}
Bottom coordinate of the cells to merge.
endColIndex {number}
Right coordinate of the cells to merge.
returns {boolean}
Whether or not the merge was possible. If the cells in the supplied coordinates can't be merged this will return false.

.refresh()

Walks the dom structure of this object's table element and populates this.rows with goog.editor.TableRow objects. This is done initially to populate the internal data structures, and also after each time the DOM structure is modified. Currently this means that the all existing information is discarded and re-read from the DOM.

.removeColumn(colIndex)

Removes a column from the table. This is done by removing cell elements, or shrinking the colspan of elements that span multiple columns.

colIndex {number}
Index of the column to delete.

.removeRow(rowIndex)

Removes a row from the table, removing the TR element and decrementing the rowspan of any cells in other rows that overlap the row.

rowIndex {number}
Index of the row to delete.

.splitCell(rowIndex, colIndex)

Splits a cell with colspans or rowspans into multiple descrete cells.

rowIndex {number}
y coordinate of the cell to split.
colIndex {number}
x coordinate of the cell to split.
returns {Array.<Element>}
Array of new cell elements created by splitting the cell.

Documentation generated using JvJsDoc, version 0.5 on 2012-09-03.