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

Class UiWidgetAdapterGwtTableColumn

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<TableCellHeaderAtomic>

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

All Implemented Interfaces:

AttributeReadAccessKey, AttributeReadAltText, AttributeReadAttribute, AttributeReadColumnSpan, AttributeReadEnabled, AttributeReadFocused, AttributeReadHeightInRows, AttributeReadHtmlId, AttributeReadImage<UiWidgetImage>, AttributeReadLabel, AttributeReadLengthProperty, AttributeReadMaximumTextLength, AttributeReadPrimaryStyle, AttributeReadReorderable, AttributeReadResizable, AttributeReadSelectionMode, AttributeReadSizeInPixel, AttributeReadSortable, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadUrl, AttributeReadValidationFailure, AttributeWriteAttribute, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteImage<UiWidgetImage>, AttributeWriteLengthProperty, AttributeWriteOnlyAttribute, AttributeWritePrimaryStyle, AttributeWriteReorderable, AttributeWriteResizable, AttributeWriteSortable, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, UiWidgetAdapter, UiWidgetAdapterTableColumn, HandlerRegistrationCollector, AttributeReadDisposed, AttributeReadId<String>, AttributeReadTitle<String>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteTitle<String>, Accessibility

public class UiWidgetAdapterGwtTableColumn
extends UiWidgetAdapterGwtWidget<TableCellHeaderAtomic>
implements UiWidgetAdapterTableColumn

This is the implementation of UiWidgetAdapterTableColumn using GWT.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	UiWidgetAdapterGwtTableColumn.ColumnWidthRange Container for the range of the width of a column.
private class	UiWidgetAdapterGwtTableColumn.ReorderHandler Handler for the reorder behavior of this column.
private class	UiWidgetAdapterGwtTableColumn.ResizeHandler Handler for the resize behavior of this column.

Field Summary

Fields

Modifier and Type	Field and Description
private TableCellAtomic	bodyWidthCell
private UiWidgetAdapterGwtAbstractDataTable<?>	dataTableAdapter
private com.google.gwt.user.client.ui.FlowPanel	divContainer Required for layout due to HTML obstracles.
private UiWidgetWithValue<?>	editWidget
private com.google.gwt.user.client.ui.Label	headerLabel
private boolean	reorderable
private boolean	resizable
private CssDivWidget	resizeWidget
private CssIconWidget	sortIcon

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

PROPERTY_LABEL

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

ATTRIBUTE_COLSPAN

Constructor Summary

Constructors

Constructor and Description
UiWidgetAdapterGwtTableColumn(UiWidgetAdapterGwtAbstractDataTable<?> dataTableAdapter) The constructor.
UiWidgetAdapterGwtTableColumn(UiWidgetAdapterGwtAbstractDataTable<?> dataTableAdapter, TableCellHeaderAtomic toplevelWidget) The constructor.

Method Summary

Modifier and Type	Method and Description
protected TableCellHeaderAtomic	createToplevelWidget() This method creates the underlying widget.
TableCellAtomic	getBodyWidthCell()
UiWidgetAdapterGwtAbstractDataTable<?>	getDataTableAdapter()
UiWidgetWithValue<?>	getEditWidget()
com.google.gwt.user.client.ui.Label	getHeaderLabel()
Length	getLength(LengthProperty property) This method gets the Length for the given LengthProperty of this object.
protected AbstractUiWidgetTableColumn<?,?,?>	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.
boolean	isReorderable() This method determines if this object can be reordered.
boolean	isSortable() This method determines if this object can be sorted.
void	setEditWidget(UiWidgetWithValue<?> editWidget)
void	setEnabled(boolean enabled) This method sets the enabled status of this object.
void	setLength(LengthProperty property, Length length) This method sets the specified length of this object.
void	setReorderable(boolean reorderable) This method sets the reorderable attribute.
void	setResizable(boolean resizable) This method sets the resizable attribute.
void	setSortable(boolean sortable) This method sets the sortable attribute.
void	setSortOrder(SortOrder sortOrder)
void	setTitle(String title) This method sets the title of this object.

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, getSizeElement, getToplevelWidget, getToplevelWidget, getWidthInPixel, isStyleDeltaSupported, removeStyle, setAttribute, setId, setImage, setPrimaryStyle, setStyles, setTooltip, setVisible

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

applyEventAdapter, applyEventAdapterForChange, applyEventAdapterForClick, applyEventAdapterForFocus, 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, getSelectionMode, 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.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.util.lang.api.attribute.AttributeReadTitle

getTitle

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

isResizable

Field Detail

divContainer

private com.google.gwt.user.client.ui.FlowPanel divContainer

Required for layout due to HTML obstracles.

headerLabel

private com.google.gwt.user.client.ui.Label headerLabel

See Also:

getHeaderLabel()

sortIcon

private CssIconWidget sortIcon

See Also:

setSortOrder(SortOrder)

