X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/d41dc04ad17d1d9125fb2cf72db2b4782dbe3a8c..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/output/Ext.form.TriggerField.html?ds=inline diff --git a/docs/output/Ext.form.TriggerField.html b/docs/output/Ext.form.TriggerField.html deleted file mode 100644 index 1ff3cf11..00000000 --- a/docs/output/Ext.form.TriggerField.html +++ /dev/null @@ -1,2623 +0,0 @@ -
Observable - Component - BoxComponent - Field - TextField - TriggerField
Package: | Ext.form |
Defined In: | TriggerField.js |
Class: | TriggerField |
Subclasses: | ComboBox, DateField |
Extends: | TextField |
var trigger = new Ext.form.TriggerField();
-trigger.onTriggerClick = myTriggerFn;
-trigger.applyToMarkup('my-field');
-However, in general you will most likely want to use TriggerField as the base class for a reusable component.
-Ext.form.DateField and Ext.form.ComboBox are perfect examples of this. Config Options | -Defined By | -|
---|---|---|
- |
-
- allowBlank : Boolean
- False to validate that the value length > 0 (defaults to true)
- |
- TextField | -
- |
-
- allowDomMove : Boolean
- Whether the component can move the Dom node when rendering (defaults to true).
- |
- Component | -
- |
-
- applyTo : Mixed
-
- The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document ...
-
- The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component. When applyTo is used, constituent parts of the component can also be specified by id or CSS class name within the main element, and the component being created may attempt to create its subcomponents from that markup if applicable. Using this config, a call to render() is not required. If applyTo is specified, any value passed for renderTo will be ignored and the target element's parent node will automatically be used as the component's container.
- |
- Component | -
- |
-
- autoCreate : String/Object
-
- A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "16", au...
-
- A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "16", autocomplete: "off"})
- |
- TriggerField | -
- |
-
- autoEl : String/Object
-
- A tag name or DomHelper spec to create an element with. This is intended to create shorthand utility components inlin...
-
- A tag name or DomHelper spec to create an element with. This is intended to create shorthand utility components inline via JSON. It should not be used for higher level components which already create their own elements. Example usage:
- |
- Component | -
- |
-
- autoHeight : Boolean
-
- True to use height:'auto', false to use fixed height (defaults to false). Note: Although many components inherit this...
-
- True to use height:'auto', false to use fixed height (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.
- |
- 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 (defaults to false). Note: Although many components inherit this c...
-
- True to use width:'auto', false to use fixed width (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.
- |
- BoxComponent | -
- |
-
- blankText : String
- Error text to display if the allow blank validation fails (defaults to "This field is required")
- |
- TextField | -
- |
-
- clearCls : String
-
- The CSS class used to provide field clearing (defaults to 'x-form-clear-left'). This config is only used when this Co...
-
- The CSS class used to provide field clearing (defaults to 'x-form-clear-left').
- This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. |
- Component | -
- |
-
- cls : String
-
- An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for a...
-
- An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules.
- |
- Component | -
- |
-
- ctCls : String
-
- An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for...
-
- An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.
- |
- Component | -
- |
-
- disableKeyFilter : Boolean
- True to disable input keystroke filtering (defaults to false)
- |
- TextField | -
- |
-
- disabled : Boolean
- Render this component disabled (default is false).
- |
- Component | -
- |
-
- 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 aut...
-
- 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 serve...
-
- 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 | -
- |
-
- fieldClass : String
- The default CSS class for the field (defaults to "x-form-field")
- |
- Field | -
- |
-
- fieldLabel : String
-
- The label text to display next to this Component (defaults to '') This config is only used when this Component is ren...
-
- The label text to display next to this Component (defaults to '')
- This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: |
- Component | -
- |
-
- focusClass : String
- The CSS class to use when the field receives focus (defaults to "x-form-focus")
- |
- Field | -
- |
-
- height : Number
- The height of this component in pixels (defaults to auto).
- |
- BoxComponent | -
- |
-
- Render this component hidden (default is false).
- |
-
- hidden : Boolean Component | -
- |
-
- hideLabel : Boolean
-
- True to completely hide the label element (defaults to false). By default, even if you do not specify a fieldLabel th...
-
- True to completely hide the label element (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.
- This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. 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) - defaults to "display". For Containers which may be hidden and shown as part of a card layout Container such as a TabPanel, it is recommended that hideMode is configured as "offsets". This ensures that hidden Components still have height and width so that layout managers can perform measurements when calculating layouts. |
- 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 | -
- |
-
- hideTrigger : Boolean
- True to hide the trigger element and display only the base text field (defaults to false)
- |
- TriggerField | -
- |
-
- 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.ComponentMgr.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.
- |
- 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 wrapper's form item element of this field (defaults to the container's itemCl...
-
- An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCls value if set, or ''). Since it is applied to the item wrapper, 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.
- This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: |
- Component | -
- |
-
- labelSeparator : String
-
- The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.l...
-
- The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.labelSeparator, which is a colon ':' by default). To display no separator for this field's label specify empty string ''.
- This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: |
- Component | -
- |
-
- labelStyle : String
-
- A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if se...
-
- A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or '').
- . This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: |
- Component | -
- |
-
- listeners : Object
-
- (optional) A config object containing one or more event handlers to be added to this object during initialization. Th...
-
- (optional) 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.
- |
- Observable | -
- |
-
- maskRe : RegExp
- An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)
- |
- TextField | -
- |
-
- maxLength : Number
- Maximum input field length allowed (defaults to Number.MAX_VALUE)
- |
- 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 | -
- |
-
- 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 | -
- |
-
- 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 "").
- |
- Field | -
- |
-
- 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 v...
-
- 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 | -
- |
-
- readOnly : Boolean
-
- True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM att...
-
- True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.
- |
- Field | -
- |
-
- regex : RegExp
-
- A JavaScript RegExp object to be tested against the field value during validation (defaults to null). If available, t...
-
- A JavaScript RegExp object to be tested against the field value during validation (defaults to null). If available, this regex will be evaluated only after the basic validators all return true, and will be passed the current field value. 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 | -
- |
-
- renderTo : Mixed
-
- The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using...
-
- The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.
- |
- 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). These can be...
-
- An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be any types of events supported by this component, including browser or custom events (e.g., ['click', 'customerchange']).
- See stateful for an explanation of saving and restoring Component state. |
- 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 stateful for an explanation of saving and restoring Component state. |
- 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 stateId or id assigned for state to be managed. Auto-generated ids are not guaranteed to be stable across page loads and cannot be relied upon to save and restore the same state for a component. 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: Components attempt to save state when one of the events listed in the stateEvents configuration fires. 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.app...
-
- 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 | -
- |
-
- triggerClass : String
- A CSS class to apply to the trigger
- |
- TriggerField | -
- |
-
- 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 "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 only after the built-in validations (allowBlank, minLength, maxLength) and any configured vtype all return true. 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...
-
- A custom error message to display in place of the default message provided for the vtype currently set for this field (defaults to ''). Only applies if vtype is set, else ignored.
- |
- TextField | -
- |
-
- width : Number
- The width of this component in pixels (defaults to auto).
- |
- 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 | -
- |
-
-
-True if this component is hidden. Read-only.
- |
-
- hidden : Boolean Component | -
- |
-
- initialConfig : Object
- This Component's initial configuration specification. Read-only.
- |
- Component | -
- |
-
- 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.
- |
- Component | -
- |
-
- rendered : Boolean
- True if this component has been rendered. Read-only.
- |
- Component | -
Method | -Defined By | -|
---|---|---|
- |
-
- TriggerField( Object config )
-
- Create a new TriggerField.
-
- Create a new TriggerField.
-
- Parameters:
-
-
|
- TriggerField | -
- |
-
- addClass( string cls ) : void
-
- Adds a CSS class to the component's underlying element.
-
- Adds a CSS class to the component's underlying element.
-
- Parameters:
-
-
|
- Component | -
- |
-
- addEvents( Object object ) : void
-
- Used to define events on this Observable
-
- Used to define events on this Observable
-
- Parameters:
-
-
|
- Observable | -
- |
-
- addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void
-
- Appends an event handler to this component
-
- Appends an event handler to this component
-
- Parameters:
-
-
|
- Observable | -
- |
-
- applyToMarkup( String/HTMLElement el ) : void
-
- Apply 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 | -
- |
-
- clearInvalid() : void
-
- Clear any invalid styles/messages for this field
-
- Clear any invalid styles/messages for this field
-
- Parameters:
-
-
|
- Field | -
- |
-
- cloneConfig( Object overrides ) : Ext.Component
-
- Clone 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.
-
- Disable this component.
-
- Parameters:
-
-
|
- Component | -
- |
-
- enable() : Ext.Component
-
- Enable this component.
-
- Enable this component.
-
- Parameters:
-
-
|
- Component | -
- |
-
- findParentBy( Function fcn , [Object scope ] ) : Ext.Container
-
- Find 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. The passed function is called with the arguments (container, this component).
-
- Parameters:
-
-
|
- Component | -
- |
-
- findParentByType( String/Class xtype ) : Ext.Container
-
- Find 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 ) : Boolean
-
- Fires the specified event with the passed parameters (minus the event name).
-
- Fires the specified event with the passed parameters (minus the event name).
-
- Parameters:
-
-
|
- Observable | -
- |
-
- focus( [Boolean selectText ], [Boolean/Number delay ] ) : Ext.Component
-
- Try to focus this component.
-
- Try to focus this component.
-
- Parameters:
-
-
|
- Component | -
- |
-
- getBox( [Boolean local ] ) : Object
-
- Gets the current box measurements of the component's underlying element.
-
- Gets the current box measurements of the component's underlying element.
-
- Parameters:
-
-
|
- BoxComponent | -
- |
-
- getEl() : Ext.Element
-
- Returns the underlying Ext.Element.
-
- Returns the underlying Ext.Element.
-
- Parameters:
-
-
|
- Component | -
- |
-
- getId() : String
-
- Returns the id of this component.
-
- Returns the id of this component.
-
- Parameters:
-
-
|
- Component | -
- |
-
- getItemId() : String
-
- Returns the item id of this component.
-
- Returns the item id of this component.
-
- Parameters:
-
-
|
- Component | -
- |
-
- getName() : String
-
- Returns the name attribute of the field if available
-
- Returns the name attribute of the field if available
-
- Parameters:
-
-
|
- Field | -
- |
-
- getPosition( [Boolean local ] ) : Array
-
- Gets 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 | -
- |
-
- 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 | -
- |
-
- 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 ) : Boolean
-
- Checks 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.
-
- Hide this component.
-
- Parameters:
-
-
|
- Component | -
- |
-
- initComponent() : void
-
-
-
-
-
- Parameters:
-
-
|
- TextField | -
- |
-
- isDirty() : void
-
- Returns true if this field has been changed since it was originally loaded and is not disabled.
-
- Returns true if this field has been changed since it was originally loaded and is not disabled.
-
- Parameters:
-
-
|
- Field | -
- |
-
- isValid( Boolean preventMark ) : Boolean
-
- Returns whether or not the field value is currently valid
-
- Returns whether or not the field value is currently valid
-
- Parameters:
-
-
|
- Field | -
- |
-
- isVisible() : void
-
- Returns true if this component is visible.
-
- Returns true if this component is visible.
-
- Parameters:
-
-
|
- Component | -
- |
-
- isXType( String xtype , [Boolean shallow ] ) : void
-
- Tests 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 ] ) : void
-
- Mark 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 | -
- |
-
- on( String eventName , Function handler , [Object scope ], [Object options ] ) : void
-
- Appends an event handler to this element (shorthand for addListener)
-
- Appends an event handler to this element (shorthand for addListener)
-
- Parameters:
-
-
|
- Observable | -
- |
-
- onTriggerClick( EventObject e ) : void
-
- The function that should handle the trigger's click event. This method does nothing by default until overridden
-by a...
-
- The function that should handle the trigger's click event. This method does nothing by default until overridden
-by an implementing function.
-
- Parameters:
-
-
|
- TriggerField | -
- |
-
- purgeListeners() : void
-
- Removes all listeners for this object
-
- Removes all listeners for this object
-
- Parameters:
-
-
|
- Observable | -
- |
-
- relayEvents( Object o , Array events ) : void
-
- Relays 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 ) : void
-
- Removes 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 ] ) : void
-
- Removes a listener
-
- Removes a listener
-
- Parameters:
-
-
|
- Observable | -
- |
-
- render( [Element/HTMLElement/String container ], [String/Number position ] ) : void
-
- Render 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
-
- Resets the current field value to the originally loaded value and clears any validation messages
-
- Parameters:
-
-
|
- Field | -
- |
-
- resumeEvents() : void
-
- Resume firing events. (see suspendEvents)
-
- Resume firing events. (see suspendEvents)
-
- Parameters:
-
-
|
- Observable | -
- |
-
- selectText( [Number start ], [Number end ] ) : void
-
- Selects text in this field
-
- Selects text in this field
-
- Parameters:
-
-
|
- TextField | -
- |
-
- setDisabled( Boolean disabled ) : void
-
- Convenience function for setting disabled/enabled by boolean.
-
- Convenience function for setting disabled/enabled by boolean.
-
- Parameters:
-
-
|
- Component | -
- |
-
- setHeight( Number height ) : Ext.BoxComponent
- |
- BoxComponent | -
- |
-
- setPagePosition( Number x , Number y ) : Ext.BoxComponent
-
- Sets 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.BoxComponent
-
- Sets 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 ) : Mixed
-
- Sets 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( Number/Object width , Number height ) : Ext.BoxComponent
-
- Sets the width and height of the component. This method fires the resize event. This method can accept
-either width...
-
- Sets the width and height of the component. This method fires the resize event. This method can accept
-either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.
-
- Parameters:
-
-
|
- BoxComponent | -
- |
-
- setValue( Mixed value ) : void
-
- Sets 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.Component
-
- Convenience 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.BoxComponent
- |
- BoxComponent | -
- |
-
- show() : Ext.Component
-
- Show this component.
-
- Show this component.
-
- Parameters:
-
-
|
- Component | -
- |
-
- suspendEvents() : void
-
- Suspend 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 ] ) : void
-
- Removes a listener (shorthand for removeListener)
-
- Removes a listener (shorthand for removeListener)
-
- Parameters:
-
-
|
- Observable | -
- |
-
- updateBox( Object box ) : Ext.BoxComponent
-
- Sets 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 ) : Boolean
-
- Validates 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 | -|
---|---|---|
- |
-
- 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 ...
-
- 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 )
-
- Fires before the component is destroyed. Return false to stop the destroy.
-
- Fires before the component is destroyed. Return false to stop the destroy.
-
- Listeners will be called with the following arguments:
-
-
|
- Component | -
- |
-
- beforehide : ( Ext.Component this )
-
- Fires before the component is hidden. Return false to stop the hide.
-
- Fires before the component is hidden. Return false to stop the hide.
-
- Listeners will be called with the following arguments:
-
-
|
- Component | -
- |
-
- beforerender : ( Ext.Component this )
-
- Fires before the component is rendered. Return false to stop the render.
-
- Fires before the component is rendered. Return false to stop the render.
-
- Listeners will be called with the following arguments:
-
-
|
- Component | -
- |
-
- beforeshow : ( Ext.Component this )
-
- Fires before the component is shown. Return false to stop the show.
-
- Fires before the component is shown. Return false 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 to stop the restore.
-
- Fires before the state of the component is restored. Return false 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.
-
- 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 is rendered.
-
- Fires after the component 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.
-
- Fires after the component is shown.
-
- 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. You can check
-Ext.EventObject.g...
-
- Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check
-Ext.EventObject.getKey to determine which key was pressed.
-
- 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 | -