net.sf.mmm.client.ui.impl.gwt.widget.complex.adapter

Class UiWidgetAdapterGwtAbstractDataTable<ROW>

java.lang.Object

net.sf.mmm.client.ui.base.widget.adapter.AbstractUiWidgetAdapter<WIDGET>

net.sf.mmm.client.ui.base.widget.adapter.AbstractUiWidgetAdapterWithEvents<WIDGET,EventAdapterGwt>

net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwt<WIDGET>

net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtWidget<WIDGET>

net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtWidgetActive<com.google.gwt.user.client.ui.FlowPanel>

net.sf.mmm.client.ui.impl.gwt.widget.complex.adapter.UiWidgetAdapterGwtAbstractDataTable<ROW>

Type Parameters:

ROW - is the generic type of a row in the list.

All Implemented Interfaces:

AttributeReadAccessKey, AttributeReadAltText, AttributeReadAttribute, AttributeReadColumnSpan, AttributeReadEnabled, AttributeReadFocused, AttributeReadHeightInRows, AttributeReadHtmlId, AttributeReadImage<UiWidgetImage>, AttributeReadKeyboardFilter, AttributeReadLabel, AttributeReadLengthProperty, AttributeReadMaximumTextLength, AttributeReadPrimaryStyle, AttributeReadResizable, AttributeReadSelectionMode, AttributeReadSizeInPixel, AttributeReadStringTitle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadSummary, AttributeReadTitleVisible, AttributeReadTooltip, AttributeReadUrl, AttributeReadValidationFailure, AttributeWriteAccessKey, AttributeWriteAttribute, AttributeWriteEnabled, AttributeWriteFocused, AttributeWriteHtmlId, AttributeWriteImage<UiWidgetImage>, AttributeWriteKeyboardFilter, AttributeWriteLengthProperty, AttributeWriteOnlyAttribute, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteSelectionMode, AttributeWriteStringTitle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteSummary, AttributeWriteTitleVisible, AttributeWriteTooltip, UiWidgetAdapter, UiWidgetAdapterActive, UiWidgetAdapterAbstractDataSet<ROW>, UiWidgetAdapterAbstractDataTable<ROW>, HandlerRegistrationCollector, AttributeReadDisposed, AttributeReadId<String>, AttributeReadTitle<String>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteTitle<String>, Accessibility

Direct Known Subclasses:

UiWidgetAdapterGwtAbstractListTable

public abstract class UiWidgetAdapterGwtAbstractDataTable<ROW>
extends UiWidgetAdapterGwtWidgetActive<com.google.gwt.user.client.ui.FlowPanel>
implements UiWidgetAdapterAbstractDataTable<ROW>

This is the implementation of UiWidgetAdapterAbstractDataTable using GWT based on FlowPanel and TableWidget.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private TableRow	bodyWidthRow
private List<AbstractUiWidgetTableColumn<?,ROW,?>>	columns
private TableCellHeaderAtomic	headerCellSelection
private com.google.gwt.user.client.ui.SimpleCheckBox	headerMultiSelectionWidget
private TableRow	headerRow
private com.google.gwt.user.client.ui.RadioButton	headerSingleSelectionWidget
private Section	section
private com.google.gwt.dom.client.StyleElement	styleElement
private TableWidget	tableWidget

Fields inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwt

TAB_INDEX_NONE

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

HTML_ATTRIBUTE_ID, ID_SEPARATOR, PROPERTY_ID

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

PROPERTY_STYLES, STYLE_PATTERN_MULTIPLE, STYLE_PATTERN_SINGLE

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

ACCESS_KEY_NONE, HTML_ATTRIBUTE_ACCESS_KEY

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

PROPERTY_SUMMARY

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

PROPERTY_TITLE

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

PROPERTY_LABEL

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

ATTRIBUTE_COLSPAN

Constructor Summary

Constructors

Constructor and Description
UiWidgetAdapterGwtAbstractDataTable() The constructor.

Method Summary

