com.google.gwt.user.client.ui
Class HTMLTable

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

All Implemented Interfaces:

HasClickHandlers, HasHandlers, EventListener, HasWidgets, SourcesTableEvents, java.lang.Iterable<Widget>

Direct Known Subclasses:

FlexTable, Grid

public abstract class HTMLTable
extends Panel
implements SourcesTableEvents, HasClickHandlers

HTMLTable contains the common table algorithms for Grid and FlexTable.

Nested Class Summary

class	HTMLTable.Cell Return value for getCellForEvent(com.google.gwt.event.dom.client.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.

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

HTMLTable()
Create a new empty HTML Table.

Method Summary

HandlerRegistration	addClickHandler(ClickHandler handler) Adds a ClickEvent handler.
void	addTableListener(TableListener listener) 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.
java.lang.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.
java.lang.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.
java.util.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) Deprecated. Use the HandlerRegistration.removeHandler() method on the object returned by an add*Handler 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, java.lang.String html) Sets the HTML contents of the specified cell.
void	setText(int row, int column, java.lang.String text) Sets the text within the specified cell.
void	setWidget(int row, int column, Widget widget) Sets the widget within the specified cell.

Methods inherited from class com.google.gwt.user.client.ui.Panel

add

Methods inherited from class com.google.gwt.user.client.ui.Widget

fireEvent, getLayoutData, getParent, isAttached, onBrowserEvent, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, toString, unsinkEvents

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

HTMLTable

public HTMLTable()

Create a new empty HTML Table.

Method Detail

addClickHandler

public HandlerRegistration addClickHandler(ClickHandler handler)

Description copied from interface: HasClickHandlers

Adds a ClickEvent handler.

Specified by:

addClickHandler in interface HasClickHandlers

Parameters:

handler - the click handler

Returns:

HandlerRegistration used to remove this handler

addTableListener

@Deprecated
public void addTableListener(TableListener listener)

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.

Specified by:

addTableListener in interface SourcesTableEvents

Parameters:

listener - listener to add

clear

public void clear()

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

Specified by:

clear in interface HasWidgets

Overrides:

clear in class Panel

clear

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?

clearCell

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:

java.lang.IndexOutOfBoundsException

getCellCount

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

getCellForEvent

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

getCellFormatter

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

getCellPadding

public int getCellPadding()

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

Returns:

the cell padding, in pixels

getCellSpacing

public int getCellSpacing()

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

Returns:

the cell spacing, in pixels

getColumnFormatter

public HTMLTable.ColumnFormatter getColumnFormatter()

Gets the column formatter.

Returns:

the column formatter

getHTML

public java.lang.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:

java.lang.IndexOutOfBoundsException

getRowCount

public abstract int getRowCount()

Gets the number of rows present in this table.

Returns:

the table's row count

getRowFormatter

public HTMLTable.RowFormatter getRowFormatter()

Gets the RowFormatter associated with this table.

Returns:

the table's row formatter

getText

public java.lang.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:

java.lang.IndexOutOfBoundsException

getWidget

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:

java.lang.IndexOutOfBoundsException

isCellPresent

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

iterator

public java.util.Iterator<Widget> iterator()

Returns an iterator containing all the widgets in this table.

Specified by:

iterator in interface HasWidgets

Specified by:

iterator in interface java.lang.Iterable<Widget>

Returns:

the iterator

remove

public boolean remove(Widget widget)

Remove the specified widget from the table.

Specified by:

remove in interface HasWidgets

Specified by:

remove in class Panel

Parameters:

widget - widget to remove

Returns:

was the widget removed from the table.

removeTableListener

@Deprecated
public void removeTableListener(TableListener listener)

Deprecated. Use the HandlerRegistration.removeHandler() method on the object returned by an add*Handler method instead

Removes the specified table listener.

Specified by:

removeTableListener in interface SourcesTableEvents

Parameters:

listener - listener to remove

setBorderWidth

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

setCellPadding

public void setCellPadding(int padding)

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

Parameters:

padding - the cell padding, in pixels

setCellSpacing

public void setCellSpacing(int spacing)

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

Parameters:

spacing - the cell spacing, in pixels

setHTML

public void setHTML(int row,
                    int column,
                    java.lang.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:

java.lang.IndexOutOfBoundsException

setText

public void setText(int row,
                    int column,
                    java.lang.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:

java.lang.IndexOutOfBoundsException

setWidget

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:

widget - The widget to be added

row - the cell's row

column - the cell's column

Throws:

java.lang.IndexOutOfBoundsException