com.extjs.gxt.ui.client.widget.form
Class AdapterField

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.ui.client.widget.BoxComponent
                  com.extjs.gxt.ui.client.widget.form.Field<java.lang.Object>
                      com.extjs.gxt.ui.client.widget.form.AdapterField

All Implemented Interfaces:

Observable, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget

public class AdapterField
extends Field<java.lang.Object>

Allows any widget to be used in a Formlayout.

By default, the wrapped widget will not be resized when the field is resized. This can be changed by calling setResizeWidget(boolean).

Nested Class Summary

Nested classes/interfaces inherited from class com.extjs.gxt.ui.client.widget.form.Field

Field.FieldImages, Field.FieldMessages

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

protected com.google.gwt.user.client.ui.Widget

widget The wrapped widget.

Fields inherited from class com.extjs.gxt.ui.client.widget.form.Field

autoValidate, emptyText, errorIcon, fieldStyle, focusStyle, focusValue, forceInvalidText, hasFocus, images, invalidStyle, messages, name, originalValue, preventMark, propertyEditor, readOnly, readOnlyFieldStyle, validationDelay, validationTask, value

Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent

adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width

Fields inherited from class com.extjs.gxt.ui.client.widget.Component

afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

AdapterField(com.google.gwt.user.client.ui.Widget widget)
Creates a new adapter field.

Method Summary

com.google.gwt.user.client.Element	getElement()
com.google.gwt.user.client.ui.Widget	getWidget() Returns the wrapped widget.
boolean	isAttached()
boolean	isResizeWidget() Returns true if the wrapped widget is being resized.
boolean	isValid(boolean silent) Returns whether or not the field value is currently valid.
protected void	onAttach()
protected void	onBlur(ComponentEvent ce)
void	onBrowserEvent(com.google.gwt.user.client.Event event) Components delegate event handling to Component.onComponentEvent(ComponentEvent).
protected void	onDetach()
protected void	onDisable()
protected void	onEnable()
protected void	onFocus(ComponentEvent ce)
protected void	onRender(com.google.gwt.user.client.Element target, int index) Subclasses must override and ensure setElement is called for lazy rendered components.
protected void	onResize(int width, int height) Called after the component is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
void	setResizeWidget(boolean resizeWidget) True to resize the wrapped widget when the field is resized (defaults to false).
boolean	validate(boolean preventMark) Validates the field value.
protected boolean	validateValue(java.lang.String value) Subclasses should provide the validation implementation by overriding this.

Methods inherited from class com.extjs.gxt.ui.client.widget.form.Field

addInputStyleName, addKeyListener, afterRender, alignErrorIcon, clear, clearInvalid, createComponentEvent, doDetachChildren, findLabelElement, fireChangeEvent, fireKey, focus, forceInvalid, getAutoValidate, getEmptyText, getErrorMessage, getFieldLabel, getImages, getInputEl, getLabelSeparator, getLabelStyle, getMessages, getMessageTarget, getName, getOriginalValue, getPropertyEditor, getRawValue, getStyleEl, getValidateOnBlur, getValidationDelay, getValue, initValue, isDirty, isFireChangeEventOnSetValue, isHideLabel, isInEditor, isReadOnly, isValid, markInvalid, onClick, onComponentEvent, onHide, onKeyDown, onKeyPress, onKeyUp, onShow, removeInputStyleName, removeKeyListener, reset, setAutoValidate, setEmptyText, setFieldLabel, setFireChangeEventOnSetValue, setHideLabel, setImages, setInEditor, setInputStyleAttribute, setLabelSeparator, setLabelStyle, setMessages, setMessageTarget, setName, setOriginalValue, setPropertyEditor, setRawValue, setReadOnly, setTabIndex, setValidateOnBlur, setValidationDelay, setValue, updateOriginalValue, validate

Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent

adjustPosition, adjustSize, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onPosition, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize

Methods inherited from class com.extjs.gxt.ui.client.widget.Component

addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disable, disableContextMenu, disableEvents, disableTextSelection, doAttachChildren, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, notifyHide, notifyShow, onDetachHelper, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, setLayoutData

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, resolvePotentialElement, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents

Methods inherited from class java.lang.Object

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

Field Detail

widget

protected com.google.gwt.user.client.ui.Widget widget

The wrapped widget.

Constructor Detail

AdapterField

public AdapterField(com.google.gwt.user.client.ui.Widget widget)

Creates a new adapter field.

Parameters:

widget - the widget to be wrapped

Method Detail

getElement

public com.google.gwt.user.client.Element getElement()

Overrides:

getElement in class Component

getWidget

public com.google.gwt.user.client.ui.Widget getWidget()

Returns the wrapped widget.

Returns:

the widget

isAttached

public boolean isAttached()

Specified by:

isAttached in interface com.google.gwt.event.logical.shared.HasAttachHandlers

Overrides:

isAttached in class com.google.gwt.user.client.ui.Widget

isResizeWidget

public boolean isResizeWidget()

Returns true if the wrapped widget is being resized.

Returns:

true is resizing is enabled

isValid

public boolean isValid(boolean silent)

Description copied from class: Field

Returns whether or not the field value is currently valid.

Overrides:

isValid in class Field<java.lang.Object>

Parameters:

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

Returns:

true if the value is valid, otherwise false

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Description copied from class: Component

Components delegate event handling to Component.onComponentEvent(ComponentEvent). Subclasses should not override.

Specified by:

onBrowserEvent in interface com.google.gwt.user.client.EventListener

Overrides:

onBrowserEvent in class Component

Parameters:

event - the dom event

setResizeWidget

public void setResizeWidget(boolean resizeWidget)

True to resize the wrapped widget when the field is resized (defaults to false).

Parameters:

resizeWidget - true to resize the wrapped widget

validate

public boolean validate(boolean preventMark)

Description copied from class: Field

Validates the field value.

Overrides:

validate in class Field<java.lang.Object>

Parameters:

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

Returns:

true if valid, otherwise false

onAttach

protected void onAttach()

Overrides:

onAttach in class Component

onBlur

protected void onBlur(ComponentEvent ce)

Overrides:

onBlur in class Field<java.lang.Object>

onDetach

protected void onDetach()

Overrides:

onDetach in class Field<java.lang.Object>

onDisable

protected void onDisable()

Overrides:

onDisable in class Field<java.lang.Object>

onEnable

protected void onEnable()

Overrides:

onEnable in class Field<java.lang.Object>

onFocus

protected void onFocus(ComponentEvent ce)

Overrides:

onFocus in class Field<java.lang.Object>

onRender

protected void onRender(com.google.gwt.user.client.Element target,
                        int index)

Description copied from class: Component

Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:

onRender in class Field<java.lang.Object>

Parameters:

target - the target element

index - the insert location

onResize

protected void onResize(int width,
                        int height)

Description copied from class: BoxComponent

Called after the component is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.

Overrides:

onResize in class Field<java.lang.Object>

Parameters:

width - the width

height - the height

validateValue

protected boolean validateValue(java.lang.String value)

Description copied from class: Field

Subclasses should provide the validation implementation by overriding this.

Overrides:

validateValue in class Field<java.lang.Object>

Parameters:

value - the value to validate

Returns:

true for valid