Modifier and Type	Method and Description
private void	addColumn(AbstractUiWidgetTableColumn<?,ROW,?> column, int columnIndex) Adds the given column to this table.
UiWidgetAdapterTableColumn	createTableColumnAdapter(UiWidgetTableColumn<?,?> column)
protected com.google.gwt.user.client.ui.FlowPanel	createToplevelWidget() This method creates the underlying widget.
void	dragColumn(AbstractUiWidgetTableColumn<?,ROW,?> dragColumn, AbstractUiWidgetTableColumn<?,ROW,?> dropColumn)
List<AbstractUiWidgetTableColumn<?,ROW,?>>	getColumns()
TableCellHeaderAtomic	getHeaderCellSelection()
private com.google.gwt.user.client.ui.SimpleCheckBox	getHeaderMultiSelectionWidget()
private com.google.gwt.user.client.ui.RadioButton	getHeaderSingleSelectionWidget()
Section	getSection()
SelectionMode	getSelectionMode() This method gets the SelectionMode.
com.google.gwt.dom.client.StyleElement	getStyleElement()
String	getSummary() This method gets the summary of this object.
protected TableWidget	getTableWidget()
AbstractUiWidgetAbstractDataTable<?,?,ROW,ItemContainerGwt<ROW>>	getUiWidgetTyped() This method is a design suggestion for implementations of widget adapters that need typed access to AbstractUiWidgetAdapter.getUiWidget() and want to perform the cast only in a single place.
protected static UiWidgetAdapterGwtTableColumn	getWidgetAdapterForColumn(UiWidgetTableColumn<?,?> column)
protected com.google.gwt.user.client.ui.Focusable	getWidgetAsFocusable()
protected com.google.gwt.event.dom.client.HasAllFocusHandlers	getWidgetAsHasAllFocusHandlers()
protected com.google.gwt.event.dom.client.HasKeyPressHandlers	getWidgetAsKeyPressHandlers()
boolean	isTitleVisible() This method determines if the title of this object is visible.
void	setColumns(List<AbstractUiWidgetTableColumn<?,ROW,?>> columns)
void	setEnabled(boolean enabled) This method sets the enabled status of this object.
void	setSelectionMode(SelectionMode selectionMode) This method sets the selection mode.
void	setSummary(String summary) This method sets the summary of this object.
void	setTitle(String title) This method sets the title of this object.
void	setTitleVisible(boolean titleVisible) This method sets the titleVisible flag of this object.
void	sort(AbstractUiWidgetTableColumn<?,ROW,?> column, SortOrder sortOrder)

Methods inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtWidgetActive

applyEventAdapterForClick, applyEventAdapterForFocus, getKeyboardFilter, getWidgetAsHasBlurHandlers, getWidgetAsHasFocusHandlers, setAccessKey, setClickEventSender, setFocused, setKeyboardFilter

Methods inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtWidget

dispose, getActiveWidget, removeFromParent

Methods inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwt

addHandlerRegistration, addStyle, createAbsoluteImageUrl, createEventAdapter, getHeightInPixel, getImage, getImageParentElement, getLength, getSizeElement, getToplevelWidget, getToplevelWidget, getWidthInPixel, isStyleDeltaSupported, removeStyle, setAttribute, setId, setImage, setLength, setPrimaryStyle, setStyles, setTooltip, setVisible

Methods inherited from class net.sf.mmm.client.ui.base.widget.adapter.AbstractUiWidgetAdapterWithEvents

applyEventAdapter, applyEventAdapterForChange, applyEventAdapterForSelection, getEventAdapter, setEventSender

Methods inherited from class net.sf.mmm.client.ui.base.widget.adapter.AbstractUiWidgetAdapter

createLabel, getAccessKey, getAltText, getAttribute, getBundle, getColumnSpan, getContext, getHeightInRows, getId, getLabel, getMaximumTextLength, getPrimaryStyle, getStyles, getTitle, getTooltip, getToplevelWidget, getUiWidget, getUrl, getValidationFailure, hasStyle, isDisposed, isEnabled, isFocused, isResizable, setMode, setParent, setUiWidget

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.client.ui.base.widget.adapter.UiWidgetAdapter

createAbsoluteImageUrl, createLabel, getToplevelWidget, isStyleDeltaSupported, removeFromParent, setEventSender, setMode, setParent, setVisible

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteHtmlId

setId

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadHtmlId

getId

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteTooltip

setTooltip

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadTooltip

getTooltip

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadEnabled

isEnabled

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteStylesAdvanced

addStyle, removeStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStylesAdvanced

hasStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteStyles

setStyles

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStyles

getStyles

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWritePrimaryStyle

setPrimaryStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadPrimaryStyle

getPrimaryStyle

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeWriteDisposed

dispose

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeReadDisposed

isDisposed

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteLengthProperty

setLength

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadLengthProperty

getLength

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadSizeInPixel

getHeightInPixel, getWidthInPixel

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadAttribute

