net.sf.mmm.client.ui.gwt.widgets

Class TableWidget

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.ComplexPanel

net.sf.mmm.client.ui.gwt.widgets.TableWidget

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>, AttributeReadCaption, AttributeReadSummary, AttributeWriteCaption, AttributeWriteSummary, Accessibility

public class TableWidget
extends com.google.gwt.user.client.ui.ComplexPanel
implements AttributeWriteSummary, AttributeWriteCaption

A TableWidget is a CustomPanel that represents a table (<table>). You can Panel.add(com.google.gwt.user.client.ui.Widget) rows to it. It is an alternative to GWTs HTMLTable or Grid.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

getTableBody(), getTableHeader(), getTableFooter()

Nested Class Summary

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

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

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

Field Summary

Fields

Modifier and Type	Field and Description
private Caption	captionWidget
private TableBody	tableBody
private TableFooter	tableFooter
private TableHead	tableHeader

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

DEBUG_ID_PREFIX

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadSummary

PROPERTY_SUMMARY

Fields inherited from interface net.sf.mmm.util.lang.api.concern.Accessibility

WAI_ARIA

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadCaption

PROPERTY_CAPTION

Constructor Summary

Constructors

Constructor and Description
TableWidget() The constructor.

Method Summary

Modifier and Type	Method and Description
String	getCaption() This method gets the caption of this object.
Caption	getCaptionWidget()
String	getSummary() This method gets the summary of this object.
TableBody	getTableBody()
TableFooter	getTableFooter()
TableHead	getTableHeader()
void	setCaption(String caption) This method sets the caption of this object.
void	setSummary(String summary) This method sets the summary of this object.

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

add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

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

add, add, adopt, clear, doAttachChildren, doDetachChildren, orphan, remove

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

tableHeader

private final TableHead tableHeader

See Also:

getTableHeader()

tableBody

private final TableBody tableBody

See Also:

getTableBody()

tableFooter

private final TableFooter tableFooter

See Also:

getTableFooter()

captionWidget

private Caption captionWidget

See Also:

getCaptionWidget()

Constructor Detail

TableWidget

public TableWidget()

The constructor.

Method Detail

getTableBody

public TableBody getTableBody()

Returns:

the table body. Add your content here using TableRows.

getTableHeader

public TableHead getTableHeader()

Returns:

the table header. Add your header information here using one or multiple TableRows.

getTableFooter

public TableFooter getTableFooter()

Returns:

the table footer. Here you can add footer information (e.g. summaries) using one or multiple TableRows.

getSummary

public String getSummary()

This method gets the summary of this object. It describes the main purpose of this object in a short and compact way. A summary might not be visible but is honored by assistive technology such as screen-readers.

Specified by:

getSummary in interface AttributeReadSummary

Returns:

the text. Will be the empty string if no text has been set.

setSummary

public void setSummary(String summary)

This method sets the summary of this object.

Specified by:

setSummary in interface AttributeWriteSummary

Parameters:

summary - is the new summary to set.

getCaptionWidget

public Caption getCaptionWidget()

Returns:

the Caption widget.

getCaption

public String getCaption()

This method gets the caption of this object. A caption is similar to a title. In our APIs we prefer to use the title but in specific contexts we use caption for technical reasons - e.g. if the term is predefined by technology such as HTML.

Specified by:

getCaption in interface AttributeReadCaption

Returns:

the caption text. Will be the empty string if no label has been set.

setCaption

public void setCaption(String caption)

This method sets the caption of this object.

Specified by:

setCaption in interface AttributeWriteCaption

Parameters:

caption - is the new caption to set.