Package: | Ext.form |
Class: | DateField |
Extends: | TriggerField |
Defined In: | DateField.js |
Property | Defined By | |
---|---|---|
disabled : Object | Component | |
true if this component is disabled. Read-only. | ||
disabledClass : Object | Component | |
CSS class added to the component when it is disabled. | ||
hidden : Object | Component | |
true if this component is hidden. Read-only. | ||
rendered : Object | Component | |
true if this component has been rendered. Read-only. |
Method | Defined By | |
---|---|---|
DateField(Object config ) |
DateField | |
Create a new DateField | ||
addEvents(Object object ) : void |
Observable | |
Copies any events from the passed object onto this object if they do not already exist. The passed object must also ... | ||
addListener(String eventName , Function handler , [Object scope ], [Object options ]) : void |
Observable | |
Appends an event handler to this component | ||
applyTo(String/HTMLElement/Element el ) : Ext.form.Field |
Field | |
Apply the behaviors of this component to an existing element. This is used instead of render(). | ||
autoSize() : void | TextField | |
Automatically grows the field to accomodate the width of the text up to the maximum field width allowed. This only ta... | ||
clearInvalid() : void | Field | |
Clear any invalid styles/messages for this field | ||
disable() : void | Component | |
Disable this component | ||
enable() : void | Component | |
Enable this component | ||
fireEvent(String eventName , Object... args ) : Boolean |
Observable | |
Fires the specified event with the passed parameters (minus the event name). | ||
focus(Boolean selectText ) : void |
Component | |
Try to focus this component | ||
getEl() : Ext.Element | Component | |
Returns the underlying Ext.Element | ||
getId() : String | Component | |
Returns the id of this component | ||
getName() : String | Field | |
Returns the name attribute of the field if available | ||
getRawValue() : Mixed | Field | |
Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue. | ||
getValue() : Date | DateField | |
Returns the current date value of the date field | ||
hasListener(String eventName ) : Boolean |
Observable | |
Checks to see if this object is currently listening for a specified event | ||
hide() : void | Component | |
Hide this component | ||
isValid(Boolean preventMark ) : Boolean |
Field | |
Returns whether or not the field value is currently valid | ||
isVisible() : void | Component | |
Returns true if this component is visible | ||
markInvalid(String msg ) : void |
Field | |
Mark this field as invalid | ||
on(String eventName , Function handler , [Object options ]) : void |
Observable | |
Appends an event handler to this element (shorthand for addListener) | ||
onTriggerClick(EventObject e ) : void |
TriggerField | |
The function that should handle the trigger's click event. This method does nothing by default until overridden by a... | ||
purgeListeners() : void | Observable | |
Removes all listeners for this object | ||
removeListener(String eventName , Function handler , [Object scope ]) : void |
Observable | |
Removes a listener | ||
render([String/HTMLElement/Element container ]) : void |
Component | |
If this is a lazy rendering component, render it to its container element | ||
reset() : void | Field | |
Resets the current field value to the originally-loaded value and clears any validation messages | ||
selectText([Number start ], [Number end ]) : void |
TextField | |
Selects text in this field | ||
setDisabled(Boolean disabled ) : void |
Component | |
Convenience function for setting disabled/enabled by boolean | ||
setRawValue(Mixed value ) : void |
Field | |
Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue. | ||
setSize(Number width , Number height ) : void |
Field | |
Sets the height and width of the field | ||
setValue(String/Date date ) : void |
DateField | |
Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid date, usi... | ||
setVisible(Boolean visible ) : void |
Component | |
Convenience function to hide or show this component by boolean | ||
show() : void | Component | |
Show this component | ||
un(String eventName , Function handler , [Object scope ]) : void |
Observable | |
Removes a listener (shorthand for removeListener) | ||
validate() : Boolean | Field | |
Validates the field value | ||
validateValue(Mixed value ) : Boolean |
TextField | |
Validates a value according to the field's validation rules and marks the field as invalid if the validation fails |
Event | Defined By | |
---|---|---|
autosize : (Ext.form.Field this , Number width ) |
TextField | |
Fires when the autosize function is triggered. The field may or may not have actually changed size according to the ... | ||
beforedestroy : (Ext.Component this ) |
Component | |
Fires before the component is destroyed | ||
beforehide : (Ext.Component this ) |
Component | |
Fires before the component is hidden | ||
beforerender : (Ext.Component this ) |
Component | |
Fires before the component is rendered | ||
beforeshow : (Ext.Component this ) |
Component | |
Fires before the component is shown | ||
blur : (Ext.form.Field this ) |
Field | |
Fires when | ||
change : (Ext.form.Field this , Mixed value , Mixed value ) |
Field | |
Fires just before the field blurs if the field value has changed | ||
destroy : (Ext.Component this ) |
Component | |
Fires after the component is destroyed | ||
disable : (Ext.Component this ) |
Component | |
Fires after the component is disabled | ||
enable : (Ext.Component this ) |
Component | |
Fires after the component is enabled | ||
focus : (Ext.form.Field this ) |
Field | |
Fires when this field receives input focus | ||
hide : (Ext.Component this ) |
Component | |
Fires after the component is hidden | ||
invalid : (Ext.form.Field this , String msg ) |
Field | |
Fires after the field has been marked as invalid | ||
render : (Ext.Component this ) |
Component | |
Fires after the component is rendered | ||
show : (Ext.Component this ) |
Component | |
Fires after the component is shown | ||
specialkey : (Ext.form.Field this , Ext.EventObject e ) |
Field | |
Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check Ext.EventObject.g... | ||
valid : (Ext.form.Field this ) |
Field | |
Fires after the field has been validated with no errors |
Config Options | Defined By | |
---|---|---|
allowBlank : Boolean | TextField | |
False to validate that the value length > 0 (defaults to true) | ||
autoCreate : String/Object | DateField | |
A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "10", au... | ||
blankText : String | TextField | |
Error text to display if the allow blank validation fails (defaults to "This field is required") | ||
disableKeyFilter : Boolean | TextField | |
True to disable input keystroke filtering (defaults to false) | ||
disabledDates : Array | DateField | |
An array of "dates" to disable, as strings. These strings will be used to build a dynamic regular expression so they ... | ||
disabledDatesText : String | DateField | |
The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled') | ||
disabledDays : Array | DateField | |
An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null). | ||
disabledDaysText : String | DateField | |
The tooltip to display when the date falls on a disabled day (defaults to 'Disabled') | ||
emptyClass : String | TextField | |
The CSS class to apply to an empty field to style the emptyText (defaults to 'x-form-empty-field'). This class is aut... | ||
emptyText : String | TextField | |
The default text to display in an empty field (defaults to null). | ||
fieldClass : String | Field | |
The default CSS class for the field (defaults to "x-form-field") | ||
focusClass : String | Field | |
The CSS class to use when the field receives focus (defaults to "x-form-focus") | ||
format : String | DateField | |
The default date format string which can be overriden for localization support. The format must be valid according to... | ||
grow : Boolean | TextField | |
True if this field should automatically grow and shrink to its content | ||
growMax : Number | TextField | |
The maximum width to allow when grow = true (defaults to 800) | ||
growMin : Number | TextField | |
The minimum width to allow when grow = true (defaults to 30) | ||
hideTrigger : Boolean | TriggerField | |
True to hide the trigger element and display only the base text field (defaults to false) | ||
inputType : String | Field | |
The type attribute for input fields - e.g. radio, text, password. (defaults to "text") | ||
invalidClass : String | Field | |
The CSS class to use when marking a field invalid (defaults to "x-form-invalid") | ||
invalidText : String | DateField | |
The error to display when the date in the field is invalid (defaults to '{value} is not a valid date - it must be in ... | ||
maskRe : String | TextField | |
An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null) | ||
maxLength : Number | TextField | |
Maximum input field length allowed (defaults to Number.MAX_VALUE) | ||
maxLengthText : String | TextField | |
Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxL... | ||
maxText : String | DateField | |
The error text to display when the date in the cell is before maxValue (defaults to 'The date in this field must be b... | ||
maxValue : Date/String | DateField | |
The maximum allowed date. Can be either a Javascript date object or a string date in a valid format (defaults to null). | ||
minLength : Number | TextField | |
Minimum input field length required (defaults to 0) | ||
minLengthText : String | TextField | |
Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minL... | ||
minText : String | DateField | |
The error text to display when the date in the cell is before minValue (defaults to 'The date in this field must be a... | ||
minValue : Date/String | DateField | |
The minimum allowed date. Can be either a Javascript date object or a string date in a valid format (defaults to null). | ||
msgFx : String | Field | |
Experimental The effect used when displaying a validation message under the field (defaults to 'normal'). | ||
msgTarget : String | Field | |
The location where error text should display. Should be one of the following values (defaults to 'qtip'): Value Desc... | ||
regex : RegExp | TextField | |
A JavaScript RegExp object to be tested against the field value during validation (defaults to null). If available, t... | ||
regexText : String | TextField | |
The error text to display if regex is used and the test fails during validation (defaults to "") | ||
selectOnFocus : Boolean | TextField | |
True to automatically select any existing field text when the field receives input focus (defaults to false) | ||
triggerClass : String | DateField | |
An additional CSS class used to style the trigger button. The trigger will always get the class 'x-form-trigger' and ... | ||
validateOnBlur : String/Boolean | Field | |
Defaults to true. | ||
validationDelay : Number | Field | |
The length of time in milliseconds after user input begins until validation is initiated (defaults to 250) | ||
validationEvent : String/Boolean | Field | |
The event that should initiate field validation. Set to false to disable automatic validation. (defaults to "keyup") | ||
validator : Function | TextField | |
A custom validation function to be called during field validation (defaults to null). If available, this function wil... | ||
value : Mixed | Field | |
A value to initialize this field with | ||
vtype : String | TextField | |
A validation type name as defined in Ext.form.VTypes (defaults to null) |
public Object disabled
public Object disabledClass
public Object hidden
public Object rendered
public function DateField(Object config
)
config
: Objectpublic function addEvents(Object object
)
object
: Objectvoid
public function addListener(String eventName
, Function handler
, [Object scope
], [Object options
])
eventName
: Stringhandler
: Functionscope
: Objectoptions
: Object Combining Options
Using the options argument, it is possible to combine different types of listeners:
A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, forumId: 4 });
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers.
Attaching multiple handlers in 1 call
Code:
el.on({ 'click' : { fn: this.onClick scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver scope: this }, 'mouseout' : { fn: this.onMouseOut scope: this } });
Or a shorthand syntax:
Code:
el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut scope: this });
void
public function applyTo(String/HTMLElement/Element el
)
el
: String/HTMLElement/ElementExt.form.Field
public function autoSize()
void
public function clearInvalid()
void
public function disable()
void
public function enable()
void
public function fireEvent(String eventName
, Object... args
)
eventName
: Stringargs
: Object...Boolean
public function focus(Boolean selectText
)
selectText
: Booleanvoid
public function getEl()
Ext.Element
public function getId()
String
public function getName()
String
public function getRawValue()
Mixed
public function getValue()
Date
public function hasListener(String eventName
)
eventName
: StringBoolean
public function hide()
void
public function isValid(Boolean preventMark
)
preventMark
: BooleanBoolean
public function isVisible()
void
public function markInvalid(String msg
)
msg
: Stringvoid
public function on(String eventName
, Function handler
, [Object options
])
eventName
: Stringhandler
: Functionoptions
: Objectvoid
public function onTriggerClick(EventObject e
)
e
: EventObjectvoid
public function purgeListeners()
void
public function removeListener(String eventName
, Function handler
, [Object scope
])
eventName
: Stringhandler
: Functionscope
: Objectvoid
public function render([String/HTMLElement/Element container
])
container
: String/HTMLElement/Elementvoid
public function reset()
void
public function selectText([Number start
], [Number end
])
start
: Numberend
: Numbervoid
public function setDisabled(Boolean disabled
)
disabled
: Booleanvoid
public function setRawValue(Mixed value
)
value
: Mixedvoid
public function setSize(Number width
, Number height
)
width
: Numberheight
: Numbervoid
public function setValue(String/Date date
)
//All of these calls set the same date value (May 4, 2006)
//Pass a date object:
var dt = new Date('5/4/06');
dateField.setValue(dt);
//Pass a date string (default format):
dateField.setValue('5/4/06');
//Pass a date string (custom format):
dateField.format = 'Y-m-d';
dateField.setValue('2006-5-4');
date
: String/Datevoid
public function setVisible(Boolean visible
)
visible
: Booleanvoid
public function show()
void
public function un(String eventName
, Function handler
, [Object scope
])
eventName
: Stringhandler
: Functionscope
: Objectvoid
public function validate()
Boolean
public function validateValue(Mixed value
)
value
: MixedBoolean
public event autosize
this
: Ext.form.Fieldwidth
: Numberpublic event beforedestroy
this
: Ext.Componentpublic event beforehide
this
: Ext.Componentpublic event beforerender
this
: Ext.Componentpublic event beforeshow
this
: Ext.Componentpublic event blur
this
: Ext.form.Fieldpublic event change
this
: Ext.form.Fieldvalue
: Mixedvalue
: Mixedpublic event destroy
this
: Ext.Componentpublic event disable
this
: Ext.Componentpublic event enable
this
: Ext.Componentpublic event focus
this
: Ext.form.Fieldpublic event hide
this
: Ext.Componentpublic event invalid
this
: Ext.form.Fieldmsg
: Stringpublic event render
this
: Ext.Componentpublic event show
this
: Ext.Componentpublic event specialkey
this
: Ext.form.Fielde
: Ext.EventObjectpublic event valid
this
: Ext.form.FieldallowBlank : Boolean
autoCreate : String/Object
blankText : String
disableKeyFilter : Boolean
disabledDates : Array
disabledDatesText : String
disabledDays : Array
disabledDaysText : String
emptyClass : String
emptyText : String
fieldClass : String
focusClass : String
format : String
grow : Boolean
growMax : Number
growMin : Number
hideTrigger : Boolean
inputType : String
invalidClass : String
invalidText : String
maskRe : String
maxLength : Number
maxLengthText : String
maxText : String
maxValue : Date/String
minLength : Number
minLengthText : String
minText : String
minValue : Date/String
msgFx : String
msgTarget : String
Value Description ----------- ---------------------------------------------------------------------- qtip Display a quick tip when the user hovers over the field title Display a default browser title attribute popup under Add a block div beneath the field containing the error text side Add an error icon to the right of the field with a popup on hover [element id] Add the error text directly to the innerHTML of the specified element
regex : RegExp
regexText : String
selectOnFocus : Boolean
triggerClass : String
validateOnBlur : String/Boolean
validationDelay : Number
validationEvent : String/Boolean
validator : Function
vtype : String