X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6e39d509471fe9b4e2660e0d1631b350d0c66f40..92c2b89db26be16707f4a805d3303ab2531006e1:/docs/output/Ext.Editor.html?ds=inline diff --git a/docs/output/Ext.Editor.html b/docs/output/Ext.Editor.html index 76ad91f1..42951a17 100644 --- a/docs/output/Ext.Editor.html +++ b/docs/output/Ext.Editor.html @@ -1,12 +1,5 @@
Observable Component Editor
Package: | Ext |
Defined In: | Editor.js |
Class: | Editor |
Subclasses: | TreeEditor |
Extends: | Component |
Config Options | Defined By | |
---|---|---|
alignment : String The position to align to (see Ext.Element.alignTo for more details, defaults to "c-c?"). | Editor | |
allowBlur : Boolean True to complete the editing process if in edit mode when the
-field is blurred. Defaults to false. | Editor | |
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 -by a Container which has been configured to use an AnchorLayout -based layout manager, for example:
See Ext.layout.AnchorLayout.anchor also. | Component | |
applyTo : Mixed Specify the id of the element, a DOM element or an existing Element corresponding to a DIV
+field is blurred. Defaults to false. | Editor | |
allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component | |
applyTo : Mixed Specify the id of the element, a DOM element or an existing Element corresponding to a DIV
that is already present in... Specify the id of the element, a DOM element or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component.
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 | |
autoEl : Mixed A tag name or DomHelper spec used to create the Element which will
-encapsulate this Component.
+ | Component | |
autoEl : Mixed A tag name or DomHelper spec used to create the Element which will
+encapsulate this Component.
You do not normally ne... A tag name or DomHelper spec used to create the Element which will encapsulate this Component. You do not normally need to specify this. For the base classes Ext.Component, Ext.BoxComponent, @@ -49,11 +42,11 @@ different DOM elements. Example usage:
| Component | |
autoShow : Boolean True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
+} | Component | |
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 | |
autoSize : Boolean/String True for the editor to automatically adopt the size of the underlying field, "width" to adopt the width only,
+them on render (defaults to false). | Component | |
autoSize : Boolean/String True for the editor to automatically adopt the size of the underlying field, "width" to adopt the width only,
or "hei... True for the editor to automatically adopt the size of the underlying field, "width" to adopt the width only,
-or "height" to adopt the height only, "none" to always use the field dimensions. (defaults to false) | Editor | |
cancelOnEsc : Boolean True to cancel the edit when the escape key is pressed. Defaults to true. | Editor | |
clearCls : String The CSS class used to to apply to the special clearing div rendered
+or "height" to adopt the height only, "none" to always use the field dimensions. (defaults to false) | Editor | |
cancelOnEsc : Boolean True to cancel the edit when the escape key is pressed. Defaults to true. | Editor | |
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'). @@ -61,9 +54,9 @@ 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 An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
+ See Ext.layout.FormLayout.fieldTpl also. | Component | |
cls : String An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
useful for ... 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 | |
completeOnEnter : Boolean True to complete the edit when the enter key is pressed. Defaults to true. | Editor | |
constrain : Boolean True to constrain the editor to the viewport | Editor | |
contentEl : String Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
+useful for adding customized styles to the component or any of its children using standard CSS rules. | Component | |
completeOnEnter : Boolean True to complete the edit when the enter key is pressed. Defaults to true. | Editor | |
constrain : Boolean True to constrain the editor to the viewport | Editor | |
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
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
+ | 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. @@ -89,7 +82,7 @@ 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):
| Component | |
data : Mixed The initial set of data to apply to the tpl to
-update the content area of the Component. | Component | |
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 | |
field : Ext.form.Field The Field object (or descendant) or config object for field | Editor | |
fieldLabel : String The label text to display next to this Component (defaults to '').
+update the content area of the Component. | Component | |
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 | |
field : Ext.form.Field The Field object (or descendant) or config object for field | Editor | |
fieldLabel : String The 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 has been configured to use the FormLayout layout manager (e.g. @@ -104,8 +97,8 @@ Example use:
| Component | |
hidden : Boolean Render this component hidden (default is false). If true, the
-hide method will be called internally. | Component | |
hideEl : Boolean False to keep the bound element visible while the editor is displayed (defaults to true) | Editor | |
hideLabel : Boolean true to completely hide the label element
-(label and separator). Defaults to false.
+hide method will be called internally. | Component | |
hideEl : Boolean False to keep the bound element visible while the editor is displayed (defaults to true) | Editor | |
hideLabel : Boolean true to completely hide the label element
+(label and separator). Defaults to false.
By default, even if you do not sp... true to completely hide the label element (label and separator). Defaults to false. By default, even if you do not specify a fieldLabel the space will still be @@ -119,20 +112,20 @@ Example use:
| Component | |
hideMode : String How this component should be hidden. Supported values are 'visibility'
+}); | 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). Note: the default of 'display' is generally preferred 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
+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 | |
html : String/Object An HTML fragment, or a DomHelper specification to use as the layout element
+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).
+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). @@ -142,10 +135,10 @@ rules to style the specific instance of this component uniquely, and also to sel sub-elements using this component's id as the parent.Note: to avoid complications imposed by a unique id also see
Note: to access the container of an item see | Component | |
ignoreNoChange : Boolean True to skip the edit completion process (no save, no events fired) if the user completes an edit and
+ Note: to access the container of an item see | Component | |
ignoreNoChange : Boolean True to skip the edit completion process (no save, no events fired) if the user completes an edit and
the value has n... True to skip the edit completion process (no save, no events fired) if the user completes an edit and
the value has not changed (defaults to false). Applies only to string values - edits for other data types
-will never be ignored. | Editor | |
itemCls : String Note: this config is only used when this Component is rendered by a Container which
+will never be ignored. | Editor | |
itemCls : String Note: this config is only used when this Component is rendered by a Container which
has been configured to use the Fo... Note: this config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager (e.g. Ext.form.FormPanel or specifying layout:'form'). @@ -174,7 +167,7 @@ Example use:
| Component | |
itemId : String An itemId can be used as an alternative way to get a reference to a component
+}); | Component | |
itemId : String An itemId can be used as an alternative way to get a reference to a component
when no object reference is available. ... An itemId can be used as an alternative way to get a reference to a component
when no object reference is available. Instead of using an Note: to access the container of an item see ownerCt. | Component | |
labelSeparator : String The separator to display after the text of each
-fieldLabel. This property may be configured at various levels.
+ Note: to access the container of an item see ownerCt. | Component | |
labelSeparator : String The separator to display after the text of each
+fieldLabel. This property may be configured at various levels.
The o... The separator to display after the text of each fieldLabel. This property may be configured at various levels. The order of precedence is: @@ -232,7 +225,7 @@ Example use:
| Component | |
labelStyle : String A CSS style specification string to apply directly to this field's
+}); | Component | |
labelStyle : String A CSS style specification string to apply directly to this field's
label. Defaults to the container's labelStyle val... A CSS style specification string to apply directly to this field's label. Defaults to the container's labelStyle value if set (e.g., Ext.layout.FormLayout.labelStyle , or ''). @@ -247,7 +240,7 @@ Example use:
| Component | |
listeners : Object A config object containing one or more event handlers to be added to this
+}); | Component | |
listeners : Object A config object containing one or more event handlers to be added to this
object during initialization. This should ... 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. @@ -302,15 +295,15 @@ Ext.DomObserver = Ext.extend(Object, { typeAhead: true, mode: 'local', triggerAction: 'all' -}); | Observable | |
offsets : Array The offsets to use when aligning (see Ext.Element.alignTo for more details. Defaults to [0, 0]. | Editor | |
overCls : String An optional extra CSS class that will be added to this component's Element when the mouse moves
+}); | Observable | |
offsets : Array The offsets to use when aligning (see Ext.Element.alignTo for more details. Defaults to [0, 0]. | Editor | |
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 | |
plugins : Object/Array An object or array of objects that will provide custom functionality for this component. The only
+useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. | Component | |
plugins : Object/Array An object or array of objects that will provide custom functionality for this component. The only
requirement for a ... 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 | |
ptype : String The registered ptype to create. This config option is not used when passing
+component as needed to provide its functionality. | Component | |
ptype : String The registered ptype to create. This config option is not used when passing
a config object into a constructor. This ... The registered ptype 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 Plugin is being
@@ -319,7 +312,7 @@ object. The ptype will be looked up at render time up to determine
type of Plugin to create. If you create your own Plugins, you may register them using Ext.ComponentMgr.registerPlugin in order to be able to -take advantage of lazy instantiation and rendering. | Component | |
ref : String A path specification, relative to the Component's ownerCt
+take advantage of lazy instantiation and rendering. | Component | |
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. @@ -343,8 +336,8 @@ For example, to put a reference to a Toolbar Button into the Panel which owns In the code above, if the | Component | |
renderTo : Mixed | Component | |
renderTo : Mixed Specify the id of the element, a DOM element or an existing Element that this component
+will be rendered into.
Notes ... Specify the id of the element, a DOM element or an existing Element that this component will be rendered into.
When using this config, a call to render() is not required.
See render also. | Component | |
revertInvalid : Boolean True to automatically revert the field value and cancel the edit when the user completes an edit and the field
+ See render also. | Component | |
revertInvalid : Boolean True to automatically revert the field value and cancel the edit when the user completes an edit and the field
valida... True to automatically revert the field value and cancel the edit when the user completes an edit and the field
validation fails (defaults to true) | Editor | |
shadow : Boolean/String "sides" for sides/bottom only, "frame" for 4-way shadow, and "drop"
-for bottom-right shadow (defaults to "frame") | Editor | |
stateEvents : Array An array of events that, when fired, should trigger this component to
+for bottom-right shadow (defaults to "frame") | Editor | |
stateEvents : Array An array of events that, when fired, should trigger this component to
save its state (defaults to none). stateEvents ... An array of events that, when fired, should trigger this component to
save its state (defaults to none). See | Component | |
stateId : String The unique id for this component to use for state management purposes
+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 | Component | |
stateful : Boolean A flag which causes the Component to attempt to restore the state of
+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 You can perform extra processing on state save and restore by attaching handlers to the beforestaterestore, staterestore, -beforestatesave and statesave events. | Component | |
style : String A custom style specification to be applied to this component's Element. Should be a valid argument to
+beforestatesave and statesave events. | Component | |
style : String A custom style specification to be applied to this component's Element. Should be a valid argument to
Ext.Element.ap... A custom style specification to be applied to this component's Element. Should be a valid argument to
Ext.Element.applyStyles.
A custom style specification to be appl
}
})
]
-}); | Component | |
swallowKeys : Boolean Handle the keydown/keypress events so they don't propagate (defaults to true) | Editor | |
tpl : Mixed An Ext.Template, Ext.XTemplate
-or an array of strings to form an Ext.XTemplate.
+}); | Component | |
swallowKeys : Boolean Handle the keydown/keypress events so they don't propagate (defaults to true) | Editor | |
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'
+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 | |
updateEl : Boolean True to update the innerHTML of the bound element when the update completes (defaults to false) | Editor | |
value : Mixed The data value of the underlying field (defaults to "") | Editor | |
xtype : String The registered xtype to create. This config option is not used when passing
+(see Ext.XTemplate.overwrite ). | Component | |
updateEl : Boolean True to update the innerHTML of the bound element when the update completes (defaults to false) | Editor | |
value : Mixed The data value of the underlying field (defaults to "") | Editor | |
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
@@ -448,7 +441,7 @@ The predefined xtypes are listed Ext.ComponentMgr.registerType in order to be able to
-take advantage of lazy instantiation and rendering. | Component |
Property | Defined By | |
---|---|---|
disabled : Boolean True if this component is disabled. Read-only. | Component | |
el : Ext.Element The Ext.Element which encapsulates this Component. Read-only.
+take advantage of lazy instantiation and rendering. | Component |
Property | Defined By | |
---|---|---|
disabled : Boolean True if this component is disabled. Read-only. | Component | |
el : Ext.Element The Ext.Element which encapsulates this Component. Read-only.
This will usually be a <DIV> element created by the ... The Ext.Element which encapsulates this Component. Read-only. This will usually be a <DIV> element created by the class's onRender method, but
that may be overridden using the
-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 | |
ownerCt : Ext.Container This Component's owner Container (defaults to undefined, and is set automatically when
+ 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 | |
ownerCt : Ext.Container This Component's owner Container (defaults to undefined, and is set automatically when
this Component is added to a C... | Component | |
refOwner : Ext.Container The ancestor Container into which the ref reference was inserted if this Component
+ 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 |
Method | Defined By | |
---|---|---|
Editor( Object config )
- Create a new Editor Create a new Editor Parameters:
| Editor | |
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. )
- :
+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 |
Method | Defined By | |
---|---|---|
Editor( Object config )
+ Create a new Editor Create a new Editor Parameters:
| Editor | |
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. )
+ :
voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. Parameters:
| Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
- :
+Usage: Returns:
| Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
+ :
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:
| Observable | |
applyToMarkup( String/HTMLElement el )
- :
- voidApply 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 | |
cancelEdit( Boolean remainVisible )
- :
- voidCancels the editing process and hides the editor without persisting any changes. The field value will be
+}); Returns:
| Observable | |
applyToMarkup( String/HTMLElement el )
+ :
+ voidApply 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 | |
cancelEdit( Boolean remainVisible )
+ :
+ voidCancels the editing process and hides the editor without persisting any changes. The field value will be
reverted to... Cancels the editing process and hides the editor without persisting any changes. The field value will be
reverted to the original starting value. Parameters:
| Editor | |
cloneConfig( Object overrides )
- :
+cancel (defaults to false)Returns:
| Editor | |
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. Parameters:
| Component | |
completeEdit( Boolean remainVisible )
- :
- voidEnds the editing process, persists the changed value to the underlying field, and hides the editor. Ends the editing process, persists the changed value to the underlying field, and hides the editor. Parameters:
| Editor | |
destroy()
- :
- void Destroys this component by purging any event listeners, removing the component's element from the DOM,
+An id property can be passed on this object, otherwise one will be generated to avoid duplicates. Returns:
| Component | |
completeEdit( Boolean remainVisible )
+ :
+ voidEnds the editing process, persists the changed value to the underlying field, and hides the editor. Ends the editing process, persists the changed value to the underlying field, and hides the editor. Parameters:
| Editor | |
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 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( String/Array events )
- :
- voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+should usually not need to be called directly. Parameters:
| Component | |
disable()
+ :
+ Ext.Component 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( 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 is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default @@ -584,24 +577,24 @@ access the required target more quickly. myForm.header.setStyle('color', 'red'); } } -});Parameters:
| Observable | |
findParentBy( Function fn )
- :
- Ext.ContainerFind a container above this component at any level by a custom function. If the passed function returns
+}); 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
-true, the container will be returned. Parameters:
| Component | |
findParentByType( String/Class xtype )
- :
- 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:
| Component | |
fireEvent( String eventName , Object... args )
- :
- BooleanFires the specified event with the passed parameters (minus the event name).
+true, the container will be returned. Parameters:
| Component | |
findParentByType( String/Class xtype )
+ :
+ 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:
| 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). 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 | |
getBubbleTarget()
- :
- Ext.Container Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Parameters:
| Component | |
getEl()
- :
- Ext.Element Returns the Ext.Element which encapsulates this Component.
+by calling enableBubble. Parameters:
| Observable | |
focus( [Boolean selectText ], [Boolean/Number delay ] )
+ :
+ Ext.ComponentTry to focus this component. Try to focus this component. Parameters:
| Component | |
getBubbleTarget()
+ :
+ Ext.Container Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Parameters:
| Component | |
getEl()
+ :
+ Ext.Element Returns the Ext.Element which encapsulates this Component.
This will usually be a <DIV> element created by the cla... Returns the Ext.Element which encapsulates this Component. This will usually be a <DIV> element created by the class's onRender method, but that may be overridden using the autoEl config. @@ -617,46 +610,46 @@ or use a render listener directly:
Parameters:
| Component | |
getId()
- :
- String Returns the id of this component or automatically generates and
+}); Parameters:
| Component | |
getId()
+ :
+ String Returns the id of this component or automatically generates and
returns an id if an id is not defined yet:'ext-comp-'... Returns the id of this component or automatically generates and
-returns an id if an id is not defined yet:
Parameters:
| Component | |
getItemId()
- :
- String Returns the itemId of this component. If an
-itemId was not assigned through configuration the
+returns an id if an id is not defined yet:
Parameters:
| Component | |
getItemId() + : + String | Component | |
getValue()
- :
- Mixed Gets the data value of the editor Gets the data value of the editor Parameters:
| Editor | |
getXType()
- :
- String Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
+ id is returned using getId .Parameters:
| Component | |
getValue()
+ :
+ Mixed Gets the data value of the editor Gets the data value of the editor Parameters:
| Editor | |
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
+alert(t.getXType()); // alerts 'textfield' 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 )
- :
- BooleanChecks 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. Listen to the 'beforehide' event and return
+alert(t.getXTypes()); // alerts 'component/box/field/textfield' Parameters:
| Component | |
hasListener( String eventName )
+ :
+ BooleanChecks 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. Listen to the 'beforehide' event and return
false to cancel hiding the component. Fires the 'h... Hide this component. Listen to the 'beforehide' event and return
false to cancel hiding the component. Fires the 'hide'
event after hiding the component. Note this method is called internally if
-the component is configured to be hidden .Parameters:
| Component | |
isVisible()
- :
- Boolean Returns true if this component is visible. Returns true if this component is visible. Parameters:
| Component | |
isXType( String xtype , [Boolean shallow ] )
- :
- BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
+the component is configured to be hidden .Parameters:
| Component | |
isVisible()
+ :
+ Boolean Returns true if this component is visible. Returns true if this component is visible. Parameters:
| Component | |
isXType( String 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 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 @@ -667,9 +660,9 @@ to participate in determination of inherited xtypes. 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 instanceParameters:
| 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
+the default), or true to check whether this Component is directly of the specified xtype. Returns:
| 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
is destroye... Adds listeners to any Observable object (or Elements) which are automatically removed when this Component is destroyed. Usage:
Parameters:
| Component | |
mun( Observable|Element item , Object|String ename , Function fn , Object scope )
- :
+is the addListener options.Returns:
| 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 ] )
- :
+is the scope (this reference) in which the handler function is executed.Returns:
| 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 ] )
+ :
voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:
| Observable | |
previousSibling()
- :
- Ext.Component Returns the previous component in the owning container Returns the previous component in the owning container Parameters:
| Component | |
purgeListeners()
- :
- void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
realign( [Boolean autoSize ] )
- :
- voidRealigns the editor to the bound field based on the current alignment config value. Realigns the editor to the bound field based on the current alignment config value. Parameters:
| Editor | |
relayEvents( Object o , Array events )
- :
- voidRelays 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 )
- :
- Ext.ComponentRemoves 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 ] )
- :
- voidRemoves an event handler. Removes an event handler. Parameters:
| Observable | |
render( [Element/HTMLElement/String container ], [String/Number position ] )
- :
- voidRender this Component into the passed HTML element.
+If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
| Observable | |
previousSibling()
+ :
+ Ext.Component Returns the previous component in the owning container Returns the previous component in the owning container Parameters:
| Component | |
purgeListeners()
+ :
+ void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
realign( [Boolean autoSize ] )
+ :
+ voidRealigns the editor to the bound field based on the current alignment config value. Realigns the editor to the bound field based on the current alignment config value. Parameters:
| Editor | |
relayEvents( Object o , Array events )
+ :
+ voidRelays 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 )
+ :
+ Ext.ComponentRemoves 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 ] )
+ :
+ voidRemoves an event handler. Removes an event handler. Parameters:
| Observable | |
render( [Element/HTMLElement/String container ], [String/Number position ] )
+ :
+ voidRender 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. @@ -727,112 +720,112 @@ have in mind. 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 | |
resumeEvents()
- :
- void Resume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
+which this component will be inserted (defaults to appending to the end of the container) Returns:
| Component | |
resumeEvents()
+ :
+ void Resume firing events. (see suspendEvents)
+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. Parameters:
| Observable | |
setDisabled( Boolean disabled )
- :
- Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters:
| Component | |
setSize( Number width , Number height )
- :
- voidSets the height and width of this editor. Sets the height and width of this editor. Parameters:
| Editor | |
setValue( Mixed value )
- :
- voidSets the data value of the editor Sets the data value of the editor Parameters:
| Editor | |
setVisible( Boolean visible )
- :
- Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters:
| Component | |
show()
- :
- Ext.Component Show this component. Listen to the 'beforeshow' event and return
+events fired during event suspension will be sent to any listeners now. Parameters:
| Observable | |
setDisabled( Boolean disabled )
+ :
+ Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters:
| Component | |
setSize( Number width , Number height )
+ :
+ voidSets the height and width of this editor. Sets the height and width of this editor. Parameters:
| Editor | |
setValue( Mixed value )
+ :
+ voidSets the data value of the editor Sets the data value of the editor Parameters:
| Editor | |
setVisible( Boolean visible )
+ :
+ Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters:
| Component | |
show()
+ :
+ Ext.Component Show this component. Listen to the 'beforeshow' event and return
false to cancel showing the component. Fires the '... Show this component. Listen to the 'beforeshow' event and return
false to cancel showing the component. Fires the 'show'
-event after showing the component. Parameters:
| Component | |
startEdit( Mixed el , [String value ] )
- :
+event after showing the component.Parameters:
| Component | |
startEdit( Mixed el , [String value ] )
+ :
voidStarts the editing process and shows the editor. Starts the editing process and shows the editor. Parameters:
| Editor | |
suspendEvents( Boolean queueSuspended )
- :
+to the innerHTML of el.Returns:
| Editor | |
suspendEvents( Boolean queueSuspended )
+ :
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| Observable | |
un( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | |
update( Mixed htmlOrData , [Boolean loadScripts ], [Function callback ] )
- :
+after the resumeEvents call instead of discarding all suspended events;Returns:
| Observable | |
un( String eventName , Function handler , [Object scope ] )
+ :
+ 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 |
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.
+content area will be updated via Ext.Element update loadScripts : Boolean(optional) Only legitimate when using the html configuration. Defaults to false callback : Function(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading
| Component |
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. The afterrender event is fired after this Component has been rendered, been postprocesed by any afterRender method defined for the Component, and, if stateful, after state -has been restored. Listeners will be called with the following arguments:
| Component | |
beforecomplete :
- ( Editor this , Mixed value , Mixed startValue )
- Fires after a change has been made to the field, but before the change is reflected in the underlying
+has been restored. Listeners will be called with the following arguments:
| Component | |
beforecomplete :
+ ( Editor this , Mixed value , Mixed startValue )
+ Fires after a change has been made to the field, but before the change is reflected in the underlying
field. Saving ... Fires after a change has been made to the field, but before the change is reflected in the underlying
field. Saving the change to the field can be canceled by returning false from the handler of this event.
Note that if the value has not changed and ignoreNoChange = true, the editing will still end but this
-event will not fire since no edit actually occurred. Listeners will be called with the following arguments:
| Editor | |
beforedestroy :
- ( Ext.Component this )
- | Component | |
beforehide :
- ( Ext.Component this )
- Fires before the component is hidden by calling the hide method.
+event will not fire since no edit actually occurred. Listeners will be called with the following arguments:
| Editor | |
beforedestroy :
+ ( Ext.Component this )
+ | Component | |
beforehide :
+ ( Ext.Component this )
+ Fires before the component is hidden by calling the hide method.
Return false from an event handler to stop the hide. 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 | |
beforerender :
- ( Ext.Component this )
- Fires before the component is rendered. Return false from an
+Return false from an event handler to stop the hide. Listeners will be called with the following arguments:
| Component | |
beforerender :
+ ( Ext.Component this )
+ | Component | |
beforeshow :
- ( Ext.Component this )
- Fires before the component is shown by calling the show method.
+event handler to stop the render. Listeners will be called with the following arguments:
| Component | |
beforeshow :
+ ( Ext.Component this )
+ Fires before the component is shown by calling the show method.
Return false from an event handler to stop the show. Fires before the component is shown by calling the show method.
-Return false from an event handler to stop the show. Listeners will be called with the following arguments:
| Component | |
beforestartedit :
- ( Editor this , Ext.Element boundEl , Mixed value )
- Fires when editing is initiated, but before the value changes. Editing can be canceled by returning
+Return false from an event handler to stop the show. Listeners will be called with the following arguments:
| Component | |
beforestartedit :
+ ( Editor this , Ext.Element boundEl , Mixed value )
+ Fires when editing is initiated, but before the value changes. Editing can be canceled by returning
false from the h... Fires when editing is initiated, but before the value changes. Editing can be canceled by returning
-false from the handler of this event. Listeners will be called with the following arguments:
| Editor | |
beforestaterestore :
- ( Ext.Component this , Object state )
+false from the handler of this event.Listeners will be called with the following arguments:
| Editor | |
beforestaterestore :
+ ( Ext.Component this , Object state )
Fires before the state of the component is restored. Return false from an event handler to stop the restore. Fires before the state of the component is restored. Return false from an event handler to stop the restore. Listeners will be called with the following arguments:
| Component | |
beforestatesave :
- ( Ext.Component this , Object state )
+provide custom state restoration. | 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 | |
canceledit :
- ( Editor this , Mixed value , Mixed startValue )
- Fires after editing has been canceled and the editor's value has been reset. Fires after editing has been canceled and the editor's value has been reset. Listeners will be called with the following arguments:
| Editor | |
complete :
- ( Editor this , Mixed value , Mixed startValue )
- Fires after editing is complete and any changed value has been written to the underlying field. Fires after editing is complete and any changed value has been written to the underlying field. Listeners will be called with the following arguments:
| Editor | |
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 | |
hide :
- ( Ext.Component this )
- Fires after the component is hidden.
+has a null implementation. | Component | |
canceledit :
+ ( Editor this , Mixed value , Mixed startValue )
+ Fires after editing has been canceled and the editor's value has been reset. Fires after editing has been canceled and the editor's value has been reset. Listeners will be called with the following arguments:
| Editor | |
complete :
+ ( Editor this , Mixed value , Mixed startValue )
+ Fires after editing is complete and any changed value has been written to the underlying field. Fires after editing is complete and any changed value has been written to the underlying field. Listeners will be called with the following arguments:
| Editor | |
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 | |
hide :
+ ( Ext.Component this )
+ Fires after the component is hidden.
Fires after the component is hidden when calling the hide method. Fires after the component is hidden.
-Fires after the component is hidden when calling the hide method. Listeners will be called with the following arguments:
| Component | |
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 | |
show :
- ( Ext.Component this )
- Fires after the component is shown when calling the show method. Fires after the component is shown when calling the show method. 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
+Fires after the component is hidden when calling the hide method. Listeners will be called with the following arguments:
| Component | |
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 | |
show :
+ ( Ext.Component this )
+ Fires after the component is shown when calling the show method. Fires after the component is shown when calling the show method. 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:
| Editor | |
startedit :
- ( Ext.Element boundEl , Mixed value )
- Fires when this editor is displayed Fires when this editor is displayed Listeners will be called with the following arguments:
| Editor | |
staterestore :
- ( Ext.Component this , Object state )
+Ext.EventObject.getKey to determine which key was pressed.Listeners will be called with the following arguments:
| Editor | |
startedit :
+ ( Ext.Element boundEl , Mixed value )
+ Fires when this editor is displayed Fires when this editor is displayed Listeners will be called with the following arguments:
| Editor | |
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 )
+Component. The method maybe overriden to provide custom state restoration. | 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:
|