X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..6e39d509471fe9b4e2660e0d1631b350d0c66f40:/docs/output/Ext.ux.form.SpinnerField.html diff --git a/docs/output/Ext.ux.form.SpinnerField.html b/docs/output/Ext.ux.form.SpinnerField.html deleted file mode 100644 index c6cae1ac..00000000 --- a/docs/output/Ext.ux.form.SpinnerField.html +++ /dev/null @@ -1,1039 +0,0 @@ -
Observable Component BoxComponent Field TextField NumberField SpinnerField
Package: | Ext.ux.form |
Defined In: | SpinnerField.js |
Class: | SpinnerField |
Extends: | NumberField |
xtype: | spinnerfield |
Config Options | Defined By | |
---|---|---|
allowBlank : Boolean Specify false to validate that the value's length is > 0 (defaults to
-true) | TextField | |
allowDecimals : Boolean False to disallow decimal values (defaults to true) | NumberField | |
allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component | |
allowNegative : Boolean False to prevent entering a negative sign (defaults to true) | NumberField | |
anchor : String Note: this config is only used when this Component is rendered
-by a Container which has been configured to use an Anc... Note: this config is only used when this Component is rendered -by a Container which has been configured to use an AnchorLayout -based layout manager, for example:
See Ext.layout.AnchorLayout.anchor also. | Component | |
applyTo : Mixed Specify the id of the element, a DOM element or an existing Element corresponding to a DIV
-that is already present in... Specify the id of the element, a DOM element or an existing Element corresponding to a DIV -that is already present in the document that specifies some structural markup for this -component.
| Component | |
autoCreate : String/Object A DomHelper element spec, or true for a default
-element spec. Used to create the Element which will encapsulate this ... | Field | |
autoEl : Mixed A tag name or DomHelper spec used to create the Element which will
-encapsulate this Component.
-You do not normally ne... A tag name or DomHelper spec used to create the Element which will -encapsulate this Component. -You do not normally need to specify this. For the base classes Ext.Component, Ext.BoxComponent, -and Ext.Container, this defaults to 'div'. The more complex Ext classes use a more complex -DOM structure created by their own onRender methods. -This is intended to allow the developer to create application-specific utility Components encapsulated by -different DOM elements. Example usage:
| Component | |
autoHeight : Boolean True to use height:'auto', false to use fixed height (or allow it to be managed by its parent
-Container's layout mana... True to use height:'auto', false to use fixed height (or allow it to be managed by its parent -Container's layout manager. Defaults to false. -Note: Although many components inherit this config option, not all will -function as expected with a height of 'auto'. Setting autoHeight:true means that the -browser will manage height based on the element's contents, and that Ext will not manage it at all. -If the browser is managing the height, be aware that resizes performed by the browser in response -to changes within the structure of the Component cannot be detected. Therefore changes to the height might -result in elements needing to be synchronized with the new height. Example:
| BoxComponent | |
autoShow : Boolean True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
-them on render... True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
-them on render (defaults to false). | Component | |
autoWidth : Boolean True to use width:'auto', false to use fixed width (or allow it to be managed by its parent
-Container's layout manage... True to use width:'auto', false to use fixed width (or allow it to be managed by its parent -Container's layout manager. Defaults to false. -Note: Although many components inherit this config option, not all will -function as expected with a width of 'auto'. Setting autoWidth:true means that the -browser will manage width based on the element's contents, and that Ext will not manage it at all. -If the browser is managing the width, be aware that resizes performed by the browser in response -to changes within the structure of the Component cannot be detected. Therefore changes to the width might -result in elements needing to be synchronized with the new width. For example, where the target element is:
-A Panel rendered into that target element must listen for browser window resize in order to relay its
-child items when the browser changes its width:
| BoxComponent | |
baseChars : String The base set of characters to evaluate as valid numbers (defaults to '0123456789'). | NumberField | |
blankText : String The error text to display if the allowBlank validation
-fails (defaults to 'This field is required') | TextField | |
clearCls : String The CSS class used to to apply to the special clearing div rendered
-directly after each form field wrapper to provide... The CSS class used to to apply to the special clearing div rendered -directly after each form field wrapper to provide field clearing (defaults to -'x-form-clear-left'). -Note: this config is only used when this Component is rendered by a Container -which has been configured to use the FormLayout layout -manager (e.g. Ext.form.FormPanel or specifying layout:'form') and either a -fieldLabel is specified or isFormField=true is specified. - See Ext.layout.FormLayout.fieldTpl also. | Component | |
cls : String A custom CSS class to apply to the field's underlying element (defaults to ""). | Field | |
ctCls : String An optional extra CSS class that will be added to this component's container. This can be useful for
-adding customize... An optional extra CSS class that will be added to this component's container. This can be useful for -adding customized styles to the container or any of its children using standard CSS rules. See -Ext.layout.ContainerLayout.extraCls also. -Note: ctCls defaults to '' except for the following class -which assigns a value by default: -
- | Component | |
decimalPrecision : Number The maximum precision to display after the decimal separator (defaults to 2) | NumberField | |
decimalSeparator : String Character(s) to allow as the decimal separator (defaults to '.') | NumberField | |
disableKeyFilter : Boolean Specify true to disable input keystroke filtering (defaults
-to false) | TextField | |
disabled : Boolean True to disable the field (defaults to false).
-Be aware that conformant with the <a href="http://www.w3.org/TR/html40... True to disable the field (defaults to false).
- Be aware that conformant with the HTML specification, -disabled Fields will not be submitted. | Field | |
disabledClass : String CSS class added to the component when it is disabled (defaults to 'x-item-disabled'). | Component | |
emptyClass : String The CSS class to apply to an empty field to style the emptyText
-(defaults to 'x-form-empty-field'). This class is au... The CSS class to apply to an empty field to style the emptyText
-(defaults to 'x-form-empty-field'). This class is automatically added and removed as needed
-depending on the current field value. | TextField | |
emptyText : String The default text to place into an empty field (defaults to null).
-Note: that this value will be submitted to the serv... The default text to place into an empty field (defaults to null).
-Note: that this value will be submitted to the server if this field is enabled and configured
-with a name. | TextField | |
enableKeyEvents : Boolean true to enable the proxying of key events for the HTML input
-field (defaults to false) | TextField | |
fieldClass : String The default CSS class for the field (defaults to "x-form-field x-form-num-field") | NumberField | |
fieldLabel : String The label text to display next to this Component (defaults to '').
-Note: this config is only used when this Component... The label text to display next to this Component (defaults to ''). -Note: this config is only used when this Component is rendered by a Container which -has been configured to use the FormLayout layout manager (e.g. -Ext.form.FormPanel or specifying layout:'form'). - Also see hideLabel and -Ext.layout.FormLayout.fieldTpl. -Example use:
| Component | |
focusClass : String The CSS class to use when the field receives focus (defaults to "x-form-focus") | Field | |
grow : Boolean true if this field should automatically grow and shrink to its content
-(defaults to false) | TextField | |
growMax : Number The maximum width to allow when grow = true (defaults
-to 800) | TextField | |
growMin : Number The minimum width to allow when grow = true (defaults
-to 30) | TextField | |
height : Number The height of this component in pixels (defaults to auto).
-Note to express this dimension as a percentage or offset s... The height of this component in pixels (defaults to auto).
-Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent | |
hidden : Boolean Render this component hidden (default is false). If true, the
-hide method will be called internally. | Component | |
hideLabel : Boolean true to completely hide the label element
-(label and separator). Defaults to false.
-By default, even if you do not sp... true to completely hide the label element -(label and separator). Defaults to false. -By default, even if you do not specify a fieldLabel the space will still be -reserved so that the field will line up with other fields that do have labels. -Setting this to true will cause the field to not reserve that space. -Note: see the note for clearCls. -Example use:
| Component | |
hideMode : String How this component should be hidden. Supported values are 'visibility'
-(css visibility), 'offsets' (negative offset p... How this component should be hidden. Supported values are 'visibility' -(css visibility), 'offsets' (negative offset position) and 'display' -(css display). -Note: the default of 'display' is generally preferred -since items are automatically laid out when they are first shown (no sizing -is done while hidden). | Component | |
hideParent : Boolean True to hide and show the component's container when hide/show is called on the component, false to hide
-and show the... True to hide and show the component's container when hide/show is called on the component, false to hide
-and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide
-button on a window by setting hide:true on the button when adding it to its parent container. | Component | |
id : String The unique id of this component (defaults to an auto-assigned id).
-You should assign an id if you need to be able to ... The unique id of this component (defaults to an auto-assigned id). -You should assign an id if you need to be able to access the component later and you do -not have an object reference available (e.g., using Ext.getCmp). -Note that this id will also be used as the element id for the containing HTML element -that is rendered to the page for this component. This allows you to write id-based CSS -rules to style the specific instance of this component uniquely, and also to select -sub-elements using this component's id as the parent. -Note: to avoid complications imposed by a unique id also see
- Note: to access the container of an item see | Component | |
inputType : String The type attribute for input fields -- e.g. radio, text, password, file (defaults
-to "text"). The types "file" and "p... The type attribute for input fields -- e.g. radio, text, password, file (defaults
-to "text"). The types "file" and "password" must be used to render those field types currently -- there are
-no separate Ext components for those. Note that if you use inputType:'file', emptyText
-is not supported and should be avoided. | Field | |
invalidClass : String The CSS class to use when marking a field invalid (defaults to "x-form-invalid") | Field | |
invalidText : String The error text to use when marking a field invalid and no message is provided
-(defaults to "The value in this field i... The error text to use when marking a field invalid and no message is provided
-(defaults to "The value in this field is invalid") | Field | |
itemCls : String An additional CSS class to apply to the div wrapping the form item
-element of this field. If supplied, itemCls at th... An additional CSS class to apply to the div wrapping the form item -element of this field. If supplied, itemCls at the field level will override -the default itemCls supplied at the container level. The value specified for -itemCls will be added to the default class ('x-form-item'). -Since it is applied to the item wrapper (see -Ext.layout.FormLayout.fieldTpl), it allows -you to write standard CSS rules that can apply to the field, the label (if specified), or -any other element within the markup for the field. -Note: see the note for fieldLabel. -Example use:
| Component | |
itemId : String An itemId can be used as an alternative way to get a reference to a component
-when no object reference is available. ... An itemId can be used as an alternative way to get a reference to a component
-when no object reference is available. Instead of using an
-
-Note: to access the container of an item see ownerCt. | Component | |
labelSeparator : String The separator to display after the text of each
-fieldLabel. This property may be configured at various levels.
-The o... The separator to display after the text of each -fieldLabel. This property may be configured at various levels. -The order of precedence is: -
Note: see the note for clearCls. - Also see hideLabel and -Ext.layout.FormLayout.fieldTpl. -Example use:
| Component | |
labelStyle : String A CSS style specification string to apply directly to this field's
-label. Defaults to the container's labelStyle val... A CSS style specification string to apply directly to this field's -label. Defaults to the container's labelStyle value if set (e.g., -Ext.layout.FormLayout.labelStyle , or ''). -Note: see the note for - Also see
| Component | |
listeners : Object A config object containing one or more event handlers to be added to this
-object during initialization. This should ... A config object containing one or more event handlers to be added to this -object during initialization. This should be a valid listeners config object as specified in the -addListener example for attaching multiple handlers at once. -DOM events from ExtJs Components -While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
-is usually only done when extra value can be added. For example the DataView's
-
| Observable | |
margins : Object Note: this config is only used when this BoxComponent is rendered
-by a Container which has been configured to use the... Note: this config is only used when this BoxComponent is rendered -by a Container which has been configured to use the BorderLayout -or one of the two BoxLayout subclasses. -An object containing margins to apply to this BoxComponent in the -format:
-May also be a string containing space-separated, numeric margin values. The order of the -sides associated with each value matches the way CSS processes margin values: -
Defaults to:
| BoxComponent | |
maskRe : RegExp An input mask regular expression that will be used to filter keystrokes that do
-not match (defaults to null) | TextField | |
maxLength : Number Maximum input field length allowed by validation (defaults to Number.MAX_VALUE).
-This behavior is intended to provide... Maximum input field length allowed by validation (defaults to Number.MAX_VALUE).
-This behavior is intended to provide instant feedback to the user by improving usability to allow pasting
-and editing or overtyping and back tracking. To restrict the maximum number of characters that can be
-entered into the field use autoCreate to add
-any attributes you want to a field, for example:
| TextField | |
maxLengthText : String Error text to display if the maximum length
-validation fails (defaults to 'The maximum length for this field is {maxL... Error text to display if the maximum length
-validation fails (defaults to 'The maximum length for this field is {maxLength}') | TextField | |
maxText : String Error text to display if the maximum value validation fails (defaults to "The maximum value for this field is {maxVal... Error text to display if the maximum value validation fails (defaults to "The maximum value for this field is {maxValue}") | NumberField | |
maxValue : Number The maximum allowed value (defaults to Number.MAX_VALUE) | NumberField | |
minLength : Number Minimum input field length required (defaults to 0) | TextField | |
minLengthText : String Error text to display if the minimum length
-validation fails (defaults to 'The minimum length for this field is {minL... Error text to display if the minimum length
-validation fails (defaults to 'The minimum length for this field is {minLength}') | TextField | |
minText : String Error text to display if the minimum value validation fails (defaults to "The minimum value for this field is {minVal... Error text to display if the minimum value validation fails (defaults to "The minimum value for this field is {minValue}") | NumberField | |
minValue : Number The minimum allowed value (defaults to Number.NEGATIVE_INFINITY) | NumberField | |
msgFx : String Experimental The effect used when displaying a validation message under the field
-(defaults to 'normal'). | Field | |
msgTarget : String The location where error text should display. Should be one of the following values
-(defaults to 'qtip'):
-
-Value ... The location where error text should display. Should be one of the following values
-(defaults to 'qtip'):
- -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 - | Field | |
name : String The field's HTML name attribute (defaults to "").
-Note: this property must be set if this field is to be automaticall... The field's HTML name attribute (defaults to "").
-Note: this property must be set if this field is to be automatically included with
-form submit(). | Field | |
nanText : String Error text to display if the value is not a valid number. For example, this can happen
-if a valid character like '.'... Error text to display if the value is not a valid number. For example, this can happen
-if a valid character like '.' or '-' is left in the field with no number (defaults to "{value} is not a valid number") | NumberField | |
overCls : String An optional extra CSS class that will be added to this component's Element when the mouse moves
-over the Element, and... An optional extra CSS class that will be added to this component's Element when the mouse moves
-over the Element, and removed when the mouse moves out. (defaults to ''). This can be
-useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. | Component | |
pageX : Number The page level x coordinate for this component if contained within a positioning container. | BoxComponent | |
pageY : Number The page level y coordinate for this component if contained within a positioning container. | BoxComponent | |
plugins : Object/Array An object or array of objects that will provide custom functionality for this component. The only
-requirement for a ... An object or array of objects that will provide custom functionality for this component. The only
-requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.
-When a component is created, if any plugins are available, the component will call the init method on each
-plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the
-component as needed to provide its functionality. | Component | |
ptype : String The registered ptype to create. This config option is not used when passing
-a config object into a constructor. This ... The registered ptype to create. This config option is not used when passing
-a config object into a constructor. This config option is used only when
-lazy instantiation is being used, and a Plugin is being
-specified not as a fully instantiated Component, but as a Component config
-object. The ptype will be looked up at render time up to determine what
-type of Plugin to create. -If you create your own Plugins, you may register them using -Ext.ComponentMgr.registerPlugin in order to be able to -take advantage of lazy instantiation and rendering. | Component | |
readOnly : Boolean true to mark the field as readOnly in HTML
-(defaults to false).
-Note: this only sets the element's readOnly DOM attri... true to mark the field as readOnly in HTML
-(defaults to false).
- Note: this only sets the element's readOnly DOM attribute.
-Setting | Field | |
ref : String A path specification, relative to the Component's ownerCt specifying into which
-ancestor Container to place a named r... A path specification, relative to the Component's ownerCt specifying into which -ancestor Container to place a named reference to this Component. -The ancestor axis can be traversed by using '/' characters in the path. -For example, to put a reference to a Toolbar Button into the Panel which owns the Toolbar:
-In the code above, if the ref had been | Component | |
regex : RegExp A JavaScript RegExp object to be tested against the field value during validation
-(defaults to null). If the test fai... A JavaScript RegExp object to be tested against the field value during validation
-(defaults to null). If the test fails, the field will be marked invalid using
-regexText. | TextField | |
regexText : String The error text to display if regex is used and the
-test fails during validation (defaults to '') | TextField | |
region : String Note: this config is only used when this BoxComponent is rendered
-by a Container which has been configured to use the... Note: this config is only used when this BoxComponent is rendered -by a Container which has been configured to use the BorderLayout -layout manager (e.g. specifying layout:'border'). - See Ext.layout.BorderLayout also. | BoxComponent | |
renderTo : Mixed Specify the id of the element, a DOM element or an existing Element that this component
-will be rendered into.
-Notes ... Specify the id of the element, a DOM element or an existing Element that this component -will be rendered into.
See render also. | Component | |
selectOnFocus : Boolean true to automatically select any existing field text when the field
-receives input focus (defaults to false) | TextField | |
stateEvents : Array An array of events that, when fired, should trigger this component to
-save its state (defaults to none). stateEvents ... An array of events that, when fired, should trigger this component to
-save its state (defaults to none). See | Component | |
stateId : String The unique id for this component to use for state management purposes
-(defaults to the component id if one was set, o... The unique id for this component to use for state management purposes
-(defaults to the component id if one was set, otherwise null if the
-component is using a generated id).
- See | Component | |
stateful : Boolean A flag which causes the Component to attempt to restore the state of
-internal properties from a saved state on startu... A flag which causes the Component to attempt to restore the state of
-internal properties from a saved state on startup. The component must have
-either a - For state saving to work, the state manager's provider must have been -set to an implementation of Ext.state.Provider which overrides the -set and get -methods to save and recall name/value pairs. A built-in implementation, -Ext.state.CookieProvider is available. -To set the state provider for the current page: -
-A stateful Component attempts to save state when one of the events
-listed in the To save state, a stateful Component first serializes its state by
-calling The value yielded by getState is passed to Ext.state.Manager.set
-which uses the configured Ext.state.Provider to save the object
-keyed by the Component's During construction, a stateful Component attempts to restore
-its state by calling Ext.state.Manager.get passing the
- The resulting object is passed to You can perform extra processing on state save and restore by attaching -handlers to the beforestaterestore, staterestore, -beforestatesave and statesave events. | Component | |
stripCharsRe : RegExp A JavaScript RegExp object used to strip unwanted content from the value
-before validation (defaults to null). | TextField | |
style : String A custom style specification to be applied to this component's Element. Should be a valid argument to
-Ext.Element.ap... A custom style specification to be applied to this component's Element. Should be a valid argument to
-Ext.Element.applyStyles.
-
| Component | |
tabIndex : Number The tabIndex for this field. Note this only applies to fields that are rendered,
-not those which are built via applyT... The tabIndex for this field. Note this only applies to fields that are rendered,
-not those which are built via applyTo (defaults to undefined). | Field | |
validateOnBlur : Boolean Whether the field should validate when it loses focus (defaults to true). | Field | |
validationDelay : Number The length of time in milliseconds after user input begins until validation
-is initiated (defaults to 250) | Field | |
validationEvent : String/Boolean The event that should initiate field validation. Set to false to disable
- automatic validation (defaults to "key... The event that should initiate field validation. Set to false to disable
- automatic validation (defaults to "keyup"). | Field | |
validator : Function A custom validation function to be called during field validation
-(defaults to null). If specified, this function wil... A custom validation function to be called during field validation
-(defaults to null). If specified, this function will be called first, allowing the
-developer to override the default validation process. This function will be passed the current
-field value and expected to return boolean true if the value is valid or a string
-error message if invalid. | TextField | |
value : Mixed A value to initialize this field with (defaults to undefined). | Field | |
vtype : String A validation type name as defined in Ext.form.VTypes (defaults to null) | TextField | |
vtypeText : String A custom error message to display in place of the default message provided
-for the vtype currently set for this field... | TextField | |
width : Number The width of this component in pixels (defaults to auto).
-Note to express this dimension as a percentage or offset se... The width of this component in pixels (defaults to auto).
-Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent | |
x : Number The local x (left) coordinate for this component if contained within a positioning container. | BoxComponent | |
xtype : String The registered xtype to create. This config option is not used when passing
-a config object into a constructor. This ... The registered xtype to create. This config option is not used when passing
-a config object into a constructor. This config option is used only when
-lazy instantiation is being used, and a child item of a Container is being
-specified not as a fully instantiated Component, but as a Component config
-object. The xtype will be looked up at render time up to determine what
-type of child Component to create. -The predefined xtypes are listed here. - -If you subclass Components to create your own Components, you may register -them using Ext.ComponentMgr.registerType in order to be able to -take advantage of lazy instantiation and rendering. | Component | |
y : Number The local y (top) coordinate for this component if contained within a positioning container. | BoxComponent |
Property | Defined By | |
---|---|---|
disabled : Boolean True if this component is disabled. Read-only. | Component | |
el : Ext.Element The Ext.Element which encapsulates this Component. Read-only.
-This will usually be a <DIV> element created by the ... The Ext.Element which encapsulates this Component. Read-only. -This will usually be a <DIV> element created by the class's onRender method, but
-that may be overridden using the Note: this element will not be available until this Component has been rendered. - To add listeners for DOM events to this Component (as opposed to listeners -for this Component's own Observable events), see the listeners -config for a suggestion, or use a render listener directly:
-See also getEl | Component | |
hidden : Boolean True if this component is hidden. Read-only. | Component | |
initialConfig : Object This Component's initial configuration specification. Read-only. | Component | |
originalValue : mixed The original value of the field as configured in the value configuration, or
-as loaded by the last form load operatio... The original value of the field as configured in the value configuration, or
-as loaded by the last form load operation if the form's trackResetOnLoad
-setting is true . | Field | |
ownerCt : Ext.Container The component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a... The component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a container). Read-only.
- Note: to access items within the container see itemId. | Component | |
rendered : Boolean True if this component has been rendered. Read-only. | Component |
Method | Defined By | |
---|---|---|
addClass( string cls )
- :
- Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. Parameters:
| Component | |
addEvents( Object object )
- :
- voidUsed to define events on this Observable Used to define events on this Observable Parameters:
| Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
- :
- voidAppends an event handler to this object. Appends an event handler to this object. Parameters:
| Observable | |
applyToMarkup( String/HTMLElement el )
- :
- voidApply this component to existing markup that is valid. With this function, no call to render() is required. Apply this component to existing markup that is valid. With this function, no call to render() is required. Parameters:
| Component | |
autoSize()
- :
- void Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.
-This only ta... | TextField | |
clearInvalid()
- :
- void Clear any invalid styles/messages for this field Clear any invalid styles/messages for this field Parameters:
| Field | |
cloneConfig( Object overrides )
- :
- Ext.ComponentClone the current component using the original config values passed into this instance by default. Clone the current component using the original config values passed into this instance by default. Parameters:
| Component | |
destroy()
- :
- void Destroys this component by purging any event listeners, removing the component's element from the DOM,
-removing the c... Destroys this component by purging any event listeners, removing the component's element from the DOM,
-removing the component from its Ext.Container (if applicable) and unregistering it from
-Ext.ComponentMgr. Destruction is generally handled automatically by the framework and this method
-should usually not need to be called directly. Parameters:
| Component | |
disable()
- :
- Ext.Component Disable this component and fire the 'disable' event. Disable this component and fire the 'disable' event. Parameters:
| Component | |
enable()
- :
- Ext.Component Enable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. Parameters:
| Component | |
enableBubble( Object events )
- :
- voidUsed to enable bubbling of events Used to enable bubbling of events Parameters:
| Observable | |
findParentBy( Function fn )
- :
- Ext.ContainerFind a container above this component at any level by a custom function. If the passed function returns
-true, the con... Find a container above this component at any level by a custom function. If the passed function returns
-true, the container will be returned. Parameters:
| Component | |
findParentByType( String/Class xtype )
- :
- Ext.ContainerFind a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class Parameters:
| Component | |
fireEvent( String eventName , Object... args )
- :
- BooleanFires the specified event with the passed parameters (minus the event name).
-An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name). -An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) -by calling enableBubble. Parameters:
| Observable | |
focus( [Boolean selectText ], [Boolean/Number delay ] )
- :
- Ext.ComponentTry to focus this component. Try to focus this component. Parameters:
| Component | |
getBox( [Boolean local ] )
- :
- ObjectGets the current box measurements of the component's underlying element. Gets the current box measurements of the component's underlying element. Parameters:
| BoxComponent | |
getBubbleTarget()
- :
- Ext.Container Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Parameters:
| Component | |
getEl()
- :
- Ext.Element Returns the Ext.Element which encapsulates this Component.
-This will usually be a <DIV> element created by the cla... Returns the Ext.Element which encapsulates this Component. -This will usually be a <DIV> element created by the class's onRender method, but -that may be overridden using the autoEl config. -Note: this element will not be available until this Component has been rendered. - To add listeners for DOM events to this Component (as opposed to listeners -for this Component's own Observable events), see the listeners config for a suggestion, -or use a render listener directly:
Parameters:
| Component | |
getHeight()
- :
- Number Gets the current height of the component's underlying element. Gets the current height of the component's underlying element. Parameters:
| BoxComponent | |
getId()
- :
- String Returns the id of this component or automatically generates and
-returns an id if an id is not defined yet:'ext-comp-'... Returns the id of this component or automatically generates and
-returns an id if an id is not defined yet:
Parameters:
| Component | |
getItemId() - : - String | Component | |
getName()
- :
- String Returns the name or hiddenName
-attribute of the field if available. Returns the name or hiddenName
-attribute of the field if available. Parameters:
| Field | |
getOuterSize()
- :
- Object Gets the current size of the component's underlying element, including space taken by its margins. Gets the current size of the component's underlying element, including space taken by its margins. Parameters:
| BoxComponent | |
getPosition( [Boolean local ] )
- :
- ArrayGets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. Parameters:
| BoxComponent | |
getRawValue()
- :
- Mixed Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue... Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue. Parameters:
| Field | |
getResizeEl()
- :
- void Returns the outermost Element of this Component which defines the Components overall size.
-Usually this will return t... Returns the outermost Element of this Component which defines the Components overall size. -Usually this will return the same Element as An example is a ComboBox. It is encased in a wrapping Element which
-contains both the Parameters:
| BoxComponent | |
getSize()
- :
- Object Gets the current size of the component's underlying element. Gets the current size of the component's underlying element. Parameters:
| BoxComponent | |
getValue()
- :
- Mixed Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see getRa... Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see getRawValue. Parameters:
| Field | |
getWidth()
- :
- Number Gets the current width of the component's underlying element. Gets the current width of the component's underlying element. Parameters:
| BoxComponent | |
getXType()
- :
- String Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
-available xtypes, see the Ex... Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
-available xtypes, see the Ext.Component header. Example usage:
-
Parameters:
| Component | |
getXTypes()
- :
- String Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
-available xtypes, see the Ext... Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all -available xtypes, see the Ext.Component header. -If using your own subclasses, be aware that a Component must register its own xtype -to participate in determination of inherited xtypes. -Example usage: -
Parameters:
| Component | |
hasListener( String eventName )
- :
- BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters:
| Observable | |
hide()
- :
- Ext.Component Hide this component. Listen to the 'beforehide' event and return
-false to cancel hiding the component. Fires the 'h... Hide this component. Listen to the 'beforehide' event and return
-false to cancel hiding the component. Fires the 'hide'
-event after hiding the component. Note this method is called internally if
-the component is configured to be hidden .Parameters:
| Component | |
isDirty()
- :
- Boolean Returns true if the value of this Field has been changed from its original value.
-Will return false if the field is d... Returns true if the value of this Field has been changed from its original value. -Will return false if the field is disabled or has not been rendered yet. -Note that if the owning form was configured with -Ext.form.BasicForm.trackResetOnLoad -then the original value is updated when the values are loaded by -Ext.form.BasicForm.setValues. Parameters:
| Field | |
isValid( Boolean preventMark )
- :
- BooleanReturns whether or not the field value is currently valid Returns whether or not the field value is currently valid Parameters:
| Field | |
isVisible()
- :
- Boolean Returns true if this component is visible. Returns true if this component is visible. Parameters:
| Component | |
isXType( String xtype , [Boolean shallow ] )
- :
- BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
-from th... Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended -from the xtype (default) or whether it is directly of the xtype specified (shallow = true). -If using your own subclasses, be aware that a Component must register its own xtype -to participate in determination of inherited xtypes. -For a list of all available xtypes, see the Ext.Component header. -Example usage: -
Parameters:
| Component | |
markInvalid( [String msg ] )
- :
- voidMark this field as invalid, using msgTarget to determine how to display the error and
-applying invalidClass to the fi... Mark this field as invalid, using msgTarget to determine how to display the error and
-applying invalidClass to the field's element. Parameters:
| Field | |
nextSibling()
- :
- Ext.Component Returns the next component in the owning container Returns the next component in the owning container Parameters:
| Component | |
on( String eventName , Function handler , [Object scope ], [Object options ] )
- :
- voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:
| Observable | |
previousSibling()
- :
- Ext.Component Returns the previous component in the owning container Returns the previous component in the owning container Parameters:
| Component | |
purgeListeners()
- :
- void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
relayEvents( Object o , Array events )
- :
- voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. Parameters:
| Observable | |
removeClass( string cls )
- :
- Ext.ComponentRemoves a CSS class from the component's underlying element. Removes a CSS class from the component's underlying element. Parameters:
| Component | |
removeListener( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler. Removes an event handler. Parameters:
| Observable | |
render( [Element/HTMLElement/String container ], [String/Number position ] )
- :
- voidRender this Component into the passed HTML element.
-If you are using a Container object to house this Component, then... Render this Component into the passed HTML element. -If you are using a Container object to house this Component, then -do not use the render method. -A Container's child Components are rendered by that Container's -layout manager when the Container is first rendered. -Certain layout managers allow dynamic addition of child components. Those that do -include Ext.layout.CardLayout, Ext.layout.AnchorLayout, -Ext.layout.FormLayout, Ext.layout.TableLayout. -If the Container is already rendered when a new child Component is added, you may need to call -the Container's doLayout to refresh the view which causes any -unrendered child Components to be rendered. This is required so that you can add multiple -child components if needed while only refreshing the layout once. -When creating complex UIs, it is important to remember that sizing and positioning -of child items is the responsibility of the Container's layout manager. -If you expect child items to be sized in response to user interactions, you must -configure the Container with a layout manager which creates and manages the type of layout you -have in mind. -Omitting the Container's layout config means that a basic -layout manager is used which does nothing but render child components sequentially into the -Container. No sizing or positioning will be performed in this situation. Parameters:
| Component | |
reset()
- :
- void Resets the current field value to the originally-loaded value and clears any validation messages.
-Also adds emptyText... Resets the current field value to the originally-loaded value and clears any validation messages.
-Also adds emptyText and emptyClass if the
-original value was blank. Parameters:
| TextField | |
resumeEvents()
- :
- void Resume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
-event... Resume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
-events fired during event suspension will be sent to any listeners now. Parameters:
| Observable | |
selectText( [Number start ], [Number end ] )
- :
- voidSelects text in this field Selects text in this field Parameters:
| TextField | |
setDisabled( Boolean disabled )
- :
- Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters:
| Component | |
setHeight( Number height )
- :
- Ext.BoxComponentSets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters:
| BoxComponent | |
setPagePosition( Number x , Number y )
- :
- Ext.BoxComponentSets the page XY position of the component. To set the left and top instead, use setPosition.
-This method fires the ... Sets the page XY position of the component. To set the left and top instead, use setPosition.
-This method fires the move event. Parameters:
| BoxComponent | |
setPosition( Number left , Number top )
- :
- Ext.BoxComponentSets the left and top of the component. To set the page XY position instead, use setPagePosition.
-This method fires ... Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
-This method fires the move event. Parameters:
| BoxComponent | |
setRawValue( Mixed value )
- :
- MixedSets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue. Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue. Parameters:
| Field | |
setSize( Mixed width , Mixed height )
- :
- Ext.BoxComponentSets the width and height of this BoxComponent. This method fires the resize event. This method can accept
-either wid... Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept
-either width and height as separate arguments, or you can pass a size object like {width:10, height:20} .Parameters:
| BoxComponent | |
setValue( Mixed value )
- :
- Ext.form.FieldSets a data value into the field and validates it. To set the value directly without validation see setRawValue. Sets a data value into the field and validates it. To set the value directly without validation see setRawValue. Parameters:
| Field | |
setVisible( Boolean visible )
- :
- Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters:
| Component | |
setWidth( Number width )
- :
- Ext.BoxComponentSets the width of the component. This method fires the resize event. Sets the width of the component. This method fires the resize event. Parameters:
| BoxComponent | |
show()
- :
- Ext.Component Show this component. Listen to the 'beforeshow' event and return
-false to cancel showing the component. Fires the '... Show this component. Listen to the 'beforeshow' event and return
-false to cancel showing the component. Fires the 'show'
-event after showing the component. Parameters:
| Component | |
suspendEvents( Boolean queueSuspended )
- :
- voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| Observable | |
syncSize()
- :
- Ext.BoxComponent Force the component's size to recalculate based on the underlying element's current height and width. Force the component's size to recalculate based on the underlying element's current height and width. Parameters:
| BoxComponent | |
un( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | |
updateBox( Object box )
- :
- Ext.BoxComponentSets the current box measurements of the component's underlying element. Sets the current box measurements of the component's underlying element. Parameters:
| BoxComponent | |
validate()
- :
- Boolean Validates the field value Validates the field value Parameters:
| Field | |
validateValue( Mixed value )
- :
- BooleanValidates a value according to the field's validation rules and marks the field as invalid
-if the validation fails Validates a value according to the field's validation rules and marks the field as invalid
-if the validation fails Parameters:
| TextField |
Event | Defined By | |
---|---|---|
afterrender :
- ( Ext.Component this )
- Fires after the component rendering is finished.
-The afterrender event is fired after this Component has been rendere... Fires after the component rendering is finished. -The afterrender event is fired after this Component has been rendered, been postprocesed -by any afterRender method defined for the Component, and, if stateful, after state -has been restored. Listeners will be called with the following arguments:
| Component | |
autosize :
- ( Ext.form.Field this , Number width )
- Fires when the autoSize function is triggered. The field may or
-may not have actually changed size according to the d... Fires when the autoSize function is triggered. The field may or
-may not have actually changed size according to the default logic, but this event provides
-a hook for the developer to apply additional logic at runtime to resize the field if needed. Listeners will be called with the following arguments:
| TextField | |
beforedestroy :
- ( Ext.Component this )
- | Component | |
beforehide :
- ( Ext.Component this )
- Fires before the component is hidden by calling the hide method.
-Return false from an event handler to stop the hide. Fires before the component is hidden by calling the hide method.
-Return false from an event handler to stop the hide. Listeners will be called with the following arguments:
| Component | |
beforerender :
- ( Ext.Component this )
- | Component | |
beforeshow :
- ( Ext.Component this )
- Fires before the component is shown by calling the show method.
-Return false from an event handler to stop the show. Fires before the component is shown by calling the show method.
-Return false from an event handler to stop the show. Listeners will be called with the following arguments:
| Component | |
beforestaterestore :
- ( Ext.Component this , Object state )
- Fires before the state of the component is restored. Return false from an event handler to stop the restore. Fires before the state of the component is restored. Return false from an event handler to stop the restore. Listeners will be called with the following arguments:
| Component | |
beforestatesave :
- ( Ext.Component this , Object state )
- Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Listeners will be called with the following arguments:
| Component | |
blur :
- ( Ext.form.Field this )
- Fires when this field loses input focus. Fires when this field loses input focus. Listeners will be called with the following arguments:
| Field | |
change :
- ( Ext.form.Field this , Mixed newValue , Mixed oldValue )
- Fires just before the field blurs if the field value has changed. Fires just before the field blurs if the field value has changed. Listeners will be called with the following arguments:
| Field | |
destroy :
- ( Ext.Component this )
- Fires after the component is destroyed. Fires after the component is destroyed. Listeners will be called with the following arguments:
| Component | |
disable :
- ( Ext.Component this )
- Fires after the component is disabled. Fires after the component is disabled. Listeners will be called with the following arguments:
| Component | |
enable :
- ( Ext.Component this )
- Fires after the component is enabled. Fires after the component is enabled. Listeners will be called with the following arguments:
| Component | |
focus :
- ( Ext.form.Field this )
- Fires when this field receives input focus. Fires when this field receives input focus. Listeners will be called with the following arguments:
| Field | |
hide :
- ( Ext.Component this )
- Fires after the component is hidden.
-Fires after the component is hidden when calling the hide method. Fires after the component is hidden.
-Fires after the component is hidden when calling the hide method. Listeners will be called with the following arguments:
| Component | |
invalid :
- ( Ext.form.Field this , String msg )
- Fires after the field has been marked as invalid. Fires after the field has been marked as invalid. Listeners will be called with the following arguments:
| Field | |
keydown :
- ( Ext.form.TextField this , Ext.EventObject e )
- Keydown input field event. This event only fires if enableKeyEvents
-is set to true. Keydown input field event. This event only fires if enableKeyEvents
-is set to true. Listeners will be called with the following arguments:
| TextField | |
keypress :
- ( Ext.form.TextField this , Ext.EventObject e )
- Keypress input field event. This event only fires if enableKeyEvents
-is set to true. Keypress input field event. This event only fires if enableKeyEvents
-is set to true. Listeners will be called with the following arguments:
| TextField | |
keyup :
- ( Ext.form.TextField this , Ext.EventObject e )
- Keyup input field event. This event only fires if enableKeyEvents
-is set to true. Keyup input field event. This event only fires if enableKeyEvents
-is set to true. Listeners will be called with the following arguments:
| TextField | |
move :
- ( Ext.Component this , Number x , Number y )
- Fires after the component is moved. Fires after the component is moved. Listeners will be called with the following arguments:
| BoxComponent | |
render :
- ( Ext.Component this )
- Fires after the component markup is rendered. Fires after the component markup is rendered. Listeners will be called with the following arguments:
| Component | |
resize :
- ( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight )
- Fires after the component is resized. Fires after the component is resized. Listeners will be called with the following arguments:
| BoxComponent | |
show :
- ( Ext.Component this )
- Fires after the component is shown when calling the show method. Fires after the component is shown when calling the show method. Listeners will be called with the following arguments:
| Component | |
specialkey :
- ( Ext.form.Field this , Ext.EventObject e )
- Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.
-To handle other keys see Ext.Pan... Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.
-To handle other keys see Ext.Panel.keys or Ext.KeyMap.
-You can check Ext.EventObject.getKey to determine which key was pressed.
-For example:
Listeners will be called with the following arguments:
| Field | |
staterestore :
- ( Ext.Component this , Object state )
- Fires after the state of the component is restored. Fires after the state of the component is restored. Listeners will be called with the following arguments:
| Component | |
statesave :
- ( Ext.Component this , Object state )
- Fires after the state of the component is saved to the configured state provider. Fires after the state of the component is saved to the configured state provider. Listeners will be called with the following arguments:
| Component | |
valid :
- ( Ext.form.Field this )
- Fires after the field has been validated with no errors. Fires after the field has been validated with no errors. Listeners will be called with the following arguments:
| Field |