X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/25ef3491bd9ae007ff1fc2b0d7943e6eaaccf775..6e39d509471fe9b4e2660e0d1631b350d0c66f40:/docs/output/Ext.form.TextField.html diff --git a/docs/output/Ext.form.TextField.html b/docs/output/Ext.form.TextField.html index 5947c1a0..42296253 100644 --- a/docs/output/Ext.form.TextField.html +++ b/docs/output/Ext.form.TextField.html @@ -1,4 +1,4 @@ -
Properties Methods Events Config Options Direct Link 
Observable
  Component
    BoxComponent
      Field
        TextField

Class Ext.form.TextField

Package:Ext.form
Defined In:TextField.js
Class:TextField
Subclasses:NumberField, TextArea, TriggerField, FileUploadField
Extends:Field
xtype:textfield

Basic text field. Can be used as a direct replacement for traditional text inputs, +

Observable
  Component
    BoxComponent
      Field
        TextField

Class Ext.form.TextField

Package:Ext.form
Defined In:TextField.js
Class:TextField
Subclasses:NumberField, TextArea, TriggerField
Extends:Field

Basic text field. Can be used as a direct replacement for traditional text inputs, or as the base class for more sophisticated input controls (like Ext.form.TextArea and Ext.form.ComboBox).

Validation

@@ -102,7 +102,9 @@ result in elements needing to be synchronized with the new height. Example:

< } } } -}).show();
BoxComponent autoShow : Boolean
True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove +}).show();
BoxComponent autoScroll : Boolean
true to use overflow:'auto' on the components layout element and show scroll bars automatically when +necessary, false...
true to use overflow:'auto' on the components layout element and show scroll bars automatically when +necessary, false to clip any overflowing content (defaults to false).
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 @@ -135,7 +137,15 @@ child items when the browser changes its width:

var myPanel = <
         title: 'Box 3'
     }],
 });
BoxComponent 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 +fails (defaults to 'This field is required')
TextField boxMaxHeight : Number
The maximum value in pixels which this BoxComponent will set its height to. +Warning: This will override any size mana...

The maximum value in pixels which this BoxComponent will set its height to.

+

Warning: This will override any size management applied by layout managers.

BoxComponent boxMaxWidth : Number
The maximum value in pixels which this BoxComponent will set its width to. +Warning: This will override any size manag...

The maximum value in pixels which this BoxComponent will set its width to.

+

Warning: This will override any size management applied by layout managers.

BoxComponent boxMinHeight : Number
The minimum value in pixels which this BoxComponent will set its height to. +Warning: This will override any size mana...

The minimum value in pixels which this BoxComponent will set its height to.

+

Warning: This will override any size management applied by layout managers.

BoxComponent boxMinWidth : Number
The minimum value in pixels which this BoxComponent will set its width to. +Warning: This will override any size manag...

The minimum value in pixels which this BoxComponent will set its width to.

+

Warning: This will override any size management applied by layout managers.

BoxComponent 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').