getAttribute

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteOnlyAttribute

setAttribute

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadFocused

isFocused

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteOnlyFocused

setFocused

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteAccessKey

setAccessKey

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadAccessKey

getAccessKey

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStringTitle

getTitle

Field Detail

tableWidget

private TableWidget tableWidget

See Also:

getTableWidget()

section

private Section section

See Also:

getSection()

columns

private List<AbstractUiWidgetTableColumn<?,ROW,?>> columns

See Also:

setColumns(List)

styleElement

private com.google.gwt.dom.client.StyleElement styleElement

See Also:

getStyleElement()

headerRow

private TableRow headerRow

See Also:

setColumns(List)

bodyWidthRow

private TableRow bodyWidthRow

See Also:

setColumns(List)

headerMultiSelectionWidget

private com.google.gwt.user.client.ui.SimpleCheckBox headerMultiSelectionWidget

See Also:

getHeaderMultiSelectionWidget()

headerSingleSelectionWidget

private com.google.gwt.user.client.ui.RadioButton headerSingleSelectionWidget

See Also:

getHeaderSingleSelectionWidget()

headerCellSelection

private TableCellHeaderAtomic headerCellSelection

See Also:

getHeaderCellSelection()

Constructor Detail

UiWidgetAdapterGwtAbstractDataTable

public UiWidgetAdapterGwtAbstractDataTable()

The constructor.

Method Detail

createTableColumnAdapter

public UiWidgetAdapterTableColumn createTableColumnAdapter(UiWidgetTableColumn<?,?> column)

Specified by:

createTableColumnAdapter in interface UiWidgetAdapterAbstractDataTable<ROW>

Parameters:

column - is the UiWidgetTableColumn for which to create the widget adapter.

Returns:

a new UiWidgetAdapterTableColumn for the given UiWidgetTableColumn.

getColumns

public List<AbstractUiWidgetTableColumn<?,ROW,?>> getColumns()

Returns:

the columns

setColumns

public void setColumns(List<AbstractUiWidgetTableColumn<?,ROW,?>> columns)

Specified by:

setColumns in interface UiWidgetAdapterAbstractDataTable<ROW>

Parameters:

columns - are the columns to set.

See Also:

net.sf.mmm.client.ui.api.widget.complex.UiWidgetAbstractDataTable#setColumns(UiWidgetTableColumn...)

addColumn

private void addColumn(AbstractUiWidgetTableColumn<?,ROW,?> column,
                       int columnIndex)

Adds the given column to this table.

Parameters:

column - is the actual column widget.

columnIndex - is the current column index.

getWidgetAdapterForColumn

protected static UiWidgetAdapterGwtTableColumn getWidgetAdapterForColumn(UiWidgetTableColumn<?,?> column)

Parameters:

column - is the UiWidgetTableColumn.

Returns:

the widget adapter for the given column.

getStyleElement

public com.google.gwt.dom.client.StyleElement getStyleElement()

Returns:

the styleElement

getUiWidgetTyped

public AbstractUiWidgetAbstractDataTable<?,?,ROW,ItemContainerGwt<ROW>> getUiWidgetTyped()

This method is a design suggestion for implementations of widget adapters that need typed access to AbstractUiWidgetAdapter.getUiWidget() and want to perform the cast only in a single place. If you would override AbstractUiWidgetAdapter.getUiWidget() to add the cast and do that multiple times across the inheritance hierarchy this would cause multiple/unnecessary casts. Casting is required as we already declare enough generics for widget adapters and also want to keep the code more flexible.

Overrides:

getUiWidgetTyped in class AbstractUiWidgetAdapter<com.google.gwt.user.client.ui.FlowPanel>

Returns:

the UiWidget potentially specifically typed.

sort

public void sort(AbstractUiWidgetTableColumn<?,ROW,?> column,
                 SortOrder sortOrder)

Specified by:

sort in interface UiWidgetAdapterAbstractDataTable<ROW>

Parameters:

column - is the column to sort by.

sortOrder - is the SortOrder.

See Also:

AbstractUiWidgetTableColumn.sort(SortOrder)

dragColumn

public void dragColumn(AbstractUiWidgetTableColumn<?,ROW,?> dragColumn,
                       AbstractUiWidgetTableColumn<?,ROW,?> dropColumn)

Specified by:

dragColumn in interface UiWidgetAdapterAbstractDataTable<ROW>

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.

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.

setEnabled

public void setEnabled(boolean enabled)

