X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..ddde20c4d4ac6a8d53de079761155de813845b3c:/docs/output/Ext.tree.TreeEditor.html diff --git a/docs/output/Ext.tree.TreeEditor.html b/docs/output/Ext.tree.TreeEditor.html index 8e948a7b..1fb85829 100644 --- a/docs/output/Ext.tree.TreeEditor.html +++ b/docs/output/Ext.tree.TreeEditor.html @@ -1,13 +1,6 @@ -
Observable Component Editor TreeEditor
Package: | Ext.tree |
Defined In: | TreeEditor.js |
Class: | TreeEditor |
Extends: | Editor |
Observable Component Editor TreeEditor
Package: | Ext.tree |
Defined In: | TreeEditor.js |
Class: | TreeEditor |
Extends: | Editor |
Config Options | Defined By | |
---|---|---|
alignment : String The position to align to (see Ext.Element.alignTo for more details, defaults to "l-l"). | TreeEditor | |
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 true. | 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.
| 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 element being edited, "width" to adopt the width only,
-or ... True for the editor to automatically adopt the size of the element being edited, "width" to adopt the width only,
-or "height" to adopt the height only (defaults to false) | Editor | |
cancelOnEsc : Boolean True to cancel the edit when the escape key is pressed (defaults to false) | Editor | |
clearCls : String The CSS class used to to apply to the special clearing div rendered
+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 | |
bubbleEvents : Array An array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.... An array of events that, when fired, should be bubbled to any parent container. +See Ext.util.Observable.enableBubble. +Defaults to []. | Component | |
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'). @@ -62,7 +58,21 @@ directly after each form field wrapper to provide field clearing (defaults to which has been configured to use the FormLayout layout manager (e.g. Ext.form.FormPanel or specifying layout:'form') and either a fieldLabel is specified or isFormField=true is specified.- See Ext.layout.FormLayout.fieldTpl also. | Component | |
cls : String CSS class to apply to the editor (defaults to "x-small-editor x-tree-editor") | TreeEditor | |
completeOnEnter : Boolean True to complete the edit when the enter key is pressed (defaults to false) | Editor | |
constrain : Boolean True to constrain the editor to the viewport | Editor | |
ctCls : String An optional extra CSS class that will be added to this component's container. This can be useful for
+ See Ext.layout.FormLayout.fieldTpl also. | Component | |
cls : String CSS class to apply to the editor (defaults to "x-small-editor x-tree-editor") | TreeEditor | |
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
| 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. @@ -73,7 +83,8 @@ which assigns a value by default:
- | 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 | |
editDelay : Number The number of milliseconds between clicks to register a double-click that will trigger
+ | 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 | |
editDelay : Number The number of milliseconds between clicks to register a double-click that will trigger
editing on the current node (d... The number of milliseconds between clicks to register a double-click that will trigger
editing on the current node (defaults to 350). If two clicks occur on the same node within this time span,
the editor for the node will display, otherwise it will be processed as a regular click. | TreeEditor | |
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 '').
@@ -115,7 +126,11 @@ since items are automatically laid out when they are first shown (no sizing
is done while hidden). | Component | |
hideParent : Boolean True to hide and show the component's container when hide/show is called on the component, false to hide
and show the... True to hide and show the component's container when hide/show is called on the component, false to hide
and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide
-button on a window by setting hide:true on the button when adding it to its parent container. | Component | |
id : String The unique id of this component (defaults to an auto-assigned id).
+button on a window by setting hide:true on the button when adding it to its parent container. | Component | |
html : String/Object An HTML fragment, or a DomHelper specification to use as the layout element
+content (defaults to ''). The HTML conten... An HTML fragment, or a DomHelper specification to use as the layout element
+content (defaults to ''). The HTML content is added after the component is rendered,
+so the document will not contain this HTML at the time the render event is fired.
+This content is inserted into the body before any configured contentEl is appended. | Component | |
id : String The unique id of this component (defaults to an auto-assigned id).
You should assign an id if you need to be able to ... The unique id of this component (defaults to an auto-assigned id). You should assign an id if you need to be able to access the component later and you do not have an object reference available (e.g., using Ext.getCmp). @@ -128,8 +143,11 @@ sub-elements using this component's id as the parent.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 An additional CSS class to apply to the div wrapping the form item
-element of this field. If supplied, itemCls at th... An additional CSS class to apply to the div wrapping the form item +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'). + An additional CSS class to apply to the div wrapping the form item element of this field. If supplied, itemCls at the field level will override the default itemCls supplied at the container level. The value specified for itemCls will be added to the default class ('x-form-item'). @@ -138,22 +156,22 @@ the default itemCls supplied at the container level. The value s you to write standard CSS rules that can apply to the field, the label (if specified), or any other element within the markup for the field.Note: see the note for fieldLabel. -Example use:
| 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 | Observable | |
maxWidth : Number The maximum width in pixels of the editor field (defaults to 250). Note that if the maxWidth would exceed
the contai... The maximum width in pixels of the editor field (defaults to 250). Note that if the maxWidth would exceed
the containing tree element's size, it will be automatically limited for you to the container width, taking
-scroll and client offsets into account prior to each edit. | TreeEditor | |
overCls : String An optional extra CSS class that will be added to this component's Element when the mouse moves
+scroll and client offsets into account prior to each edit. | TreeEditor | |
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
@@ -302,9 +320,9 @@ 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 specifying into which
-ancestor Container to place a named r... A path specification, relative to the Component's ownerCt specifying into which -ancestor Container to place a named reference to this Component. +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. For example, to put a reference to a Toolbar Button into the Panel which owns the Toolbar:
-In the code above, if the ref had been | Component | |
renderTo : Mixed Specify the id of the element, a DOM element or an existing Element that this component
+ In the code above, if the | 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.
A custom style specification to be appl
}
})
]
-}); | Component | |
swallowKeys : Boolean Handle the keydown/keypress events so they don't propagate (defaults to true) | Editor | |
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
+}); | 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'
+(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
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
@@ -438,16 +466,20 @@ config for a suggestion, or use a render listener directly:
-See also getEl | Component | |
hidden : Boolean True if this component is hidden. Read-only. | Component | |
initialConfig : Object This Component's initial configuration specification. Read-only. | Component | |
ownerCt : Ext.Container The component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a... The component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a container). Read-only.
- Note: to access items within the container see itemId. | Component | |
rendered : Boolean True if this component has been rendered. Read-only. | Component |
Method | Defined By | |
---|---|---|
TreeEditor( TreePanel tree , [Object fieldConfig ], [Object config ] )
+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
+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 | |
---|---|---|
TreeEditor( TreePanel tree , [Object fieldConfig ], [Object config ] )
Parameters:
| TreeEditor | |
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 object )
+ 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. )
:
- voidUsed to define events on this Observable Used to define events on this Observable Parameters:
| Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
+ 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 ] )
:
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 )
@@ -520,9 +552,41 @@ should usually not need to be called directly.Disable this component and fire the 'disable' event. Disable this component and fire the 'disable' event. Parameters:
| Component | |
enable()
:
- Ext.Component Enable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. Parameters:
| Component | |
enableBubble( Object events )
- :
- voidUsed to enable bubbling of events Used to enable bubbling of events Parameters:
| Observable | |
findParentBy( Function fn )
+ Ext.ComponentEnable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. Parameters:
| Component | |
enableBubble( String/Array events )
+ :
+ voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present.... Enables events fired by this Observable to bubble up an owner hierarchy by calling
+ 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:
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
@@ -605,7 +669,26 @@ 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 instance Parameters:
| Component | |
nextSibling()
+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:
+or:
Parameters:
| Component | |
mun( Observable|Element item , Object|String ename , Function fn , Object scope )
+ :
+ voidRemoves listeners that were added by the mon method. Removes listeners that were added by the mon method. Parameters:
| Component | |
nextSibling()
:
Ext.Component Returns the next component in the owning container Returns the next component in the owning container Parameters:
| Component | |
on( String eventName , Function handler , [Object scope ], [Object options ] )
:
@@ -614,9 +697,9 @@ the default), or true to check whether this Component is directly of the specifi
:
Ext.ComponentReturns 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()
+ 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 )
+ 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 )
:
@@ -675,7 +758,14 @@ after the Edit the text of the passed TreeNode. | TreeEditor | |
un( String eventName , Function handler , [Object scope ] )
:
- voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable |
Event | Defined By | |
---|---|---|
afterrender :
+ void Removes 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.
The afterrender event is fired after this Component has been rendere... Fires after the component rendering is finished. @@ -729,7 +819,9 @@ has a null implementation. | 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 | |
render :
+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 )
|