public class

EditTextCell

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

Class Overview

An editable text cell. Click to edit, escape to cancel, return to commit. Important TODO: This cell still treats its value as HTML for rendering purposes, which is entirely wrong. It should be able to treat it as a proper string (especially since that's all the user can enter).

Summary

Public Constructors
EditTextCell()
Construct a new EditTextCell that will use a SimpleSafeHtmlRenderer.
EditTextCell(SafeHtmlRenderer<String> renderer)
Construct a new EditTextCell that will use a given SafeHtmlRenderer.
Public Methods
boolean isEditing(Cell.Context context, Element parent, String 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, String value, NativeEvent event, ValueUpdater<String> 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.

void render(Cell.Context context, String value, SafeHtmlBuilder sb)
Render a cell as HTML into a SafeHtmlBuilder, suitable for passing to setInnerHTML(String) on a container element.
boolean resetFocus(Cell.Context context, Element parent, String value)
Reset focus on the Cell.

This method is a no-op and returns false.

Protected Methods
void edit(Cell.Context context, Element parent, String value)
Convert the cell to edit mode.
[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 EditTextCell ()

Construct a new EditTextCell that will use a SimpleSafeHtmlRenderer.

public EditTextCell (SafeHtmlRenderer<String> renderer)

Construct a new EditTextCell that will use a given SafeHtmlRenderer.

Parameters
renderer a SafeHtmlRenderer instance

Public Methods

public boolean isEditing (Cell.Context context, Element parent, String 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 Cell.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, String value, NativeEvent event, ValueUpdater<String> 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 Cell.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 void render (Cell.Context context, String value, SafeHtmlBuilder sb)

Render a cell as HTML into a SafeHtmlBuilder, suitable for passing to setInnerHTML(String) on a container element.

Note: If your cell contains natively focusable elements, such as buttons or input elements, be sure to set the tabIndex to -1 so that they do not steal focus away from the containing widget.

Parameters
context the Cell.Context of the cell
value the cell value to be rendered
sb the SafeHtmlBuilder to be written to

public boolean resetFocus (Cell.Context context, Element parent, String 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 Cell.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 edit (Cell.Context context, Element parent, String value)

Convert the cell to edit mode.

Parameters
context the Cell.Context of the cell
parent the parent element
value the current value