public abstract class

AbstractInputCell

extends AbstractEditableCell<C, V>
java.lang.Object
   ↳ com.google.gwt.cell.client.AbstractCell<C>
     ↳ com.google.gwt.cell.client.AbstractEditableCell<C, V>
       ↳ com.google.gwt.cell.client.AbstractInputCell<C, V>
Known Direct Subclasses

Class Overview

An AbstractCell used to render input elements that can receive focus.

Summary

Public Constructors
AbstractInputCell(String... consumedEvents)
Construct a new AbstractInputCell with the specified consumed events.
AbstractInputCell(Set<String> consumedEvents)
Construct a new AbstractInputCell with the specified consumed events.
Public Methods
boolean isEditing(Cell.Context context, Element parent, C value)
Returns true if the cell is currently editing the data identified by the given element and key.
void onBrowserEvent(Cell.Context context, Element parent, C value, NativeEvent event, ValueUpdater<C> valueUpdater)
Handle a browser event that took place within the cell.

If you override this method to add support for events, remember to pass the event types that the cell expects into the constructor.

boolean resetFocus(Cell.Context context, Element parent, C value)
Reset focus on the Cell.

This method is a no-op and returns false.

Protected Methods
void finishEditing(Element parent, C value, Object key, ValueUpdater<C> valueUpdater)
Call this method when editing is complete.
Element getInputElement(Element parent)
Get the input element.
void onEnterKeyDown(Cell.Context context, Element parent, C value, NativeEvent event, ValueUpdater<C> valueUpdater)
Called when the user triggers a keydown event with the ENTER key while focused on the cell.
[Expand]
Inherited Methods
From class com.google.gwt.cell.client.AbstractEditableCell
From class com.google.gwt.cell.client.AbstractCell
From class java.lang.Object
From interface com.google.gwt.cell.client.Cell

Public Constructors

public AbstractInputCell (String... consumedEvents)

Construct a new AbstractInputCell with the specified consumed events.

Parameters
consumedEvents the events that this cell consumes

public AbstractInputCell (Set<String> consumedEvents)

Construct a new AbstractInputCell with the specified consumed events.

Parameters
consumedEvents the events that this cell consumes

Public Methods

public boolean isEditing (Cell.Context context, Element parent, C value)

Returns true if the cell is currently editing the data identified by the given element and key. While a cell is editing, widgets containing the cell may choose to pass keystrokes directly to the cell rather than using them for navigation purposes.

Parameters
context the Context of the cell
parent the parent Element
value the value associated with the cell
Returns
  • true if the cell is in edit mode

public void onBrowserEvent (Cell.Context context, Element parent, C value, NativeEvent event, ValueUpdater<C> valueUpdater)

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

If you override this method to add support for events, remember to pass the event types that the cell expects into the constructor.

Parameters
context the Context of the cell
parent the parent Element
value the value associated with the cell
event the native browser event
valueUpdater a ValueUpdater, or null if not specified

public boolean resetFocus (Cell.Context context, Element parent, C value)

Reset focus on the Cell. This method is called if the cell has focus when it is refreshed.

This method is a no-op and returns false. If your cell is editable or can be focused by the user, override this method to reset focus when the containing widget is refreshed.

Parameters
context the Context of the cell
parent the parent Element
value the value associated with the cell
Returns
  • true if focus is taken, false if not

Protected Methods

protected void finishEditing (Element parent, C value, Object key, ValueUpdater<C> valueUpdater)

Call this method when editing is complete.

Parameters
parent the parent Element
value the value associated with the cell
key the unique key associated with the row object
valueUpdater the value update to fire

protected Element getInputElement (Element parent)

Get the input element.

Parameters
parent the cell parent element
Returns
  • the input element

protected void onEnterKeyDown (Cell.Context context, Element parent, C value, NativeEvent event, ValueUpdater<C> valueUpdater)

Called when the user triggers a keydown event with the ENTER key while focused on the cell. If your cell interacts with the user, you should override this method to provide a consistent user experience. Your widget must consume keydown events for this method to be called.

Parameters
context the Context of the cell
parent the parent Element
value the value associated with the cell
event the native browser event
valueUpdater a ValueUpdater, or null if not specified