This method sets the enabled status of this object. If it is disabled, the user can not interact with the object.

Specified by:

setEnabled in interface AttributeWriteEnabled

Parameters:

enabled - - if true the object will be enabled, else the object will be disabled.

setTitle

public void setTitle(String title)

This method sets the title of this object.

Specified by:

setTitle in interface AttributeWriteStringTitle

Specified by:

setTitle in interface AttributeWriteTitle<String>

Parameters:

title - is the new title.

See Also:

AttributeReadStringTitle.getTitle()

setTitleVisible

public void setTitleVisible(boolean titleVisible)

This method sets the titleVisible flag of this object.

Specified by:

setTitleVisible in interface AttributeWriteTitleVisible

Parameters:

titleVisible - is the new value for AttributeReadTitleVisible.isTitleVisible().

isTitleVisible

public boolean isTitleVisible()

This method determines if the title of this object is visible. For Accessibility reasons you should always set the title of a titled object. However in specific cases you want to save space on the screen and may not require the title to be displayed for seeing users. Then you can hide the title while it is still recognized by assistive technology such as screen readers.

Specified by:

isTitleVisible in interface AttributeReadTitleVisible

Returns:

true if visible, false if hidden.

getSelectionMode

public SelectionMode getSelectionMode()

This method gets the SelectionMode.

Specified by:

getSelectionMode in interface AttributeReadSelectionMode

Overrides:

getSelectionMode in class AbstractUiWidgetAdapter<com.google.gwt.user.client.ui.FlowPanel>

Returns:

the SelectionMode. Must not be null.

setSelectionMode

public void setSelectionMode(SelectionMode selectionMode)

This method sets the selection mode.
ATTENTION:
It is recommended to set the SelectionMode immediately after creating the object. The initial default is always SelectionMode.SINGLE_SELECTION. Dynamically changing the SelectionMode may be expensive or not be supported (in exotic implementations) and should therefore be avoided.

Specified by:

setSelectionMode in interface AttributeWriteSelectionMode

Parameters:

selectionMode - is the new SelectionMode.

getWidgetAsFocusable

protected com.google.gwt.user.client.ui.Focusable getWidgetAsFocusable()

Specified by:

getWidgetAsFocusable in class UiWidgetAdapterGwtWidgetActive<com.google.gwt.user.client.ui.FlowPanel>

Returns:

the widget as Focusable or null if NOT supported.

getWidgetAsKeyPressHandlers

protected com.google.gwt.event.dom.client.HasKeyPressHandlers getWidgetAsKeyPressHandlers()

Specified by:

getWidgetAsKeyPressHandlers in class UiWidgetAdapterGwtWidgetActive<com.google.gwt.user.client.ui.FlowPanel>

Returns:

the widget as HasKeyPressHandlers or null if NOT supported.

getWidgetAsHasAllFocusHandlers

protected com.google.gwt.event.dom.client.HasAllFocusHandlers getWidgetAsHasAllFocusHandlers()

Specified by:

getWidgetAsHasAllFocusHandlers in class UiWidgetAdapterGwtWidgetActive<com.google.gwt.user.client.ui.FlowPanel>

Returns:

the widget as HasAllFocusHandlers or null if NOT supported.

createToplevelWidget

protected com.google.gwt.user.client.ui.FlowPanel createToplevelWidget()

This method creates the underlying widget.
ATTENTION:
This method is called from the constructor but implemented in sub-classes. You should NOT access or even modify member variables as they are NOT set at this point (even final members). However, this design is done by intention instead of passing the widget as constructor argument to give more flexibility by overriding and also for potential lazy initialization of the widget.

Specified by:

createToplevelWidget in class AbstractUiWidgetAdapter<com.google.gwt.user.client.ui.FlowPanel>

Returns:

a new instance of the underlying widget.

getHeaderCellSelection

public TableCellHeaderAtomic getHeaderCellSelection()

Returns:

the headerCellSelection

getHeaderSingleSelectionWidget

private com.google.gwt.user.client.ui.RadioButton getHeaderSingleSelectionWidget()

Returns:

the single selection widget used in the header.

getHeaderMultiSelectionWidget

private com.google.gwt.user.client.ui.SimpleCheckBox getHeaderMultiSelectionWidget()

Returns:

the SimpleCheckBox for the multi-selection in the header to select / deselect all.

getSection

public Section getSection()

Returns:

the Section.

getTableWidget

protected TableWidget getTableWidget()

Returns:

the TableWidget for the actual data table.