Package com.google.gwt.cell.client
Class CheckboxCell
java.lang.Object
com.google.gwt.cell.client.AbstractCell<C>
com.google.gwt.cell.client.AbstractEditableCell<Boolean,Boolean>
com.google.gwt.cell.client.CheckboxCell
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.-
Nested Class Summary
Nested classes/interfaces inherited from interface com.google.gwt.cell.client.Cell
Cell.Context -
Constructor Summary
ConstructorsConstructorDescriptionConstruct a newCheckboxCell.CheckboxCell(boolean isSelectBox) Deprecated.CheckboxCell(boolean dependsOnSelection, boolean handlesSelection) Construct a newCheckboxCellthat optionally controls selection. -
Method Summary
Modifier and TypeMethodDescriptionbooleanCheck if this cell depends on the selection state.booleanCheck if this cell handles selection.booleanisEditing(Cell.Context context, Element parent, Boolean value) Returns true if the cell is currently editing the data identified by the given element and key.voidonBrowserEvent(Cell.Context context, Element parent, Boolean value, NativeEvent event, ValueUpdater<Boolean> valueUpdater) Handle a browser event that took place within the cell.voidrender(Cell.Context context, Boolean value, SafeHtmlBuilder sb) Render a cell as HTML into aSafeHtmlBuilder, suitable for passing toElement.setInnerHTML(String)on a container element.Methods inherited from class com.google.gwt.cell.client.AbstractEditableCell
clearViewData, getViewData, setViewDataMethods inherited from class com.google.gwt.cell.client.AbstractCell
getConsumedEvents, onEnterKeyDown, resetFocus, setValue
-
Constructor Details
-
CheckboxCell
public CheckboxCell()Construct a newCheckboxCell. -
CheckboxCell
Deprecated.useCheckboxCell(boolean, boolean)insteadConstruct a newCheckboxCellthat optionally controls selection.- Parameters:
isSelectBox- true if the cell controls the selection state
-
CheckboxCell
public CheckboxCell(boolean dependsOnSelection, boolean handlesSelection) Construct a newCheckboxCellthat optionally controls selection.- Parameters:
dependsOnSelection- true if the cell depends on the selection statehandlesSelection- true if the cell modifies the selection state
-
-
Method Details
-
dependsOnSelection
public boolean dependsOnSelection()Description copied from interface:CellCheck if this cell depends on the selection state.- Specified by:
dependsOnSelectionin interfaceCell<Boolean>- Overrides:
dependsOnSelectionin classAbstractCell<Boolean>- Returns:
- true if dependent on selection, false if not
-
handlesSelection
public boolean handlesSelection()Description copied from interface:CellCheck if this cell handles selection. If the cell handles selection, then its container should not automatically handle selection.- Specified by:
handlesSelectionin interfaceCell<Boolean>- Overrides:
handlesSelectionin classAbstractCell<Boolean>- Returns:
- true if the cell handles selection, false if not
-
isEditing
Description copied from class:AbstractEditableCellReturns 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.- Specified by:
isEditingin interfaceCell<Boolean>- Specified by:
isEditingin classAbstractEditableCell<Boolean,Boolean> - Parameters:
context- theCell.Contextof the cellparent- the parent Elementvalue- the value associated with the cell- Returns:
- true if the cell is in edit mode
-
onBrowserEvent
public void onBrowserEvent(Cell.Context context, Element parent, Boolean value, NativeEvent event, ValueUpdater<Boolean> valueUpdater) Description copied from class:AbstractCellHandle 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.
- Specified by:
onBrowserEventin interfaceCell<Boolean>- Overrides:
onBrowserEventin classAbstractCell<Boolean>- Parameters:
context- theCell.Contextof the cellparent- the parent Elementvalue- the value associated with the cellevent- the native browser eventvalueUpdater- aValueUpdater, or null if not specified
-
CheckboxCell(boolean, boolean)instead