resizeWidget

private CssDivWidget resizeWidget

See Also:

setResizable(boolean)

bodyWidthCell

private final TableCellAtomic bodyWidthCell

See Also:

getBodyWidthCell()

dataTableAdapter

private final UiWidgetAdapterGwtAbstractDataTable<?> dataTableAdapter

See Also:

getDataTableAdapter()

resizable

private boolean resizable

See Also:

setResizable(boolean)

reorderable

private boolean reorderable

See Also:

setReorderable(boolean)

editWidget

private UiWidgetWithValue<?> editWidget

See Also:

getEditWidget()

Constructor Detail

UiWidgetAdapterGwtTableColumn

public UiWidgetAdapterGwtTableColumn(UiWidgetAdapterGwtAbstractDataTable<?> dataTableAdapter)

The constructor.

Parameters:

dataTableAdapter - is the data table adapter.

UiWidgetAdapterGwtTableColumn

public UiWidgetAdapterGwtTableColumn(UiWidgetAdapterGwtAbstractDataTable<?> dataTableAdapter,
                                     TableCellHeaderAtomic toplevelWidget)

The constructor.

Parameters:

toplevelWidget - is the toplevel widget.

dataTableAdapter - is the data table adapter.

Method Detail

createToplevelWidget

protected TableCellHeaderAtomic 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<TableCellHeaderAtomic>

Returns:

a new instance of the underlying widget.

getBodyWidthCell

public TableCellAtomic getBodyWidthCell()

Returns:

the bodyWidthCell

getHeaderLabel

public com.google.gwt.user.client.ui.Label getHeaderLabel()

Returns:

the headerLabel

getDataTableAdapter

public UiWidgetAdapterGwtAbstractDataTable<?> getDataTableAdapter()

Returns:

the dataTableAdapter

setSortOrder

public void setSortOrder(SortOrder sortOrder)

Specified by:

setSortOrder in interface UiWidgetAdapterTableColumn

Parameters:

sortOrder - is the SortOrder or null for none.

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 AttributeWriteTitle<String>

Parameters:

title - is the new title to set.

setResizable

public void setResizable(boolean resizable)

This method sets the resizable attribute.

Specified by:

setResizable in interface AttributeWriteResizable

Parameters:

resizable - is the new value of AttributeReadResizable.isResizable().

isReorderable

public boolean isReorderable()

This method determines if this object can be reordered.

Specified by:

isReorderable in interface AttributeReadReorderable

Returns:

true if the object can be reordered (by the end-user) - typically via drag and drop, false otherwise.

setReorderable

public void setReorderable(boolean reorderable)

This method sets the reorderable attribute.

Specified by:

setReorderable in interface AttributeWriteReorderable

Parameters:

reorderable - is the new value of AttributeReadReorderable.isReorderable().

isSortable

public boolean isSortable()

This method determines if this object can be sorted.

Specified by:

isSortable in interface AttributeReadSortable

Returns:

true if the object can be sorted (by the end-user) - typically by clicking (e.g. the header of a column), false otherwise.

setSortable

public void setSortable(boolean sortable)

This method sets the sortable attribute.

Specified by:

setSortable in interface AttributeWriteSortable

Parameters:

sortable - is the new value of AttributeReadSortable.isSortable().

getLength

public Length getLength(LengthProperty property)

This method gets the Length for the given LengthProperty of this object.
E.g. the call of getLength(LengthProperty.WIDTH) will return the same result as AttributeReadSize.getWidth(). Unlike AttributeReadSize this method provides access to additional properties such as e.g. LengthProperty.MIN_WIDTH or LengthProperty.MAX_HEIGHT.

Specified by:

getLength in interface AttributeReadLengthProperty

Overrides:

getLength in class UiWidgetAdapterGwt<TableCellHeaderAtomic>

Parameters:

property - is the LengthProperty identifying the actual property to get.

Returns:

the requested Length. Will be Length.ZERO if undefined (NOT set).

setLength

public void setLength(LengthProperty property,
                      Length length)

This method sets the specified length of this object.
E.g. the call of setLength(LengthProperty.WIDTH, value) will return the same result as setWidth(value).

Specified by:

setLength in interface AttributeWriteLengthProperty

Overrides:

setLength in class UiWidgetAdapterGwt<TableCellHeaderAtomic>

Parameters:

property - is the LengthProperty identifying the actual property to set.

length - is the new length to set.

getEditWidget

public UiWidgetWithValue<?> getEditWidget()

Returns:

the UiWidgetWithValue used for inline-editing and as template to create the view widgets in the cells of this column.

setEditWidget

public void setEditWidget(UiWidgetWithValue<?> editWidget)

Parameters:

editWidget - is the editWidget to set

getUiWidgetTyped

protected AbstractUiWidgetTableColumn<?,?,?> 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<TableCellHeaderAtomic>

Returns:

the UiWidget potentially specifically typed.