public abstract class

HTMLTable

extends Panel
implements HasClickHandlers HasDoubleClickHandlers SourcesTableEvents

java.lang.Object
↳	com.google.gwt.user.client.ui.UIObject
	↳	com.google.gwt.user.client.ui.Widget
		↳	com.google.gwt.user.client.ui.Panel
			↳	com.google.gwt.user.client.ui.HTMLTable

Known Direct Subclasses

FlexTable, Grid

Class Overview

HTMLTable contains the common table algorithms for Grid and FlexTable.

Summary

Nested Classes
class	HTMLTable.Cell	Return value for `getCellForEvent(ClickEvent)`.
class	HTMLTable.CellFormatter	This class contains methods used to format a table's cells.
class	HTMLTable.ColumnFormatter	This class contains methods used to format a table's columns.
class	HTMLTable.RowFormatter	This class contains methods used to format a table's rows.

[Expand]

Inherited Constants

From class com.google.gwt.user.client.ui.UIObject

Public Constructors
	HTMLTable() Create a new empty HTML Table.

Public Methods
HandlerRegistration	addClickHandler(ClickHandler handler) Adds a `ClickEvent` handler.
HandlerRegistration	addDoubleClickHandler(DoubleClickHandler handler) Adds a `DoubleClickEvent` handler.
void	addTableListener(TableListener listener) This method is deprecated. add a click handler instead and use `getCellForEvent(ClickEvent)` to get the cell information (remember to check for a null return value)
void	clear() Removes all widgets from this table, but does not remove other HTML or text contents of cells.
void	clear(boolean clearInnerHTML) Removes all widgets from this table, optionally clearing the inner HTML of each cell.
boolean	clearCell(int row, int column) Clears the cell at the given row and column.
abstract int	getCellCount(int row) Gets the number of cells in a given row.
HTMLTable.Cell	getCellForEvent(ClickEvent event) Given a click event, return the Cell that was clicked, or null if the event did not hit this table.
HTMLTable.CellFormatter	getCellFormatter() Gets the `HTMLTable.CellFormatter` associated with this table.
int	getCellPadding() Gets the amount of padding that is added around all cells.
int	getCellSpacing() Gets the amount of spacing that is added around all cells.
HTMLTable.ColumnFormatter	getColumnFormatter() Gets the column formatter.
String	getHTML(int row, int column) Gets the HTML contents of the specified cell.
abstract int	getRowCount() Gets the number of rows present in this table.
HTMLTable.RowFormatter	getRowFormatter() Gets the RowFormatter associated with this table.
String	getText(int row, int column) Gets the text within the specified cell.
Widget	getWidget(int row, int column) Gets the widget in the specified cell.
boolean	isCellPresent(int row, int column) Determines whether the specified cell exists.
Iterator<Widget>	iterator() Returns an iterator containing all the widgets in this table.
boolean	remove(Widget widget) Remove the specified widget from the table.
void	removeTableListener(TableListener listener) This method is deprecated. Use the `removeHandler()` method on the object returned by an addHandler method instead*
void	setBorderWidth(int width) Sets the width of the table's border.
void	setCellPadding(int padding) Sets the amount of padding to be added around all cells.
void	setCellSpacing(int spacing) Sets the amount of spacing to be added around all cells.
void	setHTML(int row, int column, SafeHtml html) Sets the HTML contents of the specified cell.
void	setHTML(int row, int column, String html) Sets the HTML contents of the specified cell.
void	setText(int row, int column, String text) Sets the text within the specified cell.
void	setWidget(int row, int column, Widget widget) Sets the widget within the specified cell.

