org.overlord.commons.gwt.client.local.widgets

Class SortableTemplatedWidgetTable

java.lang.Object

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

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

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

org.overlord.commons.gwt.client.local.widgets.WidgetTable

org.overlord.commons.gwt.client.local.widgets.TemplatedWidgetTable

org.overlord.commons.gwt.client.local.widgets.SortableTemplatedWidgetTable

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.HasHTML, com.google.gwt.user.client.ui.HasText, 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.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>, TableSortEvent.HasTableSortHandlers

public abstract class SortableTemplatedWidgetTable
extends TemplatedWidgetTable
implements TableSortEvent.HasTableSortHandlers

Extends the templated widget table to add support for column sorting.

Author:

eric.wittmann@redhat.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SortableTemplatedWidgetTable.SortColumn

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

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

Field Summary

Fields inherited from class org.overlord.commons.gwt.client.local.widgets.WidgetTable

children, columnClasses, columnCount, rowElements, tbody, thead, wrapperMap

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
SortableTemplatedWidgetTable() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addTableSortHandler(TableSortEvent.Handler handler) Adds a handler to the widget.
protected void	configureColumnSorting() Subclasses have an opportunity here to configure which columns can be used to sort.
protected void	doAttachInit() Called when the table is attached.
SortableTemplatedWidgetTable.SortColumn	getCurrentSortColumn()
abstract SortableTemplatedWidgetTable.SortColumn	getDefaultSortColumn()
protected void	onColumnHeaderClick(String columnId) Called when the user clicks on one of the column headers.
void	setColumnSortable(int columnIndex, String columnId) Sets a column in the table to be sortable.
void	sortBy(String columnId, boolean ascending) Sets the current sort-by column.
void	sortBy(String columnId, boolean ascending, boolean fireEvent) Sets the current sort-by column.

Methods inherited from class org.overlord.commons.gwt.client.local.widgets.TemplatedWidgetTable

getHTML, getText, init, postContruct, removeAllChildNodes, setHTML, setText

Methods inherited from class org.overlord.commons.gwt.client.local.widgets.WidgetTable

add, add, clear, deleteRow, getRow, getRowCount, iterator, remove, setColumnClasses, setColumnLabels

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

add, adopt, adopt, disown, 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

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, unsinkEvents

Methods inherited from class java.lang.Object

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

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

fireEvent

Constructor Detail

SortableTemplatedWidgetTable

public SortableTemplatedWidgetTable()

Constructor.

Method Detail

doAttachInit

protected void doAttachInit()

Description copied from class: TemplatedWidgetTable

Called when the table is attached. This is here to better support the WidgetTable in an Errai UI template. This method will grab the thead and tbody from the template. In addition, it will remove all of the tr children from the tbody.

Overrides:

doAttachInit in class TemplatedWidgetTable

See Also:

TemplatedWidgetTable.doAttachInit()

configureColumnSorting

protected void configureColumnSorting()

Subclasses have an opportunity here to configure which columns can be used to sort.

addTableSortHandler

public com.google.gwt.event.shared.HandlerRegistration addTableSortHandler(TableSortEvent.Handler handler)

Description copied from interface: TableSortEvent.HasTableSortHandlers

Adds a handler to the widget.

Specified by:

addTableSortHandler in interface TableSortEvent.HasTableSortHandlers

See Also:

org.overlord.sramp.ui.client.local.events.TableSortEvent.HasTableSortHandlers#addTableSortHandler(org.overlord.sramp.ui.client.local.events.TableSortEvent.Handler)

setColumnSortable

public void setColumnSortable(int columnIndex,
                     String columnId)

Sets a column in the table to be sortable. This will convert the content in the "th" to be something the user can click on. When the user clicks on it, the internal state of the table will be altered *and* an event will be fired.

Parameters:

columnIndex -

columnId -

sortBy

public void sortBy(String columnId,
          boolean ascending)

Sets the current sort-by column. Does not trigger an event.

Parameters:

columnId -

ascending -

sortBy

public void sortBy(String columnId,
          boolean ascending,
          boolean fireEvent)

Sets the current sort-by column.

Parameters:

columnId -

ascending -

fireEvent -

onColumnHeaderClick

protected void onColumnHeaderClick(String columnId)

Called when the user clicks on one of the column headers.

Parameters:

columnId -

getCurrentSortColumn

public SortableTemplatedWidgetTable.SortColumn getCurrentSortColumn()

Returns:

the current sort column

getDefaultSortColumn

public abstract SortableTemplatedWidgetTable.SortColumn getDefaultSortColumn()

Returns:

the default sort column