com.sencha.gxt.widget.core.client.form

Class AdapterField<T>

java.lang.Object

Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.container.Container

com.sencha.gxt.widget.core.client.container.ResizeContainer

com.sencha.gxt.widget.core.client.container.SimpleContainer

com.sencha.gxt.widget.core.client.form.AdapterField<T>

Type Parameters:

T - the field's data type

All Implemented Interfaces:

HasGestureRecognizers, HasLayout, AddEvent.HasAddHandlers, BeforeAddEvent.HasBeforeAddHandlers, BeforeHideEvent.HasBeforeHideHandlers, BeforeRemoveEvent.HasBeforeRemoveHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, ContainerHandler.HasContainerHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, InvalidEvent.HasInvalidHandlers, MoveEvent.HasMoveHandlers, RemoveEvent.HasRemoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, ValidEvent.HasValidHandlers, IsField<T>, HasFocusSupport, HasItemId

Direct Known Subclasses:

DualListField, HtmlEditor, ListField

public abstract class AdapterField<T>
extends SimpleContainer
implements IsField<T>, InvalidEvent.HasInvalidHandlers, ValidEvent.HasValidHandlers

Wraps a Widget so that it can be used like a Field.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	forceInvalidText
protected boolean	preventMark

Fields inherited from class com.sencha.gxt.widget.core.client.container.SimpleContainer

resize, widget

Fields inherited from class com.sencha.gxt.widget.core.client.container.ResizeContainer

forceLayoutCommand, forceLayoutOnResize, hadLayoutRunning, layoutCommand, layoutRequiredThisEventLoop, layoutRunning

Fields inherited from class com.sencha.gxt.widget.core.client.Component

adjustSize, allowTextSelection, cacheSizes, disableContextMenu, disabled, disabledStyle, ensureVisibilityOnSizing, height, hidden, lastSize, layer, left, mask, maskMessage, monitorWindowResize, pageX, pageY, resizeHandler, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Constructor and Description
AdapterField(Widget widget) Creates an adapter field that wraps the specified widget so that it can be used like a Field.

Method Summary

Modifier and Type	Method and Description
HandlerRegistration	addInvalidHandler(InvalidEvent.InvalidHandler handler) Adds a InvalidEvent.InvalidHandler handler for InvalidEvent events.
void	addValidator(Validator<T> validator) Adds a validator to be invoked when validateValue(Object) is invoked.
HandlerRegistration	addValidHandler(ValidEvent.ValidHandler handler) Adds a ValidEvent handler for ValidEvent events.
HandlerRegistration	addValueChangeHandler(<any> valueChangeHandler)
void	clear() Clears the value from the field.
void	clearInvalid() Clear any invalid styles / messages for this field.
void	disable() Disable this widget.
void	enable() Enable this widget.
void	finishEditing() Used to indicate that this field must be completed with its editing process, as it may be able to be removed from the dom, hidden, or its current results used.
void	flush()
void	forceInvalid(String msg) Forces the field to be invalid using the given error message.
List<EditorError>	getErrors() Returns a list of the current errors.
ErrorHandler	getErrorSupport() Returns the field's error support instance.
List<Validator<T>>	getValidators() Returns the field's validators.
boolean	isValid() Returns whether or not the field value is currently valid.
boolean	isValid(boolean preventMark) Returns whether or not the field value is currently valid.
protected void	markInvalid(List<EditorError> msg) Actual implementation of markInvalid, which bypasses recording an error in the editor peer.
void	markInvalid(String msg) Marks this field as invalid.
protected void	onFocus(Event event)
void	onPropertyChange(String... strings)
void	removeValidator(Validator<T> validator) Removes a validator from this list of validators that are run when validateValue(Object) is invoked.
void	reset() Resets the current field value to the originally loaded value and clears any validation messages.
void	setDelegate(<any> delegate)
void	setErrorSupport(ErrorHandler error) Sets the error handler used to mark and query field errors.
void	showErrors(List<EditorError> errors)
boolean	validate() Validates the field value.
boolean	validate(boolean preventMark) Validates the field value.
protected boolean	validateValue(T value)

Methods inherited from class com.sencha.gxt.widget.core.client.container.SimpleContainer

add, add, doLayout, getWidget, isResize, onRemove, setElement, setResize, setWidget, setWidget

Methods inherited from class com.sencha.gxt.widget.core.client.container.ResizeContainer

applyLayout, applyLayout, forceLayout, forceLayoutOnChildren, forceLayoutOnChildren, getLeftRightMargins, getParentLayoutWidget, getSideMargins, getTopBottomMargins, isLayoutRunning, isOrWasLayoutRunning, isWidgetVisible, onBeforeDoLayout, onLoad, onResize, onResize

Methods inherited from class com.sencha.gxt.widget.core.client.container.Container