Protected Methods
void	checkCellBounds(int row, int column) Bounds checks that the cell exists at the specified location.
void	checkRowBounds(int row) Checks that the row is within the correct bounds.
Element	createCell() Creates a new cell.
Element	getBodyElement() Gets the table's TBODY element.
int	getDOMCellCount(int row) Directly ask the underlying DOM what the cell count on the given row is.
int	getDOMCellCount(Element tableBody, int row) Directly ask the underlying DOM what the cell count on the given row is.
int	getDOMRowCount(Element elem)
int	getDOMRowCount() Directly ask the underlying DOM what the row count is.
Element	getEventTargetCell(Event event) Determines the TD associated with the specified event.
void	insertCell(int row, int column) Inserts a new cell into the specified row.
void	insertCells(int row, int column, int count) Inserts a number of cells before the specified cell.
int	insertRow(int beforeRow) Inserts a new row into the table.
boolean	internalClearCell(Element td, boolean clearInnerHTML) Does actual clearing, used by clearCell and cleanCell.
void	onEnsureDebugId(String baseID) Affected Elements: -(row)#-(cell)# = the cell at the given row and cell index.
abstract void	prepareCell(int row, int column) Subclasses must implement this method.
void	prepareColumn(int column) Subclasses can implement this method.
abstract void	prepareRow(int row) Subclasses must implement this method.
void	removeCell(int row, int column) Removes the specified cell from the table.
void	removeRow(int row) Removes the specified row from the table.
void	setCellFormatter(HTMLTable.CellFormatter cellFormatter) Sets the table's CellFormatter.
void	setColumnFormatter(HTMLTable.ColumnFormatter formatter)
void	setRowFormatter(HTMLTable.RowFormatter rowFormatter) Sets the table's RowFormatter.

[Expand]

Inherited Methods

From class com.google.gwt.user.client.ui.Panel

void	add(IsWidget child)
void	add(Widget child) Adds a child widget.
final void	adopt(Widget child) Finalize the attachment of a Widget to this Panel.
void	adopt(Widget w, Element container) This method is deprecated. Use `adopt(Widget)`.
void	clear() Removes all child widgets.
void	disown(Widget w) This method is deprecated. Use `orphan(Widget)`.
void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onAttach()` for each of its child widgets.
void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onDetach()` for each of its child widgets.
final void	orphan(Widget child) This method must be called as part of the remove method of any Panel.
abstract boolean	remove(Widget child) Removes a child widget.
boolean	remove(IsWidget child)

From class com.google.gwt.user.client.ui.Widget

HandlerRegistration	addAttachHandler(AttachEvent.Handler handler) Adds an `AttachEvent` handler.
final <H extends EventHandler> HandlerRegistration	addDomHandler(H handler, Type<H> type) Adds a native event handler to the widget and sinks the corresponding native event.
final <H extends EventHandler> HandlerRegistration	addHandler(H handler, Type<H> type) Adds this handler to the widget.
Widget	asWidget() Returns the `Widget` aspect of the receiver.
static Widget	asWidgetOrNull(IsWidget w) This convenience method makes a null-safe call to `asWidget()`.
HandlerManager	createHandlerManager() Creates the `HandlerManager` used by this Widget.
void	delegateEvent(Widget target, GwtEvent<?> event) Fires an event on a child widget.
void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onAttach()` for each of its child widgets.
void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onDetach()` for each of its child widgets.
void	fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type.
int	getHandlerCount(Type<?> type) Gets the number of handlers listening to the event type.
Object	getLayoutData() Gets the panel-defined layout data associated with this widget.
Widget	getParent() Gets this widget's parent panel.
boolean	isAttached() Determines whether this widget is currently attached to the browser's document (i.e., there is an unbroken chain of widgets between this widget and the underlying browser document).
final boolean	isOrWasAttached() Has this widget ever been attached?
void	onAttach() This method is called when a widget is attached to the browser's document.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	onDetach() This method is called when a widget is detached from the browser's document.
void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.
void	onUnload() This method is called immediately before a widget will be detached from the browser's document.
void	removeFromParent() Removes this widget from its parent widget, if one exists.
void	setLayoutData(Object layoutData) Sets the panel-defined layout data associated with this widget.
void	sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.

From class com.google.gwt.user.client.ui.UIObject

