|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.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<D>
D
- the data type of the fieldpublic abstract class Field<D>
Base class for form fields that provides default event handling, value handling and other functionality.
Nested Class Summary | |
---|---|
class |
Field.FieldImages
|
class |
Field.FieldMessages
The field messages. |
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 boolean |
autoValidate
|
protected java.lang.String |
emptyText
|
protected WidgetComponent |
errorIcon
|
protected java.lang.String |
fieldStyle
|
protected java.lang.String |
focusStyle
|
protected java.lang.Object |
focusValue
|
protected java.lang.String |
forceInvalidText
|
protected boolean |
hasFocus
|
protected Field.FieldImages |
images
|
protected java.lang.String |
invalidStyle
|
protected Field.FieldMessages |
messages
|
protected java.lang.String |
name
|
protected D |
originalValue
|
protected boolean |
preventMark
|
protected PropertyEditor<D> |
propertyEditor
|
protected boolean |
readOnly
|
protected java.lang.String |
readOnlyFieldStyle
|
protected int |
validationDelay
|
protected DelayedTask |
validationTask
|
protected D |
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 | |
---|---|
protected |
Field()
Creates a new field. |
Method Summary | |
---|---|
void |
addInputStyleName(java.lang.String style)
Adds a CSS style name to the input element of this field. |
void |
addKeyListener(KeyListener listener)
Adds a key listener. |
protected void |
afterRender()
Called after the component has been rendered and is attached for the first time. |
protected void |
alignErrorIcon()
|
void |
clear()
Clears the value from the field. |
void |
clearInvalid()
Clear any invalid styles / messages for this field. |
protected ComponentEvent |
createComponentEvent(com.google.gwt.user.client.Event event)
|
protected void |
doDetachChildren()
|
protected El |
findLabelElement()
|
protected void |
fireChangeEvent(java.lang.Object oldValue,
java.lang.Object value)
|
protected void |
fireKey(FieldEvent fe)
|
void |
focus()
Try to focus this component. |
void |
forceInvalid(java.lang.String msg)
Forces the field to be invalid using the given error message. |
boolean |
getAutoValidate()
Returns true if the field value is validated on each key press. |
java.lang.String |
getEmptyText()
Returns the field's empty text. |
java.lang.String |
getErrorMessage()
Returns the active error message as string |
java.lang.String |
getFieldLabel()
Returns the field's label. |
Field.FieldImages |
getImages()
|
protected El |
getInputEl()
Provides support for wrapping the actual input element. |
java.lang.String |
getLabelSeparator()
Returns the field's label separator. |
java.lang.String |
getLabelStyle()
Returns the field's label style. |
Field.FieldMessages |
getMessages()
Returns the field's messages. |
java.lang.String |
getMessageTarget()
Returns the field's message target. |
java.lang.String |
getName()
Returns the name attribute of the field if available. |
D |
getOriginalValue()
Returns the original value of the field, which is the value of the field when it is first rendered. |
PropertyEditor<D> |
getPropertyEditor()
Returns the field's property editor. |
java.lang.String |
getRawValue()
Returns the raw data value which may or may not be a valid, defined value. |
protected El |
getStyleEl()
|
boolean |
getValidateOnBlur()
Returns true if the value is validate on blur. |
int |
getValidationDelay()
Returns the field's validation delay in milliseconds. |
D |
getValue()
Returns the typed value of the field. |
protected void |
initValue()
|
boolean |
isDirty()
Returns true if this field is dirty. |
boolean |
isFireChangeEventOnSetValue()
Returns true if a change event is fired when setValue(Object) is
called. |
boolean |
isHideLabel()
Returns true if the label is hidden. |
boolean |
isInEditor()
Returns true if the field is inside an editor. |
boolean |
isReadOnly()
Returns the read only state. |
boolean |
isValid()
|
boolean |
isValid(boolean preventMark)
Returns whether or not the field value is currently valid. |
void |
markInvalid(java.lang.String msg)
Marks this field as invalid. |
protected void |
onBlur(ComponentEvent be)
|
protected void |
onClick(ComponentEvent ce)
|
void |
onComponentEvent(ComponentEvent ce)
Any events a component receives will be forwarded to this method. |
protected void |
onDetach()
|
protected void |
onDisable()
|
protected void |
onEnable()
|
protected void |
onFocus(ComponentEvent ce)
|
protected void |
onHide()
|
protected void |
onKeyDown(FieldEvent fe)
|
protected void |
onKeyPress(FieldEvent fe)
|
protected void |
onKeyUp(FieldEvent fe)
|
protected void |
onRender(com.google.gwt.user.client.Element parent,
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. |
protected void |
onShow()
|
void |
removeInputStyleName(java.lang.String style)
Removes a CSS style name from the input element of this field. |
void |
removeKeyListener(KeyListener listener)
Removes the key listener. |
void |
reset()
Resets the current field value to the originally loaded value and clears any validation messages. |
void |
setAutoValidate(boolean autoValidate)
Sets whether the value is validated on each key press (defaults to false). |
void |
setEmptyText(java.lang.String emptyText)
Sets the default text to display in an empty field. |
void |
setFieldLabel(java.lang.String fieldLabel)
Sets the field's label. |
void |
setFireChangeEventOnSetValue(boolean fireChangeEventOnSetValue)
True to fire a change event when setValue(Object) is called
(defaults to false). |
void |
setHideLabel(boolean hideLabel)
True to completely hide the label element (defaults to false, pre-render). |
void |
setImages(Field.FieldImages images)
|
void |
setInEditor(boolean inEditor)
True to mark this field being in an editor. |
void |
setInputStyleAttribute(java.lang.String attr,
java.lang.String value)
Sets a style attribute on the input element. |
void |
setLabelSeparator(java.lang.String labelSeparator)
The standard separator to display after the text of each form label (defaults to the value of FormLayout.setLabelSeparator(String) ,
which is a colon ':' by default). |
void |
setLabelStyle(java.lang.String labelStyle)
A CSS style specification to apply directly to this field's label. |
void |
setMessages(Field.FieldMessages messages)
Sets the field's messages. |
void |
setMessageTarget(java.lang.String messageTarget)
The location where error text should display. |
void |
setName(java.lang.String name)
Sets the field's HTML name attribute. |
void |
setOriginalValue(D originalValue)
Updates the original value of the field. |
void |
setPropertyEditor(PropertyEditor<D> propertyEditor)
Sets the field's property editor which is used to translate typed values to string, and string values back to typed values. |
void |
setRawValue(java.lang.String value)
Sets the underlying DOM field's value directly, bypassing validation. |
void |
setReadOnly(boolean readOnly)
Sets the field's read only state. |
void |
setTabIndex(int index)
Sets the tab index. |
void |
setValidateOnBlur(boolean validateOnBlur)
Sets whether the field should validate when it loses focus (defaults to true). |
void |
setValidationDelay(int validationDelay)
Sets length of time in milliseconds after user input begins until validation is initiated (defaults to 250). |
void |
setValue(D value)
Sets a data value into the field and validates it. |
void |
updateOriginalValue(D value)
Updates the original value of the field. |
boolean |
validate()
Validates the field value. |
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.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.google.gwt.user.client.ui.Widget |
---|
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, 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, 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 |
---|
protected boolean autoValidate
protected java.lang.String emptyText
protected WidgetComponent errorIcon
protected java.lang.String fieldStyle
protected java.lang.String focusStyle
protected java.lang.Object focusValue
protected java.lang.String forceInvalidText
protected boolean hasFocus
protected Field.FieldImages images
protected java.lang.String invalidStyle
protected Field.FieldMessages messages
protected java.lang.String name
protected D originalValue
protected boolean preventMark
protected PropertyEditor<D> propertyEditor
protected boolean readOnly
protected java.lang.String readOnlyFieldStyle
protected int validationDelay
protected DelayedTask validationTask
protected D value
Constructor Detail |
---|
protected Field()
Method Detail |
---|
public void addInputStyleName(java.lang.String style)
style
- the style namepublic void addKeyListener(KeyListener listener)
listener
- the key listenerpublic void clear()
public void clearInvalid()
public void focus()
Component
focus
in class Component
public void forceInvalid(java.lang.String msg)
clearInvalid()
must be called to clear the error.
Also, no other validation logic will execute.
msg
- the error textpublic boolean getAutoValidate()
public java.lang.String getEmptyText()
public java.lang.String getErrorMessage()
public java.lang.String getFieldLabel()
public Field.FieldImages getImages()
public java.lang.String getLabelSeparator()
public java.lang.String getLabelStyle()
public Field.FieldMessages getMessages()
public java.lang.String getMessageTarget()
public java.lang.String getName()
public D getOriginalValue()
public PropertyEditor<D> getPropertyEditor()
public java.lang.String getRawValue()
getValue()
.
public boolean getValidateOnBlur()
public int getValidationDelay()
public D getValue()
public boolean isDirty()
true
if this field is dirty. A field is dirty, if the
current value is different than it's original value. The original value is
the value of the field when the field is rendered. Disabled and
pre-rendered fields are never dirty.
public boolean isFireChangeEventOnSetValue()
setValue(Object)
is
called.
public boolean isHideLabel()
public boolean isInEditor()
public boolean isReadOnly()
true
if read only, otherwise false
public boolean isValid()
public boolean isValid(boolean preventMark)
preventMark
- true for silent validation (no invalid event and field
is not marked invalid)
true
if the value is valid, otherwise
false
public void markInvalid(java.lang.String msg)
forceInvalid(String)
msg
- the validation messagepublic void onComponentEvent(ComponentEvent ce)
Component
Component.onBrowserEvent(com.google.gwt.user.client.Event)
method
should not be overridden or modified.
onComponentEvent
in class Component
ce
- the base eventpublic void removeInputStyleName(java.lang.String style)
style
- the style namepublic void removeKeyListener(KeyListener listener)
listener
- the key listenerpublic void reset()
public void setAutoValidate(boolean autoValidate)
autoValidate
- true to validate on each key presspublic void setEmptyText(java.lang.String emptyText)
emptyText
- the empty textpublic void setFieldLabel(java.lang.String fieldLabel)
fieldLabel
- the labelpublic void setFireChangeEventOnSetValue(boolean fireChangeEventOnSetValue)
setValue(Object)
is called
(defaults to false).
fireChangeEventOnSetValue
- true to fire a change eventpublic void setHideLabel(boolean hideLabel)
hideLabel
- true to hide the labelpublic void setImages(Field.FieldImages images)
public void setInEditor(boolean inEditor)
inEditor
- true mark this field being in an editorpublic void setInputStyleAttribute(java.lang.String attr, java.lang.String value)
attr
- the attributevalue
- the attribute valuepublic void setLabelSeparator(java.lang.String labelSeparator)
FormLayout.setLabelSeparator(String)
,
which is a colon ':' by default).
labelSeparator
- the label separator or "" for nonepublic void setLabelStyle(java.lang.String labelStyle)
labelStyle: 'font-weight:bold;'
labelStyle
- the label stylepublic void setMessages(Field.FieldMessages messages)
messages
- the messagespublic void setMessageTarget(java.lang.String messageTarget)
Value Description
----------- ----------------------------------------------------------------------
tooltip Display a tool tip when the user hovers over the field
title Display a default browser title attribute popup
side Add an error icon to the right of the field with a popup on hover
none Do not display an error message
[element id] Add the error text directly to the innerHTML of the specified element
messageTarget
- the message targetpublic void setName(java.lang.String name)
name
- the namepublic void setOriginalValue(D originalValue)
originalValue
- the original valuepublic void setPropertyEditor(PropertyEditor<D> propertyEditor)
propertyEditor
- the property editorpublic void setRawValue(java.lang.String value)
setValue(D)
.
value
- the raw valuepublic void setReadOnly(boolean readOnly)
readOnly
- the read only statepublic void setTabIndex(int index)
setTabIndex
in class Component
index
- the tab index valuepublic void setValidateOnBlur(boolean validateOnBlur)
validateOnBlur
- true to validate on blur, otherwise falsepublic void setValidationDelay(int validationDelay)
validationDelay
- the delay in millisecondspublic void setValue(D value)
setRawValue(java.lang.String)
.
value
- the value to setpublic void updateOriginalValue(D value)
value
- the new original valuepublic boolean validate()
true
if valid, otherwise false
public boolean validate(boolean preventMark)
preventMark
- true to not mark the field valid and fire invalid event
when invalid
true
if valid, otherwise false
protected void afterRender()
Component
afterRender
in class BoxComponent
protected void alignErrorIcon()
protected ComponentEvent createComponentEvent(com.google.gwt.user.client.Event event)
createComponentEvent
in class BoxComponent
protected void doDetachChildren()
doDetachChildren
in class Component
protected El findLabelElement()
protected void fireChangeEvent(java.lang.Object oldValue, java.lang.Object value)
protected void fireKey(FieldEvent fe)
protected El getInputEl()
protected El getStyleEl()
protected void initValue()
protected void onBlur(ComponentEvent be)
protected void onClick(ComponentEvent ce)
protected void onDetach()
onDetach
in class Component
protected void onDisable()
onDisable
in class Component
protected void onEnable()
onEnable
in class Component
protected void onFocus(ComponentEvent ce)
protected void onHide()
onHide
in class BoxComponent
protected void onKeyDown(FieldEvent fe)
protected void onKeyPress(FieldEvent fe)
protected void onKeyUp(FieldEvent fe)
protected void onRender(com.google.gwt.user.client.Element parent, int index)
Component
onRender
in class Component
parent
- the target elementindex
- the insert locationprotected void onResize(int width, int height)
BoxComponent
onResize
in class BoxComponent
width
- the widthheight
- the heightprotected void onShow()
onShow
in class BoxComponent
protected boolean validateValue(java.lang.String value)
value
- the value to validate
true
for valid
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |