com.sencha.gxt.cell.core.client.form

Class CheckBoxCell

java.lang.Object

com.google.gwt.cell.client.AbstractCell<C>

com.google.gwt.cell.client.AbstractEditableCell<C,V>

com.google.gwt.cell.client.AbstractInputCell<T,V>

com.sencha.gxt.cell.core.client.AbstractEventInputCell<T,FieldCell.FieldViewData>

com.sencha.gxt.cell.core.client.form.FieldCell<T>

com.sencha.gxt.cell.core.client.form.ValueBaseInputCell<Boolean>

com.sencha.gxt.cell.core.client.form.CheckBoxCell

All Implemented Interfaces:

Cell<Boolean>, FocusableCell, ResizableCell, ParseErrorEvent.HasParseErrorHandlers

Direct Known Subclasses:

RadioCell

public class CheckBoxCell
extends ValueBaseInputCell<Boolean>

Renders an HTML check box.

To avoid increasing the row height when used in a Grid you can adjust the grids cell padding with this code:

      ColumnConfig<Stock, Boolean> splitCol = new ColumnConfig<Stock, Boolean>(props.split(), 50, "Split");
      splitCol.setCell(new CheckBoxCell());

      // reduce the padding on text element as we have widgets in the cells
      SafeStyles textStyles = SafeStylesUtils.fromTrustedString("padding: 1px 3px;");
      splitCol.setColumnTextStyle(textStyles);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CheckBoxCell.CheckBoxAppearance
static class	CheckBoxCell.CheckBoxCellOptions

Nested classes/interfaces inherited from class com.sencha.gxt.cell.core.client.form.ValueBaseInputCell

ValueBaseInputCell.ValueBaseFieldAppearance

Nested classes/interfaces inherited from class com.sencha.gxt.cell.core.client.form.FieldCell

FieldCell.FieldAppearance, FieldCell.FieldAppearanceOptions, FieldCell.FieldViewData

Nested classes/interfaces inherited from interface com.google.gwt.cell.client.Cell

Cell.Context

Constructor Summary

Constructors

Constructor and Description
CheckBoxCell()
CheckBoxCell(CheckBoxCell.CheckBoxAppearance appearance)

Method Summary

Methods

Modifier and Type	Method and Description
CheckBoxCell.CheckBoxAppearance	getAppearance() Returns the cell's appearance.
String	getBoxLabel()
boolean	isEditing(Cell.Context context, Element parent, Boolean value)
void	onBrowserEvent(Cell.Context context, Element parent, Boolean value, NativeEvent event, ValueUpdater<Boolean> valueUpdater)
void	render(Cell.Context context, Boolean value, SafeHtmlBuilder sb)
void	setBoxLabel(XElement parent, String boxLabel) The text that appears beside the checkbox (defaults to null).

Methods inherited from class com.sencha.gxt.cell.core.client.form.ValueBaseInputCell

addParseErrorHandler, disable, enable, getCursorPos, getEmptyText, getFocusElement, getInputElement, getName, getPropertyEditor, getText, isAllowBlank, isClearValueOnParseError, isSelectOnFocus, onEmpty, resetFocus, select, selectAll, setAllowBlank, setClearValueOnParseError, setCursorPos, setEmptyText, setName, setPropertyEditor, setSelectOnFocus, setText

Methods inherited from class com.sencha.gxt.cell.core.client.form.FieldCell

finishEditing, getHeight, getWidth, handlesSelection, isDisabled, isReadOnly, onValid, redrawOnResize, setHeight, setReadOnly, setSize, setSize, setWidth

Methods inherited from class com.sencha.gxt.cell.core.client.AbstractEventInputCell

addHandler, fireEvent, isDisableEvents, setDisableEvents

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

clearViewData, getViewData, setViewData

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

dependsOnSelection, getConsumedEvents, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckBoxCell

public CheckBoxCell()

CheckBoxCell

public CheckBoxCell(CheckBoxCell.CheckBoxAppearance appearance)

Method Detail

getAppearance

public CheckBoxCell.CheckBoxAppearance getAppearance()

Description copied from class: ValueBaseInputCell

Returns the cell's appearance.

Overrides:

getAppearance in class ValueBaseInputCell<Boolean>

Returns:

the appearance

getBoxLabel

public String getBoxLabel()

isEditing

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

Specified by:

isEditing in interface Cell<Boolean>

Overrides:

isEditing in class AbstractInputCell<Boolean,FieldCell.FieldViewData>

onBrowserEvent

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

Specified by:

onBrowserEvent in interface Cell<Boolean>

Overrides:

onBrowserEvent in class FieldCell<Boolean>

render

public void render(Cell.Context context,
          Boolean value,
          SafeHtmlBuilder sb)

Specified by:

render in interface Cell<Boolean>

Specified by:

render in class AbstractCell<Boolean>

setBoxLabel

public void setBoxLabel(XElement parent,
               String boxLabel)

The text that appears beside the checkbox (defaults to null).

Parameters:

boxLabel - the box label