com.google.gwt.cell.client
Class DatePickerCell

java.lang.Object
  com.google.gwt.cell.client.AbstractCell<java.util.Date>
      com.google.gwt.cell.client.DatePickerCell

All Implemented Interfaces:

Cell<java.util.Date>

public class DatePickerCell
extends AbstractCell<java.util.Date>

A Cell used to render and edit Dates. When a cell is selected by clicking on it, a DatePicker is popped up. When a date is selected using the DatePicker, the new date is passed to the update method of the ValueUpdater that was passed to onBrowserEvent(com.google.gwt.dom.client.Element, java.util.Date, java.lang.Object, com.google.gwt.dom.client.NativeEvent, com.google.gwt.cell.client.ValueUpdater) for the click event. Note that this means that the call to ValueUpdater.update will occur after onBrowserEvent has returned. Pressing the 'escape' key dismisses the DatePicker popup without calling ValueUpdater.update.

Each DatePickerCell has a unique DatePicker popup associated with it; thus, if a single DatePickerCell is used as the cell for a column in a table, only one entry in that column will be editable at a given time.

Note: This class is new and its interface subject to change.

Constructor Summary

DatePickerCell()
Constructs a new DatePickerCell that uses the date/time format given by DateTimeFormat.getFullDateFormat().

DatePickerCell(DateTimeFormat format)
Constructs a new DatePickerCell that uses the given date/time format.

Method Summary

java.lang.Object	onBrowserEvent(Element parent, java.util.Date value, java.lang.Object viewData, NativeEvent event, ValueUpdater<java.util.Date> valueUpdater) Handle a browser event that took place within the cell.
void	render(java.util.Date value, java.lang.Object viewData, java.lang.StringBuilder sb) Render a cell as HTML into a StringBuilder, suitable for passing to Element.setInnerHTML(java.lang.String) on a container element.

Methods inherited from class com.google.gwt.cell.client.AbstractCell

consumesEvents, dependsOnSelection, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

DatePickerCell

public DatePickerCell()

Constructs a new DatePickerCell that uses the date/time format given by DateTimeFormat.getFullDateFormat().

DatePickerCell

public DatePickerCell(DateTimeFormat format)

Constructs a new DatePickerCell that uses the given date/time format.

Method Detail

onBrowserEvent

public java.lang.Object onBrowserEvent(Element parent,
                                       java.util.Date value,
                                       java.lang.Object viewData,
                                       NativeEvent event,
                                       ValueUpdater<java.util.Date> valueUpdater)

Description copied from interface: Cell

Handle a browser event that took place within the cell. The default implementation returns null.

Specified by:

onBrowserEvent in interface Cell<java.util.Date>

Overrides:

onBrowserEvent in class AbstractCell<java.util.Date>

Parameters:

parent - the parent Element

value - the value associated with the cell

viewData - the view data associated with the cell, or null

event - the native browser event

valueUpdater - a ValueUpdater, or null

Returns:

a view data object which may be the one passed in or a new object

render

public void render(java.util.Date value,
                   java.lang.Object viewData,
                   java.lang.StringBuilder sb)

Description copied from interface: Cell

Render a cell as HTML into a StringBuilder, suitable for passing to Element.setInnerHTML(java.lang.String) on a container element.

Specified by:

render in interface Cell<java.util.Date>

Specified by:

render in class AbstractCell<java.util.Date>

Parameters:

value - the cell value to be rendered

viewData - view data associated with the cell

sb - the StringBuilder to be written to