|
| 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:
@@ -122,8 +128,11 @@ 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 |
| chartStyle : ObjectSets styles for this chart. This contains default styling, so modifying this property will override
-the built in sty... Sets styles for this chart. This contains default styling, so modifying this property will override
+ 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 |
| chartStyle : ObjectSets styles for this chart. This contains default styling, so modifying this property will override
+the built in styl... Sets styles for this chart. This contains default styling, so modifying this property will override
the built in styles of the chart. Use extraStyle to add customizations to the default styling. | Chart |
| 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
@@ -162,67 +171,67 @@ for BoxLayout (Hbox and Vbox): ctCls: 'x-box-layout-ct custom-clas
| Component |
| data : MixedThe initial set of data to apply to the tpl to
update the content area of the Component. | Component |
| disableCaching : Boolean True to add a "cache buster" to the end of the chart url. Defaults to true for Opera and IE. | Chart |
| 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 |
| expressInstall : BooleanTrue to prompt the user to install flash if not installed. Note that this uses
Ext.FlashComponent.EXPRESS_INSTALL_URL... True to prompt the user to install flash if not installed. Note that this uses
-Ext.FlashComponent.EXPRESS_INSTALL_URL, which should be set to the local resource. Defaults to false. | FlashComponent |
| extraStyle : ObjectContains extra styles that will be added or overwritten to the default chartStyle. Defaults to null.
-For a detailed ... Contains extra styles that will be added or overwritten to the default chartStyle. Defaults to null.
-For a detailed list of the options available, visit the YUI Charts site
-at http://developer.yahoo.com/yui/charts/#basicstyles
-Some of the options availabe:
-
-- padding - The space around the edge of the chart's contents. Padding does not increase the size of the chart.
-- animationEnabled - A Boolean value that specifies whether marker animations are enabled or not. Enabled by default.
-- font - An Object defining the font style to be used in the chart. Defaults to { name: 'Tahoma', color: 0x444444, size: 11 }
-
-- name - font name
-- color - font color (hex code, ie: "#ff0000", "ff0000" or 0xff0000)
-- size - font size in points (numeric portion only, ie: 11)
-- bold - boolean
-- italic - boolean
-- underline - boolean
-
-
-- border - An object defining the border style around the chart. The chart itself will decrease in dimensions to accomodate the border.
-
-- color - border color (hex code, ie: "#ff0000", "ff0000" or 0xff0000)
-- size - border size in pixels (numeric portion only, ie: 1)
-
-
-- background - An object defining the background style of the chart.
-
-- color - border color (hex code, ie: "#ff0000", "ff0000" or 0xff0000)
-- image - an image URL. May be relative to the current document or absolute.
-
-
-- legend - An object defining the legend style
-
-- display - location of the legend. Possible values are "none", "left", "right", "top", and "bottom".
-- spacing - an image URL. May be relative to the current document or absolute.
-- padding, border, background, font - same options as described above.
-
-- dataTip - An object defining the style of the data tip (tooltip).
-
-- padding, border, background, font - same options as described above.
-
-- xAxis and yAxis - An object defining the style of the style of either axis.
-
-- color - same option as described above.
-- size - same option as described above.
-- showLabels - boolean
-- labelRotation - a value in degrees from -90 through 90. Default is zero.
-
-- majorGridLines and minorGridLines - An object defining the style of the style of the grid lines.
-
-- color, size - same options as described above.
-
-- zeroGridLine - An object defining the style of the style of the zero grid line.
-
-- color, size - same options as described above.
-
-- majorTicks and minorTicks - An object defining the style of the style of ticks in the chart.
-
-- color, size - same options as described above.
-- length - the length of each tick in pixels extending from the axis.
-- display - how the ticks are drawn. Possible values are "none", "inside", "outside", and "cross".
-
+Ext.FlashComponent.EXPRESS_INSTALL_URL, which should be set to the local resource. Defaults to false. | FlashComponent |
| extraStyle : ObjectContains extra styles that will be added or overwritten to the default chartStyle. Defaults to null.
+For a detailed l... Contains extra styles that will be added or overwritten to the default chartStyle. Defaults to null.
+For a detailed list of the options available, visit the YUI Charts site
+at http://developer.yahoo.com/yui/charts/#basicstyles
+Some of the options availabe:
+
+- padding - The space around the edge of the chart's contents. Padding does not increase the size of the chart.
+- animationEnabled - A Boolean value that specifies whether marker animations are enabled or not. Enabled by default.
+- font - An Object defining the font style to be used in the chart. Defaults to { name: 'Tahoma', color: 0x444444, size: 11 }
+
+- name - font name
+- color - font color (hex code, ie: "#ff0000", "ff0000" or 0xff0000)
+- size - font size in points (numeric portion only, ie: 11)
+- bold - boolean
+- italic - boolean
+- underline - boolean
+
+
+- border - An object defining the border style around the chart. The chart itself will decrease in dimensions to accomodate the border.
+
+- color - border color (hex code, ie: "#ff0000", "ff0000" or 0xff0000)
+- size - border size in pixels (numeric portion only, ie: 1)
+
+
+- background - An object defining the background style of the chart.
+
+- color - border color (hex code, ie: "#ff0000", "ff0000" or 0xff0000)
+- image - an image URL. May be relative to the current document or absolute.
+
+
+- legend - An object defining the legend style
+
+- display - location of the legend. Possible values are "none", "left", "right", "top", and "bottom".
+- spacing - an image URL. May be relative to the current document or absolute.
+- padding, border, background, font - same options as described above.
+
+- dataTip - An object defining the style of the data tip (tooltip).
+
+- padding, border, background, font - same options as described above.
+
+- xAxis and yAxis - An object defining the style of the style of either axis.
+
+- color - same option as described above.
+- size - same option as described above.
+- showLabels - boolean
+- labelRotation - a value in degrees from -90 through 90. Default is zero.
+
+- majorGridLines and minorGridLines - An object defining the style of the style of the grid lines.
+
+- color, size - same options as described above.
+
+- zeroGridLine - An object defining the style of the style of the zero grid line.
+
+- color, size - same options as described above.
+
+- majorTicks and minorTicks - An object defining the style of the style of ticks in the chart.
+
+- color, size - same options as described above.
+- length - the length of each tick in pixels extending from the axis.
+- display - how the ticks are drawn. Possible values are "none", "inside", "outside", and "cross".
+
| Chart |
| fieldLabel : StringThe label text to display next to this Component (defaults to '').
Note: this config is only used when this Component... The label text to display next to this Component (defaults to '').
Note: this config is only used when this Component is rendered by a Container which
@@ -239,7 +248,7 @@ Example use: new Ext.FormPanel({
}]
});
| Component |
| flashParams : ObjectA set of key value pairs to be passed to the flash object as parameters. Possible parameters can be found here:
http:... A set of key value pairs to be passed to the flash object as parameters. Possible parameters can be found here:
-http://kb2.adobe.com/cps/127/tn_12701.html Defaults to undefined. | FlashComponent |
| flashVars : Object A set of key value pairs to be passed to the flash object as flash variables. Defaults to undefined. | FlashComponent |
| flashVersion : String Indicates the version the flash content was published for. Defaults to '9.0.45'. | FlashComponent |
| flex : NumberNote: this config is only used when this Component is rendered
+http://kb2.adobe.com/cps/127/tn_12701.html Defaults to undefined. | FlashComponent |
| flashVars : Object A set of key value pairs to be passed to the flash object as flash variables. Defaults to undefined. | FlashComponent |
| flashVersion : String Indicates the version the flash content was published for. Defaults to '9.0.115'. | FlashComponent |
| flex : NumberNote: this config is only used when this Component is rendered
by a Container which has been configured to use a BoxL... | Component |
| url : StringThe url to load the chart from. This defaults to Ext.chart.Chart.CHART_URL, which should
-be modified to point to the... The url to load the chart from. This defaults to Ext.chart.Chart.CHART_URL, which should
+(see Ext.XTemplate.overwrite ). | Component |
| url : StringThe url to load the chart from. This defaults to Ext.chart.Chart.CHART_URL, which should
+be modified to point to the ... The url to load the chart from. This defaults to Ext.chart.Chart.CHART_URL, which should
be modified to point to the local charts resource. | Chart |
| width : NumberThe width of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset se... The width of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent |
| wmode : String The wmode of the flash object. This can be used to control layering. Defaults to 'opaque'. | FlashComponent |
| x : Number The local x (left) coordinate for this component if contained within a positioning container. | BoxComponent |
| xtype : StringThe registered xtype to create. This config option is not used when passing
@@ -703,7 +712,12 @@ Or a shorthand syntax:
:
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. | Component |
| bindStore( Store store )
:
- voidChanges the data store bound to this chart and refreshes it. Changes the data store bound to this chart and refreshes it. | Chart |
| cloneConfig( Object overrides )
+ voidChanges the data store bound to this chart and refreshes it. Changes the data store bound to this chart and refreshes it. | Chart |
| bubble( Function fn , [Object scope ], [Array args ] )
+ :
+ Ext.ComponentBubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of... Bubbles up the component/container heirarchy, calling the specified function with each component. The scope ( this) of
+function call will be the scope provided or the current component. The arguments to the function
+will be the args provided or the current component. If the function returns false at any point,
+the bubble is stopped. | Component |
| cloneConfig( Object overrides )
:
Ext.ComponentClone the current component using the original config values passed into this instance by default. Clone the current component using the original config values passed into this instance by default. | Component |
| destroy()
@@ -718,45 +732,47 @@ 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
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. | Component |
| findParentByType( String/Class xtype )
+true, the container will be returned. | Component |
| findParentByType( String/Ext.Component/Class xtype , [Boolean shallow ] )
:
- Ext.ContainerFind a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class | Component |
| fireEvent( String eventName , Object... args )
+ Ext.ContainerFind a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class Parameters:xtype : String/Ext.Component/ClassThe xtype to check for this Component. Note that the the component can either be an instance
+or a component class: shallow : Boolean(optional) False to check whether this Component is descended from the xtype (this is
+the default), or true to check whether this Component is directly of the specified xtype. Returns: | Component |
| fireEvent( String eventName , Object... args )
:
BooleanFires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name).
@@ -840,7 +856,7 @@ false to cancel hiding the component. Fires the 'h... Hi
event after hiding the component. Note this method is called internally if
the component is configured to be hidden . | Component |
| isVisible()
:
- BooleanReturns true if this component is visible. Returns true if this component is visible. | Component |
| isXType( String xtype , [Boolean shallow ] )
+ BooleanReturns true if this component is visible. Returns true if this component is visible. | Component |
| isXType( String/Ext.Component/Class xtype , [Boolean shallow ] )
:
BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
from th... Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
@@ -852,7 +868,11 @@ to participate in determination of inherited xtypes.
var t = new Ext.form.TextField();
var isText = t.isXType('textfield'); // true
var isBoxSubclass = t.isXType('box'); // true, descended from BoxComponent
-var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance
| Component |
| 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
@@ -921,10 +941,10 @@ events fired during event suspension will be sent to any listeners now. Sets 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 )
@@ -957,10 +977,10 @@ This may be one of: | Chart |
| 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()
:
@@ -997,8 +1017,8 @@ has been restored.Fires before the component is hidden by calling the hide method.
Return false from an event handler to stop the hide.Listeners will be called with the following arguments: | Component |
| beforerefresh :
( Chart this )
- Fires before a refresh to the chart data is called. If the beforerefresh handler returns
-false the refresh action w... Fires before a refresh to the chart data is called. If the beforerefresh handler returns
+ Fires before a refresh to the chart data is called. If the beforerefresh handler returns
+false the refresh action wi... Fires before a refresh to the chart data is called. If the beforerefresh handler returns
false the refresh action will be cancelled. Listeners will be called with the following arguments: | Chart |
| beforerender :
( Ext.Component this )
Fires before the component is rendered. Return false from an
|