void	addStyleDependentName(String styleSuffix) Adds a dependent style name by specifying the style name's suffix.
void	addStyleName(String style) Adds a secondary or dependent style name to this object.
static void	ensureDebugId(Element elem, String baseID, String id) Set the debug id of a specific element.
final void	ensureDebugId(String id) Ensure that the main `Element` for this `UIObject` has an ID property set, which allows it to integrate with third-party libraries and test tools.
static void	ensureDebugId(Element elem, String id) Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools.
int	getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area.
int	getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area.
Element	getElement() Gets a handle to the object's underlying DOM element.
int	getOffsetHeight() Gets the object's offset height in pixels.
int	getOffsetWidth() Gets the object's offset width in pixels.
Element	getStyleElement() Template method that returns the element to which style names will be applied.
String	getStyleName() Gets all of the object's style names, as a space-separated list.
static String	getStyleName(Element elem) Gets all of the element's style names, as a space-separated list.
String	getStylePrimaryName() Gets the primary style name associated with the object.
static String	getStylePrimaryName(Element elem) Gets the element's primary style name.
String	getTitle() Gets the title associated with this object.
boolean	isVisible() Determines whether or not this object is visible.
static boolean	isVisible(Element elem)
void	onEnsureDebugId(String baseID) Called when the user sets the id using the `ensureDebugId(String)` method.
void	removeStyleDependentName(String styleSuffix) Removes a dependent style name by specifying the style name's suffix.
void	removeStyleName(String style) Removes a style name.
final void	setElement(Element elem) Sets this object's browser element.
void	setElement(Element elem) Sets this object's browser element.
void	setHeight(String height) Sets the object's height.
void	setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding.
void	setSize(String width, String height) Sets the object's size.
void	setStyleDependentName(String styleSuffix, boolean add) Adds or removes a dependent style name by specifying the style name's suffix.
static void	setStyleName(Element elem, String styleName) Clears all of the element's style names and sets it to the given style.
static void	setStyleName(Element elem, String style, boolean add) This convenience method adds or removes a style name for a given element.
void	setStyleName(String style) Clears all of the object's style names and sets it to the given style.
void	setStyleName(String style, boolean add) Adds or removes a style name.
void	setStylePrimaryName(String style) Sets the object's primary style name and updates all dependent style names.
static void	setStylePrimaryName(Element elem, String style) Sets the element's primary style name and updates all dependent style names.
void	setTitle(String title) Sets the title associated with this object.
void	setVisible(boolean visible) Sets whether this object is visible.
static void	setVisible(Element elem, boolean visible)
void	setWidth(String width) Sets the object's width.
void	sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object.
String	toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet.
void	unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.

From class java.lang.Object

From interface com.google.gwt.event.dom.client.HasClickHandlers

From interface com.google.gwt.event.dom.client.HasDoubleClickHandlers

From interface com.google.gwt.event.logical.shared.HasAttachHandlers

From interface com.google.gwt.event.shared.HasHandlers

From interface com.google.gwt.user.client.EventListener

From interface com.google.gwt.user.client.ui.HasWidgets

From interface com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

From interface com.google.gwt.user.client.ui.IsWidget

From interface com.google.gwt.user.client.ui.SourcesTableEvents

From interface java.lang.Iterable

Public Constructors

public HTMLTable ()

Create a new empty HTML Table.

Public Methods

public HandlerRegistration addClickHandler (ClickHandler handler)

Adds a ClickEvent handler.

Parameters

handler	the click handler

Returns

HandlerRegistration used to remove this handler

public HandlerRegistration addDoubleClickHandler (DoubleClickHandler handler)

Adds a DoubleClickEvent handler.

Parameters

handler	the double click handler

Returns

HandlerRegistration used to remove this handler

public void addTableListener (TableListener listener)

This method is deprecated.
add a click handler instead and use getCellForEvent(ClickEvent) to get the cell information (remember to check for a null return value)

Adds a listener to the current table.

Parameters

listener	listener to add

public void clear ()

Removes all widgets from this table, but does not remove other HTML or text contents of cells.

public void clear (boolean clearInnerHTML)

Removes all widgets from this table, optionally clearing the inner HTML of each cell. Note that this method does not remove any cells or rows.

Parameters

clearInnerHTML	should the cell's inner html be cleared?

public boolean clearCell (int row, int column)

Clears the cell at the given row and column. If it contains a Widget, it will be removed from the table. If not, its contents will simply be cleared.

Parameters

row	the widget's row
column	the widget's column

Returns

true if a widget was removed

Throws

IndexOutOfBoundsException

public abstract int getCellCount (int row)

Gets the number of cells in a given row.

Parameters

row	the row whose cells are to be counted

Returns

the number of cells present in the row

public HTMLTable.Cell getCellForEvent (ClickEvent event)

Given a click event, return the Cell that was clicked, or null if the event did not hit this table. The cell can also be null if the click event does not occur on a specific cell.

Parameters

event	A click event of indeterminate origin

Returns

The appropriate cell, or null

public HTMLTable.CellFormatter getCellFormatter ()

Gets the HTMLTable.CellFormatter associated with this table. Use casting to get subclass-specific functionality

Returns

this table's cell formatter

public int getCellPadding ()

Gets the amount of padding that is added around all cells.

Returns

the cell padding, in pixels

public int getCellSpacing ()

Gets the amount of spacing that is added around all cells.

Returns

the cell spacing, in pixels

public HTMLTable.ColumnFormatter getColumnFormatter ()

