| java.lang.Object | |||
| ↳ | com.google.gwt.cell.client.AbstractCell<C> | ||
| ↳ | com.google.gwt.cell.client.AbstractEditableCell<C, V> | ||
| ↳ | com.google.gwt.cell.client.CheckboxCell | ||
Class Overview
A Cell used to render a checkbox. The value of the checkbox may be
toggled using the ENTER key as well as via mouse click.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Construct a new
CheckboxCell. | |||||||||||
This constructor is deprecated.
use
CheckboxCell(boolean, boolean) instead
| |||||||||||
Construct a new
CheckboxCell that optionally controls selection. | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Check if this cell depends on the selection state.
| |||||||||||
Check if this cell handles selection.
| |||||||||||
Returns true if the cell is currently editing the data identified by the
given element and key.
| |||||||||||
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. | |||||||||||
Render a cell as HTML into a
SafeHtmlBuilder, suitable for passing
to setInnerHTML(String) on a container element. | |||||||||||
|
[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 CheckboxCell (boolean isSelectBox)
This constructor is deprecated.
use CheckboxCell(boolean, boolean) instead
Construct a new CheckboxCell that optionally controls selection.
Parameters
| isSelectBox | true if the cell controls the selection state |
|---|
public CheckboxCell (boolean dependsOnSelection, boolean handlesSelection)
Construct a new CheckboxCell that optionally controls selection.
Parameters
| dependsOnSelection | true if the cell depends on the selection state |
|---|---|
| handlesSelection | true if the cell modifies the selection state |
Public Methods
public boolean dependsOnSelection ()
Check if this cell depends on the selection state.
Returns
- true if dependent on selection, false if not
public boolean handlesSelection ()
Check if this cell handles selection. If the cell handles selection, then its container should not automatically handle selection.
Returns
- true if the cell handles selection, false if not
public boolean isEditing (Cell.Context context, Element parent, Boolean 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, Boolean value, NativeEvent event, ValueUpdater<Boolean> 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 void render (Cell.Context context, Boolean 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 Context of the cell |
|---|---|
| value | the cell value to be rendered |
| sb | the SafeHtmlBuilder to be written to
|