addAddHandler, addBeforeAddHandler, addBeforeRemoveHandler, addContainerHandler, addRemoveHandler, adjustIndex, adopt, checkIndexBoundsForInsertion, doAttachChildren, doDetachChildren, doPhysicalAttach, doPhysicalDetach, ensureGroupingHandlerRegistration, findWidget, getChildren, getContainerTarget, getItemByItemId, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, iterator, onInsert, onWidgetHide, onWidgetShow, orphan, remove, remove, remove

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disableContextMenu, disableEvents, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getElement, getFocusEl, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, notifyHide, notifyShow, onAfterFirstAttach, onAttach, onBlur, onBrowserEvent, onDetach, onDisable, onEnable, onHide, onHideContextMenu, onPosition, onRightClick, onShow, onShowContextMenu, onTouch, onUnload, onWindowResize, removeStyleDependentName, removeStyleOnOver, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sencha.gxt.widget.core.client.event.BlurEvent.HasBlurHandlers

addBlurHandler

Field Detail

forceInvalidText

protected String forceInvalidText

preventMark

protected boolean preventMark

Constructor Detail

AdapterField

public AdapterField(Widget widget)

Creates an adapter field that wraps the specified widget so that it can be used like a Field.

Parameters:

widget - the widget to wrap

Method Detail

addInvalidHandler

public HandlerRegistration addInvalidHandler(InvalidEvent.InvalidHandler handler)

Description copied from interface: InvalidEvent.HasInvalidHandlers

Adds a InvalidEvent.InvalidHandler handler for InvalidEvent events.

Specified by:

addInvalidHandler in interface InvalidEvent.HasInvalidHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

addValidator

public void addValidator(Validator<T> validator)

Adds a validator to be invoked when validateValue(Object) is invoked.

Parameters:

validator - the validator to add

addValidHandler

public HandlerRegistration addValidHandler(ValidEvent.ValidHandler handler)

Description copied from interface: ValidEvent.HasValidHandlers

Adds a ValidEvent handler for ValidEvent events.

Specified by:

addValidHandler in interface ValidEvent.HasValidHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

addValueChangeHandler

public HandlerRegistration addValueChangeHandler(<any> valueChangeHandler)

clear

public void clear()

Clears the value from the field.

Specified by:

clear in interface IsField<T>

Overrides:

clear in class Container

See Also:

to remove validation messages, to restore to original value and remove validation messages

clearInvalid

public void clearInvalid()

Clear any invalid styles / messages for this field.

Specified by:

clearInvalid in interface IsField<T>

disable

public void disable()

Description copied from class: Component

Disable this widget.

Overrides:

disable in class Container

enable

public void enable()

Description copied from class: Component

Enable this widget.

Overrides:

enable in class Container

finishEditing

public void finishEditing()

Description copied from interface: IsField

Used to indicate that this field must be completed with its editing process, as it may be able to be removed from the dom, hidden, or its current results used.

Specified by:

finishEditing in interface IsField<T>

flush

public void flush()

forceInvalid

public void forceInvalid(String msg)

Forces the field to be invalid using the given error message. When using this feature, clearInvalid() must be called to clear the error. Also, no other validation logic will execute.

Parameters:

msg - the error text

getErrors

public List<EditorError> getErrors()

Description copied from interface: IsField

Returns a list of the current errors.

Specified by:

getErrors in interface IsField<T>

Returns:

the errors, or empty list if no errors

getErrorSupport

public ErrorHandler getErrorSupport()

Returns the field's error support instance.

Returns:

the error support

getValidators

public List<Validator<T>> getValidators()

Returns the field's validators.

Returns:

the validators

isValid

public boolean isValid()

Returns whether or not the field value is currently valid.

Returns:

true if valid

isValid

public boolean isValid(boolean preventMark)

Description copied from interface: IsField

Returns whether or not the field value is currently valid.

Specified by:

isValid in interface IsField<T>

Parameters:

preventMark - true for silent validation (no invalid event and field is not marked invalid)

Returns:

true if the value is valid, otherwise false

markInvalid

public void markInvalid(String msg)

Marks this field as invalid. Validation will still run if called again, and the error message will be changed or cleared based on validation. To set a error message that will not be cleared until manually cleared see forceInvalid(String) Calling this will also register an error in the editor, if any.

Parameters:

msg - the validation message

onPropertyChange

public void onPropertyChange(String... strings)

removeValidator

public void removeValidator(Validator<T> validator)

Removes a validator from this list of validators that are run when validateValue(Object) is invoked.

Parameters:

validator - the validator to remove

reset

public void reset()

Resets the current field value to the originally loaded value and clears any validation messages.

Specified by:

reset in interface IsField<T>

setDelegate

public void setDelegate(<any> delegate)

setErrorSupport

public void setErrorSupport(ErrorHandler error)

Sets the error handler used to mark and query field errors.

Parameters:

error - the error handler

showErrors

public void showErrors(List<EditorError> errors)

validate

public boolean validate()

Validates the field value.

Returns:

true if valid, otherwise false

validate

public boolean validate(boolean preventMark)

Validates the field value.

Specified by:

validate in interface IsField<T>

Parameters:

preventMark - true to not mark the field valid and fire invalid event when invalid

Returns:

true if valid, otherwise false

markInvalid

protected void markInvalid(List<EditorError> msg)

Actual implementation of markInvalid, which bypasses recording an error in the editor peer.

Parameters:

msg - the validation message

onFocus

protected void onFocus(Event event)

Overrides:

onFocus in class Component

validateValue

protected boolean validateValue(T value)