Gets the column formatter.

Returns

the column formatter

public String getHTML (int row, int column)

Gets the HTML contents of the specified cell.

Parameters

row	the cell's row
column	the cell's column

Returns

the cell's HTML contents

Throws

IndexOutOfBoundsException

public abstract int getRowCount ()

Gets the number of rows present in this table.

Returns

the table's row count

public HTMLTable.RowFormatter getRowFormatter ()

Gets the RowFormatter associated with this table.

Returns

the table's row formatter

public String getText (int row, int column)

Gets the text within the specified cell.

Parameters

row	the cell's row
column	the cell's column

Returns

the cell's text contents

Throws

IndexOutOfBoundsException

public Widget getWidget (int row, int column)

Gets the widget in the specified cell.

Parameters

row	the cell's row
column	the cell's column

Returns

the widget in the specified cell, or null if none is present

Throws

IndexOutOfBoundsException

public boolean isCellPresent (int row, int column)

Determines whether the specified cell exists.

Parameters

row	the cell's row
column	the cell's column

Returns

true if the specified cell exists

public Iterator<Widget> iterator ()

Returns an iterator containing all the widgets in this table.

Returns

the iterator

public boolean remove (Widget widget)

Remove the specified widget from the table.

Parameters

widget	widget to remove

Returns

was the widget removed from the table.

public void removeTableListener (TableListener listener)

This method is deprecated.
Use the removeHandler() method on the object returned by an add*Handler method instead

Removes the specified table listener.

Parameters

listener	listener to remove

public void setBorderWidth (int width)

Sets the width of the table's border. This border is displayed around all cells in the table.

Parameters

width	the width of the border, in pixels

public void setCellPadding (int padding)

Sets the amount of padding to be added around all cells.

Parameters

padding	the cell padding, in pixels

public void setCellSpacing (int spacing)

Sets the amount of spacing to be added around all cells.

Parameters

spacing	the cell spacing, in pixels

public void setHTML (int row, int column, SafeHtml html)

Sets the HTML contents of the specified cell.

Parameters

row	the cell's row
column	the cell's column
html	the cell's safe html contents

Throws

IndexOutOfBoundsException

public void setHTML (int row, int column, String html)

Sets the HTML contents of the specified cell.

Parameters

row	the cell's row
column	the cell's column
html	the cell's HTML contents

Throws

IndexOutOfBoundsException

public void setText (int row, int column, String text)

Sets the text within the specified cell.

Parameters

row	the cell's row
column	cell's column
text	the cell's text contents

Throws

IndexOutOfBoundsException

public void setWidget (int row, int column, Widget widget)

Sets the widget within the specified cell.

Inherited implementations may either throw IndexOutOfBounds exception if the cell does not exist, or allocate a new cell to store the content.

FlexTable will automatically allocate the cell at the correct location and then set the widget. Grid will set the widget if and only if the cell is within the Grid's bounding box.

Parameters

row	the cell's row
column	the cell's column
widget	The widget to be added

Throws

IndexOutOfBoundsException

Protected Methods

protected void checkCellBounds (int row, int column)

Bounds checks that the cell exists at the specified location.

Parameters

row	cell's row
column	cell's column

Throws

IndexOutOfBoundsException

protected void checkRowBounds (int row)

Checks that the row is within the correct bounds.

Parameters

row	row index to check

Throws

IndexOutOfBoundsException

protected Element createCell ()

Creates a new cell. Override this method if the cell should have initial contents.

Returns

the newly created TD

protected Element getBodyElement ()

Gets the table's TBODY element.

Returns

the TBODY element

protected int getDOMCellCount (int row)

Directly ask the underlying DOM what the cell count on the given row is.

Parameters

row	the row

Returns

number of columns in the row

protected int getDOMCellCount (Element tableBody, int row)

Directly ask the underlying DOM what the cell count on the given row is.

Parameters

tableBody	the element
row	the row

Returns

number of columns in the row

protected int getDOMRowCount (Element elem)

protected int getDOMRowCount ()

Directly ask the underlying DOM what the row count is.

Returns

Returns the number of rows in the table

protected Element getEventTargetCell (Event event)

Determines the TD associated with the specified event.

Parameters

event	the event to be queried

Returns

the TD associated with the event, or null if none is found.

protected void insertCell (int row, int column)

Inserts a new cell into the specified row.

Parameters

row	the row into which the new cell will be inserted
column	the column before which the cell will be inserted

