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

Class ValueBaseFieldCell<T>

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.ValueBaseFieldCell<T>

All Implemented Interfaces:

Cell<T>, ResizableCell, ParseErrorEvent.HasParseErrorHandlers

Direct Known Subclasses:

CheckBoxCell, TextAreaInputCell, TextInputCell, TriggerFieldCell

public abstract class ValueBaseFieldCell<T>
extends FieldCell<T>
implements ParseErrorEvent.HasParseErrorHandlers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ValueBaseFieldCell.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
ValueBaseFieldCell(ValueBaseFieldCell.ValueBaseFieldAppearance appearance)
ValueBaseFieldCell(ValueBaseFieldCell.ValueBaseFieldAppearance appearance, Set<String> consumedEvents)
ValueBaseFieldCell(ValueBaseFieldCell.ValueBaseFieldAppearance appearance, String... consumedEvents)

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addParseErrorHandler(ParseErrorEvent.ParseErrorHandler handler) Adds a ParseErrorEvent.ParseErrorHandler handler for ParseErrorEvent events.
ValueBaseFieldCell.ValueBaseFieldAppearance	getAppearance() Returns the cell's appearance.
String	getEmptyText() Returns the cell's empty text.
InputElement	getInputElement(Element parent)
String	getName()
PropertyEditor<T>	getPropertyEditor()
String	getText(XElement parent)
boolean	isAllowBlank() Returns the field's allow blank state.
boolean	isSelectOnFocus() Returns the select of focus state.
void	onEmpty(XElement parent, boolean empty)
void	select(XElement parent, int start, int length)
void	selectAll(XElement parent) Selects all the text.
void	setAllowBlank(boolean allowBlank) Sets whether a field is valid when its value length = 0 (default to true).
void	setEmptyText(Cell.Context context, XElement parent, String emptyText) Sets the default text to display in an empty field (defaults to null).
void	setName(XElement parent, String name)
void	setPropertyEditor(PropertyEditor<T> propertyEditor) Sets the field's property editor which is used to translate typed values to string, and string values back to typed values.
void	setSelectOnFocus(boolean selectOnFocus) True to automatically select any existing field text when the field receives input focus (defaults to false).
void	setText(XElement parent, String text) Sets the underlying DOM field's value directly, bypassing validation.

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

finishEditing, getHeight, getWidth, isReadOnly, onBrowserEvent, onValid, setHeight, setReadOnly, 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.AbstractInputCell

isEditing, resetFocus

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, handlesSelection, render, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueBaseFieldCell

public ValueBaseFieldCell(ValueBaseFieldCell.ValueBaseFieldAppearance appearance)

ValueBaseFieldCell

public ValueBaseFieldCell(ValueBaseFieldCell.ValueBaseFieldAppearance appearance,
                  Set<String> consumedEvents)

ValueBaseFieldCell

public ValueBaseFieldCell(ValueBaseFieldCell.ValueBaseFieldAppearance appearance,
                  String... consumedEvents)

Method Detail

addParseErrorHandler

public HandlerRegistration addParseErrorHandler(ParseErrorEvent.ParseErrorHandler handler)

Description copied from interface: ParseErrorEvent.HasParseErrorHandlers

Adds a ParseErrorEvent.ParseErrorHandler handler for ParseErrorEvent events.

Specified by:

addParseErrorHandler in interface ParseErrorEvent.HasParseErrorHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

getAppearance

public ValueBaseFieldCell.ValueBaseFieldAppearance getAppearance()

Returns the cell's appearance.

Returns:

the appearance

getEmptyText

public String getEmptyText()

Returns the cell's empty text.

Returns:

the empty text

getInputElement

public InputElement getInputElement(Element parent)

Overrides:

getInputElement in class AbstractInputCell<T,FieldCell.FieldViewData>

getName

public String getName()

getPropertyEditor

public PropertyEditor<T> getPropertyEditor()

getText

public String getText(XElement parent)

isAllowBlank

public boolean isAllowBlank()

Returns the field's allow blank state.

Returns:

true if blank values are allowed

isSelectOnFocus

public boolean isSelectOnFocus()

Returns the select of focus state.

Returns:

true if select on focus is enabled

onEmpty

public void onEmpty(XElement parent,
           boolean empty)

Specified by:

onEmpty in class FieldCell<T>

select

public void select(XElement parent,
          int start,
          int length)

selectAll

public void selectAll(XElement parent)

Selects all the text.

Parameters:

the - parent

setAllowBlank

public void setAllowBlank(boolean allowBlank)

Sets whether a field is valid when its value length = 0 (default to true).

Parameters:

allowBlank - true to allow blanks, false otherwise

setEmptyText

public void setEmptyText(Cell.Context context,
                XElement parent,
                String emptyText)

Sets the default text to display in an empty field (defaults to null).

Parameters:

the - context

parent - the parent

emptyText - the empty text

setName

public void setName(XElement parent,
           String name)

Overrides:

setName in class FieldCell<T>

setPropertyEditor

public void setPropertyEditor(PropertyEditor<T> propertyEditor)

Sets the field's property editor which is used to translate typed values to string, and string values back to typed values.

Parameters:

propertyEditor - the property editor

setSelectOnFocus

public void setSelectOnFocus(boolean selectOnFocus)

True to automatically select any existing field text when the field receives input focus (defaults to false).

Parameters:

selectOnFocus - true to focus

setText

public void setText(XElement parent,
           String text)

Sets the underlying DOM field's value directly, bypassing validation. This method does not update the field's value. To set the value with validation see AbstractCell.setValue(com.google.gwt.cell.client.Cell.Context, com.google.gwt.dom.client.Element, C).

Parameters:

the - parent element

text - the text