org.gwt.advanced.client.ui.widget.cell

Class HeaderCellImpl

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

org.gwt.advanced.client.ui.widget.cell.AbstractCell

org.gwt.advanced.client.ui.widget.cell.HeaderCellImpl

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.AcceptsOneWidget, com.google.gwt.user.client.ui.HasOneWidget, 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>, GridCell, HeaderCell

public class HeaderCellImpl
extends AbstractCell
implements HeaderCell

This is a header cell implementation.

Since:

1.0.0

Author:

Sergey Skladchikov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	HeaderCellImpl.SortHandler This handler is invoked on sort event.

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

Modifier and Type	Field and Description
static String	SINGLE_IMAGE one pixel image name

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
HeaderCellImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addListeners(com.google.gwt.user.client.ui.Widget widget) This method adds default listeners to the content widget.
protected com.google.gwt.user.client.ui.Widget	createActive() This method creates an active cell element (content).
protected com.google.gwt.user.client.ui.Widget	createInactive() This method creates an inactive cell element (content).
void	displayActive(boolean active) This method shows the cell.
protected com.google.gwt.user.client.ui.FlexTable	getDockPanel() Getter for property 'dockPanel'.
protected com.google.gwt.user.client.ui.Image	getImage() Getter for property 'image'.
Object	getNewValue() This method returns a new value entered while the cell is active.
boolean	isAscending() This method checks whether the column is sorted ascending.
protected boolean	isInitialized() Getter for property 'initialized'.
boolean	isSortable() This method checks whether the column is sortable.
boolean	isSorted() This method checks whether the column is sorted.
protected void	prepare(com.google.gwt.user.client.ui.Widget widget) This method prepares a cell before displaying it.
void	setAscending(boolean ascending) This method sets asceding sort flag value.
void	setFocus(boolean focus) This method sets focus to the cell.
void	setSortable(boolean sortable) This method sets sortable flag value.
void	setSorted(boolean sorted) This method sets sorted flag value.
void	sort() This method changes the current sort order or sets the current column as sorted.

Methods inherited from class org.gwt.advanced.client.ui.widget.cell.AbstractCell

canBeDeactivated, getColumn, getDefaultBlurHandler, getGrid, getLabel, getRow, getValue, isActive, isDefaultFocusListenerAdded, removeListeners, setActive, setGrid, setLabel, setPosition, setValue, valueEqual

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

add, getContainerElement, getWidget, iterator, remove, setWidget, setWidget

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

add, adopt, adopt, clear, 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 org.gwt.advanced.client.ui.widget.cell.GridCell

canBeDeactivated, getColumn, getGrid, getRow, getValue, isActive, setGrid, setPosition, setValue, valueEqual

Field Detail

SINGLE_IMAGE

public static final String SINGLE_IMAGE

one pixel image name

Constructor Detail

HeaderCellImpl

public HeaderCellImpl()

Method Detail

displayActive

public void displayActive(boolean active)

This method shows the cell.

Specified by:

displayActive in interface GridCell

Overrides:

displayActive in class AbstractCell

Parameters:

active - is a flag meaning whether the cell must be shown as active.

createActive

protected com.google.gwt.user.client.ui.Widget createActive()

This method creates an active cell element (content).

Specified by:

createActive in class AbstractCell

Returns:

a content element.

createInactive

protected com.google.gwt.user.client.ui.Widget createInactive()

This method creates an inactive cell element (content).

Specified by:

createInactive in class AbstractCell

Returns:

a content element.

addListeners

protected void addListeners(com.google.gwt.user.client.ui.Widget widget)

This method adds default listeners to the content widget.

Overrides:

addListeners in class AbstractCell

Parameters:

widget - is a content widget.

prepare

protected void prepare(com.google.gwt.user.client.ui.Widget widget)

This method prepares a cell before displaying it.

Overrides:

prepare in class AbstractCell

Parameters:

widget - is a content widget.

setFocus

public void setFocus(boolean focus)

This method sets focus to the cell.

Specified by:

setFocus in interface GridCell

Parameters:

focus - is a flag meaning whether the focus must be set or lost.

getNewValue

public Object getNewValue()

This method returns a new value entered while the cell is active.

If the cell is passive, it is an equivalent of the GridCell.getValue() method.

Specified by:

getNewValue in interface GridCell

Returns:

is a new value.

setSortable

public void setSortable(boolean sortable)

This method sets sortable flag value.

Specified by:

setSortable in interface HeaderCell

Parameters:

sortable - is a sortable flag value.

setAscending

public void setAscending(boolean ascending)

This method sets asceding sort flag value.

Specified by:

setAscending in interface HeaderCell

Parameters:

ascending - is an ascending sort value.

setSorted

public void setSorted(boolean sorted)

This method sets sorted flag value.

Specified by:

setSorted in interface HeaderCell

Parameters:

sorted - is a sorted flag value.

isAscending

public boolean isAscending()

This method checks whether the column is sorted ascending.

Specified by:

isAscending in interface HeaderCell

Returns:

true if the sort order is ascending.

isSortable

public boolean isSortable()

This method checks whether the column is sortable.

Specified by:

isSortable in interface HeaderCell

Returns:

true if the column is sortable.

isSorted

public boolean isSorted()

This method checks whether the column is sorted.

Specified by:

isSorted in interface HeaderCell

Returns:

true if the column is sorted.

sort

public void sort()

This method changes the current sort order or sets the current column as sorted.

Specified by:

sort in interface HeaderCell

getDockPanel

protected com.google.gwt.user.client.ui.FlexTable getDockPanel()

Getter for property 'dockPanel'.

Returns:

Value for property 'dockPanel'.

getImage

protected com.google.gwt.user.client.ui.Image getImage()

Getter for property 'image'.

Returns:

Value for property 'image'.

isInitialized

protected boolean isInitialized()

Getter for property 'initialized'.

Returns:

Value for property 'initialized'.