|
| allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component |
| anchor : StringNote: this config is only used when this Component is rendered
by a Container which has been configured to use an Anc... Note: this config is only used when this Component is rendered
by a Container which has been configured to use an AnchorLayout (or subclass thereof).
based layout manager, for example:
@@ -25,7 +25,7 @@ element's parent node will automatically be used as the component's container.
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 : BooleanTrue 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 |
| boxLabel : String The text that appears beside the checkbox | Checkbox |
| boxMaxHeight : NumberThe maximum value in pixels which this BoxComponent will set its height to.
+them on render (defaults to false). | Component |
| boxLabel : String The text that appears beside the checkbox | Checkbox |
| boxLabel : String The text that appears beside the checkbox | Checkbox |
| boxMaxHeight : NumberThe 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 : NumberThe 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.
@@ -33,7 +33,10 @@ Warning: This will override any size manag... The maxi
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 : NumberThe 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 |
| checked : Boolean true if the checkbox should render initially checked (defaults to false) | Checkbox |
| clearCls : StringThe CSS class used to to apply to the special clearing div rendered
+ Warning: This will override any size management applied by layout managers. | BoxComponent |
| bubbleEvents : ArrayAn array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.... | Component |
| checked : Boolean true if the checkbox should render initially checked (defaults to false) | Checkbox |
| clearCls : StringThe 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').
@@ -90,8 +93,8 @@ by a Container which has been configured to use a BoxComponent |
| focusClass : String The CSS class to use when the checkbox receives focus (defaults to undefined) | Checkbox |
| handler : FunctionA function called when the checked value changes (can be used instead of
-handling the check event). The handler is p... A function called when the checked value changes (can be used instead of
+either a flex = 0 or flex = undefined will not be 'flexed' (the initial size will not be changed). | BoxComponent |
| focusClass : String The CSS class to use when the checkbox receives focus (defaults to undefined) | Checkbox |
| handler : FunctionA function called when the checked value changes (can be used instead of
+handling the check event). The handler is pa... A function called when the checked value changes (can be used instead of
handling the check event). The handler is passed the following parameters:
Defaults to: {top:0, right:0, bottom:0, left:0}
| BoxComponent |
| msgFx : String Experimental The effect used when displaying a validation message under the field
-(defaults to 'normal'). | Field |
| msgTarget<p>The : Stringlocation where the message text set through markInvalid should display.
+(defaults to 'normal'). | Field |
| msgTarget : StringThe location where the message text set through markInvalid should display.
Must be one of the following values:
-<div cla... location where the message text set through markInvalid should display.
+<div... The 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.
@@ -333,7 +336,7 @@ Must be one of the following values:
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 : StringThe field's HTML name attribute (defaults to '').
+ | Field |
| name : StringThe 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 : StringAn optional extra CSS class that will be added to this component's Element when the mouse moves
@@ -610,38 +613,38 @@ should usually not need to be called directly. Enable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. | 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
-this.getBubbleTarget() if present. There is no implementation in the Observable base class.
- This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
-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: Ext.override(Ext.form.Field, {
- // Add functionality to Field's initComponent to enable the change event to bubble
- initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
- this.enableBubble('change');
- }),
-
- // We know that we want Field's events to bubble directly to the FormPanel.
- getBubbleTarget : function() {
- if (!this.formPanel) {
- this.formPanel = this.findParentByType('form');
- }
- return this.formPanel;
- }
-});
-
-var myForm = new Ext.formPanel({
- title: 'User Details',
- items: [{
- ...
- }],
- listeners: {
- change: function() {
- // Title goes red if form has been modified.
- myForm.header.setStyle('color', 'red');
- }
- }
+ 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
+this.getBubbleTarget() if present. There is no implementation in the Observable base class.
+ This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
+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: Ext.override(Ext.form.Field, {
+ // Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
+ this.enableBubble('change');
+ }),
+
+ // We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget : function() {
+ if (!this.formPanel) {
+ this.formPanel = this.findParentByType('form');
+ }
+ return this.formPanel;
+ }
+});
+
+var myForm = new Ext.formPanel({
+ title: 'User Details',
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: function() {
+ // Title goes red if form has been modified.
+ myForm.header.setStyle('color', 'red');
+ }
+ }
});
| Observable |
| findParentBy( Function fn )
:
Ext.ContainerFind a container above this component at any level by a custom function. If the passed function returns
@@ -679,7 +682,12 @@ or use a render listener directly: new Ext.Panel({
},
single: true // Remove the listener after first invocation
}
-});
| Component |
| getHeight()
+}); | Component |
| getErrors()
+ :
+ ArrayRuns this field's validators and returns an array of error messages for any validation failures.
+This is called inter... Runs this field's validators and returns an array of error messages for any validation failures.
+This is called internally during validation and would not usually need to be used manually.
+Each subclass should override or augment the return value to provide their own errors | Field |
| getHeight()
:
NumberGets the current height of the component's underlying element. Gets the current height of the component's underlying element. | BoxComponent |
| getId()
:
@@ -844,14 +852,19 @@ See Ext.fo
If events were suspended using the queueSuspended parameter, then all
event...Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
-events fired during event suspension will be sent to any listeners now. | Observable |
| setAutoScroll( Boolean scroll )
+events fired during event suspension will be sent to any listeners now. | Observable |
| setActiveError( String msg , Boolean suppressEvent )
+ :
+ voidSets the current activeError to the given string. Fires the 'invalid' event.
+This does not set up the error icon, onl... Sets the current activeError to the given string. Fires the 'invalid' event.
+This does not set up the error icon, only sets the message and fires the event. To show the error icon,
+use markInvalid instead, which calls this method internally | Field |
| setAutoScroll( Boolean scroll )
:
Ext.BoxComponentSets the overflow on the content element of the component. Sets the overflow on the content element of the component. | BoxComponent |
| setDisabled( Boolean disabled )
:
- Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. | Component |
| setHeight( Number height )
+ Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. | Component |
| setHeight( Mixed height )
:
- Ext.BoxComponentSets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters:height : NumberThe new height to set. This may be one of:
| BoxComponent |
| setPagePosition( Number x , Number y )
@@ -887,10 +900,10 @@ handler (if configured).Sets the checked state of the ch
handler (if configured). Parameters:checked : Boolean/StringThe following values will check the checkbox:
true, 'true', '1', or 'on' . Any other value will uncheck the checkbox. Returns: | Checkbox |
| setVisible( Boolean visible )
:
- Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. | Component |
| setWidth( Number width )
+ Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. | Component |
| setWidth( Mixed width )
:
- Ext.BoxComponentSets the width of the component. This method fires the resize event. Sets the width of the component. This method fires the resize event. Parameters:width : NumberThe new width to setThis may be one of:
| BoxComponent |
| show()
:
@@ -904,7 +917,11 @@ 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. | BoxComponent |
| un( String eventName , Function handler , [Object scope ] )
:
- voidRemoves an event handler (shorthand for removeListener.) | Observable |
| update( Mixed htmlOrData , [Boolean loadScripts ], [Function callback ] )
+ voidRemoves an event handler (shorthand for removeListener.) | Observable |
| unsetActiveError( Boolean suppressEvent )
+ :
+ voidClears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not
+usually n... Clears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not
+usually need to be called manually | Field |
| update( Mixed htmlOrData , [Boolean loadScripts ], [Function callback ] )
:
voidUpdate the content area of a component. Update the content area of a component. Parameters:htmlOrData : MixedIf this component has been configured with a template via the tpl config
then it will use this argument as data to populate the template.
@@ -913,7 +930,13 @@ content area will be updated via Ext.Element update loadScri
:
Ext.BoxComponentSets the current box measurements of the component's underlying element. Sets the current box measurements of the component's underlying element.
| BoxComponent |
| validate()
:
- BooleanValidates the field value Validates the field value | Field |