X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/25ef3491bd9ae007ff1fc2b0d7943e6eaaccf775..10a866c12701c0a0afd0ac85dcdcf32a421514ac:/docs/output/Ext.form.TextArea.html diff --git a/docs/output/Ext.form.TextArea.html b/docs/output/Ext.form.TextArea.html index b0ce4a4d..a32441a9 100644 --- a/docs/output/Ext.form.TextArea.html +++ b/docs/output/Ext.form.TextArea.html @@ -1,4 +1,4 @@ -
Observable Component BoxComponent Field TextField TextArea
Package: | Ext.form |
Defined In: | TextArea.js |
Class: | TextArea |
Extends: | TextField |
xtype: | textarea |
Observable Component BoxComponent Field TextField TextArea
Package: | Ext.form |
Defined In: | TextArea.js |
Class: | TextArea |
Extends: | TextField |
Config Options | Defined By | |
---|---|---|
allowBlank : Boolean Specify false to validate that the value's length is > 0 (defaults to
true) | TextField | |
allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component | |
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 @@ -86,7 +86,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 @@ -119,7 +121,15 @@ child items when the browser changes its width:
| 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'). @@ -127,7 +137,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
| 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. @@ -138,7 +162,8 @@ which assigns a value by default:
- | 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, @@ -193,7 +218,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). @@ -404,20 +433,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:
+
| 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
@@ -449,9 +476,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 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
+ In the code above, if the | 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
@@ -564,13 +592,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 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)
@@ -621,14 +659,21 @@ 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
+ 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... | Component | |
rendered : Boolean True if this component has been rendered. Read-only. | Component |
Method | Defined By | |||
---|---|---|---|---|
TextArea( Object config )
- Creates a new TextArea Creates a new TextArea Parameters:
| TextArea | |||
addClass( string cls )
+Note: to access items within the Container see itemId. | Component | |||
refOwner : Ext.Container The ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has... The ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has been configured with a ref . | Component | |||
rendered : Boolean True if this component has been rendered. Read-only. | Component | |||
startValue : mixed The value that the Field had at the time it was last focused. This is the value that is passed
+to the change event wh... The value that the Field had at the time it was last focused. This is the value that is passed +to the change event which is fired if the value has been changed when the Field is blurred. +This will be undefined until the Field has been visited. Compare originalValue. | Field |
Method | Defined By | |
---|---|---|
TextArea( Object config )
+ Creates a new TextArea Creates a new TextArea Parameters:
| TextArea | |
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|String o , string Optional. )
:
@@ -706,7 +751,7 @@ should usually not need to be called directly.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 )
+ Ext.ComponentEnable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. Parameters:
| Component | |
enableBubble( String/Array events )
:
voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
this.getBubbleTarget() if present... Enables events fired by this Observable to bubble up an owner hierarchy by calling @@ -715,13 +760,13 @@ this.getBubbleTarget() if present... Enables events fi implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly. Example:
Parameters:
| Observable | |
findParentBy( Function fn )
+});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
@@ -753,7 +798,9 @@ An event may be set to bubble up an Obse... Fires the 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 ] )
+ Ext.ComponentTry to focus this component. Try to focus this component. Parameters:
| Component | |
getActiveError()
+ :
+ String Gets the active error message for this field. Gets the active error message for this field. Parameters:
| Field | |
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()
:
@@ -799,7 +846,7 @@ attribute of the field if available. Paramete
:
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.
+ Ext.Element 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()
+This Element is returned as the resizeEl .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()
:
@@ -868,11 +915,32 @@ to participate in determination of inherited xtypes.
var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance 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.
-Note: this method does not actually make the field
-invalid. Parameters:
| Field | |
nextSibling()
+ void Display an error message associated with this field, using msgTarget to determine how to
+display the message and appl... Display an error message associated with this field, using msgTarget to determine how to +display the message and applying invalidClass to the field's UI element. +Note: this method does not cause the Field's validate method to return Parameters:
| Field | |
mon( Observable|Element item , Object|String ename , Function fn , Object scope , Object opt )
+ :
+ voidAdds listeners to any Observable object (or Elements) which are automatically removed when this Component
+is destroye... Adds listeners to any Observable object (or Elements) which are automatically removed when this Component +is destroyed. Usage:
+or:
Parameters:
| Component | |
mun( Observable|Element item , Object|String ename , Function fn , Object scope )
+ :
+ voidRemoves listeners that were added by the mon method. Removes listeners that were added by the mon method. Parameters:
| Component | |
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 ] )
:
@@ -930,7 +998,9 @@ event...Resume firing events. (see Parameters:
| Observable | |
selectText( [Number start ], [Number end ] )
:
- voidSelects text in this field Selects text in this field Parameters:
| TextField | |
setDisabled( Boolean disabled )
+ voidSelects text in this field Selects text in this field Parameters:
| TextField | |
setAutoScroll( Boolean scroll )
+ :
+ Ext.BoxComponentSets the overflow on the content element of the component. Sets the overflow on the content element of the component. Parameters:
| BoxComponent | |
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 )
:
@@ -948,7 +1018,9 @@ This method fires the 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 )
+ 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 | |
setReadOnly( Boolean readOnly )
+ :
+ voidSets the read only state of this field. Sets the read only state of this field. 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
@@ -983,7 +1055,12 @@ after the 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 )
+ voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | |
update( Mixed htmlOrData , [Boolean loadScripts ], [Function callback ] )
+ :
+ voidUpdate the content area of a component. Update the content area of a component. Parameters:
| Component | |
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()
:
@@ -1043,7 +1120,9 @@ vtype Mask property.
configured regex test will be processed.
The invalid message for this test is configured with
regexText .
-Parameters:
| TextField |
Event | Defined By | |
---|---|---|
afterrender :
+ Parameters:
| TextField |
Event | Defined By | |
---|---|---|
added :
+ ( Ext.Component this , Ext.Container ownerCt , number index )
+ Fires when a component is added to an Ext.Container Fires when a component is added to an Ext.Container Listeners will be called with the following arguments:
| Component | |
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. @@ -1110,7 +1189,9 @@ is set to true.
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 :
+ Fires after the component is moved. Fires after the component is moved. Listeners will be called with the following arguments:
| BoxComponent | |
removed :
+ ( Ext.Component this , Ext.Container ownerCt )
+ Fires when a component is removed from an Ext.Container Fires when a component is removed from an Ext.Container Listeners will be called with the following arguments:
| Component | |
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 )
|