@@ -143,7 +153,21 @@ directly after each form field wrapper to provide field clearing (defaults to 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 +

See Ext.layout.FormLayout.fieldTpl also.

Component cls : String
A custom CSS class to apply to the field's underlying element (defaults to '').
Field contentEl : String
Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content +for this comp...

Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content +for this component.

+
    +
  • Description : +
    This config option is used to take an existing HTML element and place it in the layout element +of a new component (it simply moves the specified DOM element after the Component is rendered to use as the content.
    • +
  • Notes : +
    The specified HTML element is appended to the layout element of the component after any configured +HTML has been inserted, and so the document will not contain this element at the time the render event is fired.
    +
    The specified HTML element used will not participate in any layout +scheme that the Component may use. It is just HTML. Layouts operate on child items.
    +
    Add either the x-hidden or the x-hide-display CSS class to +prevent a brief flicker of the content before it is rendered to the panel.
    • +
Component 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.

@@ -154,7 +178,8 @@ which assigns a value by default:
To configure the above Class with an extra CSS class append to the default. For example, for BoxLayout (Hbox and Vbox):
ctCls: 'x-box-layout-ct custom-class'
-

Component disableKeyFilter : Boolean
Specify true to disable input keystroke filtering (defaults +

Component data : Mixed
The initial set of data to apply to the tpl to +update the content area of the Component.
Component 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, @@ -209,7 +234,11 @@ 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). +button on a window by setting hide:true on the button when adding it to its parent container.
Component html : String/Object
An HTML fragment, or a DomHelper specification to use as the layout element +content (defaults to ''). The HTML conten...
An HTML fragment, or a DomHelper specification to use as the layout element +content (defaults to ''). The HTML content is added after the component is rendered, +so the document will not contain this HTML at the time the render event is fired. +This content is inserted into the body before any configured contentEl is appended.
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).

@@ -420,20 +449,18 @@ validation fails (defaults to 'The maximum length for this field is {maxL...'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 ''). +(defaults to 'normal').
Field msgTarget<p>The : String
location where the message text set through markInvalid should display. +Must be one of the following values: +<div cl...
location where the message text set through markInvalid should display. +Must be one of the following values:

+
    +
  • qtip Display a quick tip containing the message when the user hovers over the field. This is the default. +
    Ext.QuickTips.init must have been called for this setting to work. +
  • title Display the message in a default browser title attribute popup.
    • +
  • under Add a block div beneath the field containing the error message.
    • +
  • side Add an error icon to the right of the field, displaying the message in a popup on hover.
    • +
  • [element id] Add the error message 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 overCls : String
An optional extra CSS class that will be added to this component's Element when the mouse moves @@ -462,9 +489,9 @@ Note: this only sets the element's readOnly DOM attri...
Setting readOnly=true, for example, will not disable triggering a ComboBox or DateField; it gives you the option of forcing the user to choose via the trigger without typing in the text box. To hide the trigger use -hideTrigger.

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.

+hideTrigger.

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:

var myGrid = new Ext.grid.EditorGridPanel({
     title: 'My EditorGridPanel',
@@ -483,9 +510,10 @@ For example, to put a reference to a Toolbar Button into the Panel which owns
         }
     }
 });
-

In the code above, if the ref had been 'saveButton' the reference would -have been placed into the Toolbar. Each '/' in the ref moves up one level from the -Component's ownerCt.

Component regex : RegExp
A JavaScript RegExp object to be tested against the field value during validation +

In the code above, if the ref had been 'saveButton' +the reference would have been placed into the Toolbar. Each '/' in the ref +moves up one level from the Component's ownerCt.

+

Also see the added and removed events.

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 @@ -577,13 +605,23 @@ Ext.Element.ap...
A custom style specification to be appl } }) ] -});
Component tabIndex : Number
The tabIndex for this field. Note this only applies to fields that are rendered, +});
Component submitValue : Boolean
False to clear the name attribute on the field so that it is not submitted during a form post. +Defaults to true.
Field 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 tabTip : String
Note: this config is only used when this BoxComponent is a child item of a TabPanel. A string to be used as innerHTML...

Note: this config is only used when this BoxComponent is a child item of a TabPanel.

A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over the associated tab selector element. Ext.QuickTips.init() -must be called in order for the tips to render.
BoxComponent 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 +must be called in order for the tips to render.
BoxComponent tpl : Mixed
An Ext.Template, Ext.XTemplate +or an array of strings to form an Ext.XTemplate. +Used in conjunction with the data and...
An Ext.Template, Ext.XTemplate +or an array of strings to form an Ext.XTemplate. +Used in conjunction with the data and +tplWriteMode configurations.
Component tplWriteMode : String
The Ext.(X)Template method to use when +updating the content area of the Component. Defaults to 'overwrite' +(see Ext.X...
The Ext.(X)Template method to use when +updating the content area of the Component. Defaults to 'overwrite' +(see Ext.XTemplate.overwrite).
Component 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 (validateValue) @@ -634,14 +672,21 @@ config for a suggestion, or use a render listener directly:

new
         single: true  // Remove the listener after first invocation
     }
 });
-

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 +

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 label : Ext.Element
The label Element associated with this Field. Only available after this Field has been rendered by a +Ext.layout.FormL...

The label Element associated with this Field. Only available after this Field has been rendered by a +Ext.layout.FormLayout layout manager.

Field 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
This Component's owner Container (defaults to undefined, and is set automatically when this Component is added to a C...
This Component's owner Container (defaults to undefined, and is set automatically when this 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

Public Methods

MethodDefined By
 rendered : Boolean
True if this component has been rendered. Read-only.
Component

Public Methods

MethodDefined By

Public Events

EventDefined By

Public Events

EventDefined By