Throws

IndexOutOfBoundsException

protected void insertCells (int row, int column, int count)

Inserts a number of cells before the specified cell.

Parameters

row	the row into which the new cells will be inserted
column	the column before which the new cells will be inserted
count	number of cells to be inserted

Throws

IndexOutOfBoundsException

protected int insertRow (int beforeRow)

Inserts a new row into the table.

Parameters

beforeRow	the index before which the new row will be inserted

Returns

the index of the newly-created row

Throws

IndexOutOfBoundsException

protected boolean internalClearCell (Element td, boolean clearInnerHTML)

Does actual clearing, used by clearCell and cleanCell. All HTMLTable methods should use internalClearCell rather than clearCell, as clearCell may be overridden in subclasses to format an empty cell.

Parameters

td	element to clear
clearInnerHTML	should the cell's inner html be cleared?

Returns

returns whether a widget was cleared

protected void onEnsureDebugId (String baseID)

Affected Elements:

-(row)#-(cell)# = the cell at the given row and cell index.

Parameters

baseID	the base ID used by the main element

protected abstract void prepareCell (int row, int column)

Subclasses must implement this method. It allows them to decide what to do just before a cell is accessed. If the cell already exists, this method must do nothing. Otherwise, a subclass must either ensure that the cell exists or throw an IndexOutOfBoundsException.

Parameters

row	the cell's row
column	the cell's column

protected void prepareColumn (int column)

Subclasses can implement this method. It allows them to decide what to do just before a column is accessed. For classes, such as FlexTable, that do not have a concept of a global column length can ignore this method.

Parameters

column	the cell's column

Throws

IndexOutOfBoundsException

protected abstract void prepareRow (int row)

Subclasses must implement this method. If the row already exists, this method must do nothing. Otherwise, a subclass must either ensure that the row exists or throw an IndexOutOfBoundsException.

Parameters

row	the cell's row

protected void removeCell (int row, int column)

Removes the specified cell from the table.

Parameters

row	the row of the cell to remove
column	the column of cell to remove

Throws

IndexOutOfBoundsException

protected void removeRow (int row)

Removes the specified row from the table.

Parameters

row	the index of the row to be removed

Throws

IndexOutOfBoundsException

protected void setCellFormatter (HTMLTable.CellFormatter cellFormatter)

Sets the table's CellFormatter.

Parameters

cellFormatter	the table's cell formatter

protected void setColumnFormatter (HTMLTable.ColumnFormatter formatter)

protected void setRowFormatter (HTMLTable.RowFormatter rowFormatter)

Sets the table's RowFormatter.

Parameters

rowFormatter	the table's row formatter

Interfaces

Classes

Annotations

Enums

Exceptions

HTMLTable

Class Overview

Summary

Public Constructors

public HTMLTable ()

Public Methods

public HandlerRegistration addClickHandler (ClickHandler handler)

Parameters

Returns

public HandlerRegistration addDoubleClickHandler (DoubleClickHandler handler)

Parameters

Returns

public void addTableListener (TableListener listener)

Parameters

public void clear ()

public void clear (boolean clearInnerHTML)

Parameters

public boolean clearCell (int row, int column)

Parameters

Returns

Throws

public abstract int getCellCount (int row)

Parameters

Returns

public HTMLTable.Cell getCellForEvent (ClickEvent event)

Parameters

Returns

public HTMLTable.CellFormatter getCellFormatter ()

Returns

public int getCellPadding ()

Returns

public int getCellSpacing ()

Returns

public HTMLTable.ColumnFormatter getColumnFormatter ()

Returns

public String getHTML (int row, int column)

Parameters

Returns

Throws

public abstract int getRowCount ()

Returns

public HTMLTable.RowFormatter getRowFormatter ()

Returns

public String getText (int row, int column)

Parameters

Returns

Throws

public Widget getWidget (int row, int column)

Parameters

Returns

Throws

public boolean isCellPresent (int row, int column)

Parameters

Returns

public Iterator<Widget> iterator ()

Returns

public boolean remove (Widget widget)

Parameters

Returns

public void removeTableListener (TableListener listener)

Parameters

public void setBorderWidth (int width)

Parameters

public void setCellPadding (int padding)

Parameters

public void setCellSpacing (int spacing)

Parameters

public void setHTML (int row, int column, SafeHtml html)

Parameters

Throws

public void setHTML (int row, int column, String html)

Parameters

Throws

public void setText (int row, int column, String text)

Parameters