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

Class ValueBaseInputCell<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.ValueBaseInputCell<T>

Type Parameters:

T - the data type

All Implemented Interfaces:

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

Direct Known Subclasses:

CheckBoxCell, TextAreaInputCell, TextInputCell, TriggerFieldCell

public abstract class ValueBaseInputCell<T>
extends FieldCell<T>
implements ParseErrorEvent.HasParseErrorHandlers, FocusableCell

A FieldCell which has an input element.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	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
ValueBaseInputCell(ValueBaseInputCell.ValueBaseFieldAppearance appearance) Creates a new cell instance.
ValueBaseInputCell(ValueBaseInputCell.ValueBaseFieldAppearance appearance, Set<String> consumedEvents) Creates a new cell instance.
ValueBaseInputCell(ValueBaseInputCell.ValueBaseFieldAppearance appearance, String... consumedEvents) Creates a new cell instance.

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addParseErrorHandler(ParseErrorEvent.ParseErrorHandler handler) Adds a ParseErrorEvent.ParseErrorHandler handler for ParseErrorEvent events.
void	disable(XElement parent) Disables the cell.
void	enable(XElement parent) Enables the cell.
ValueBaseInputCell.ValueBaseFieldAppearance	getAppearance() Returns the cell's appearance.
int	getCursorPos(XElement parent) Gets the current position of the cursor (this also serves as the beginning of the text selection).
String	getEmptyText() Returns the cell's empty text.
XElement	getFocusElement(XElement parent)
InputElement	getInputElement(Element parent)
String	getName() Returns the field's name.
PropertyEditor<T>	getPropertyEditor() Returns the cell's property editor.
String	getText(XElement parent) Returns the cell's raw text.
boolean	isAllowBlank() Returns the field's allow blank state.
boolean	isClearValueOnParseError() Returns true if the current value is cleared on a parse error.
boolean	isSelectOnFocus() Returns the select of focus state.
void	onEmpty(XElement parent, boolean empty)
boolean	resetFocus(Cell.Context context, Element parent, T value)
void	select(XElement parent, int start, int length) Selects the text.
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	setClearValueOnParseError(boolean clearValueOnParseError) True to clear the current value when a parse error occurs (defaults to true).
void	setCursorPos(XElement parent, int pos) Sets the cursor position.
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) Sets the name attribute on the input element.
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, handlesSelection, isDisabled, isReadOnly, onBrowserEvent, 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.AbstractInputCell

isEditing

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueBaseInputCell

public ValueBaseInputCell(ValueBaseInputCell.ValueBaseFieldAppearance appearance)

Creates a new cell instance.

Parameters:

appearance - the appearance

ValueBaseInputCell

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

Creates a new cell instance.

Parameters:

appearance - the appearance

consumedEvents - the consumed events

ValueBaseInputCell

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

Creates a new cell instance.

Parameters:

appearance - the appearance

consumedEvents - the consumed events

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

disable

public void disable(XElement parent)

Description copied from class: FieldCell

Disables the cell.

Overrides:

disable in class FieldCell<T>

Parameters:

parent - the parent element

enable

public void enable(XElement parent)

Description copied from class: FieldCell

Enables the cell.

Overrides:

enable in class FieldCell<T>

Parameters:

parent - the parent element

getAppearance

public ValueBaseInputCell.ValueBaseFieldAppearance getAppearance()

Returns the cell's appearance.

Overrides:

getAppearance in class FieldCell<T>

Returns:

the appearance

getCursorPos

public int getCursorPos(XElement parent)

Gets the current position of the cursor (this also serves as the beginning of the text selection).

Parameters:

parent - the parent

Returns:

the cursor's position

getEmptyText

public String getEmptyText()

Returns the cell's empty text.

Returns:

the empty text

getFocusElement

public XElement getFocusElement(XElement parent)

Specified by:

getFocusElement in interface FocusableCell

getInputElement

public InputElement getInputElement(Element parent)

Overrides:

getInputElement in class AbstractInputCell<T,FieldCell.FieldViewData>

getName

public String getName()

Returns the field's name.

Returns:

the name

getPropertyEditor

public PropertyEditor<T> getPropertyEditor()

Returns the cell's property editor.

Returns:

the property editor

getText

public String getText(XElement parent)

Returns the cell's raw text.

Parameters:

parent - the parent element

Returns:

text from the input field

isAllowBlank

public boolean isAllowBlank()

Returns the field's allow blank state.

Returns:

true if blank values are allowed

isClearValueOnParseError

public boolean isClearValueOnParseError()

Returns true if the current value is cleared on a parse error.

Returns:

true if clearing on parse error

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>

resetFocus

public boolean resetFocus(Cell.Context context,
                 Element parent,
                 T value)

Specified by:

resetFocus in interface Cell<T>

Overrides:

resetFocus in class AbstractInputCell<T,FieldCell.FieldViewData>

select

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

Selects the text.

Parameters:

parent - the parent element

start - the start index

length - the selection length

selectAll

public void selectAll(XElement parent)

Selects all the text.

Parameters:

parent - 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

setClearValueOnParseError

public void setClearValueOnParseError(boolean clearValueOnParseError)

True to clear the current value when a parse error occurs (defaults to true).

Parameters:

clearValueOnParseError - true to clean the value on parse error

setCursorPos

public void setCursorPos(XElement parent,
                int pos)

Sets the cursor position. This will only work when the widget is attached to the document and not hidden.

Parameters:

parent - the parent

pos - the new cursor position

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:

context - the context

parent - the parent

emptyText - the empty text

setName

public void setName(XElement parent,
           String name)

Description copied from class: FieldCell

Sets the name attribute on the input element.

Overrides:

setName in class FieldCell<T>

Parameters:

parent - the parent

name - the name

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). This only applies when the field becomes focused via a click. This setting has no effect when tabbing into the field as the browser will select all text.

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:

parent - the parent element

text - the text