X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/25ef3491bd9ae007ff1fc2b0d7943e6eaaccf775..10a866c12701c0a0afd0ac85dcdcf32a421514ac:/docs/output/Ext.tree.TreePanel.html?ds=sidebyside diff --git a/docs/output/Ext.tree.TreePanel.html b/docs/output/Ext.tree.TreePanel.html index d60b393e..2aeea38d 100644 --- a/docs/output/Ext.tree.TreePanel.html +++ b/docs/output/Ext.tree.TreePanel.html @@ -1,4 +1,4 @@ -
Properties Methods Events Config Options Direct Link 
Observable
  Component
    BoxComponent
      Container
        Panel
          TreePanel

Class Ext.tree.TreePanel

Package:Ext.tree
Defined In:TreePanel.js
Class:TreePanel
Subclasses:ColumnTree
Extends:Panel
xtype:treepanel

The TreePanel provides tree-structured UI representation of tree-structured data.

+
Observable
  Component
    BoxComponent
      Container
        Panel
          TreePanel

Class Ext.tree.TreePanel

Package:Ext.tree
Defined In:TreePanel.js
Class:TreePanel
Extends:Panel

The TreePanel provides tree-structured UI representation of tree-structured data.

TreeNodes added to the TreePanel may each contain metadata used by your application in their attributes property.

A TreePanel must have a root node before it is rendered. This may either be @@ -87,9 +87,9 @@ Note: Setting autoHeight: true means that t...

true based on its contents, and that Ext will not manage it at all. If the panel is within a layout that manages dimensions (fit, border, etc.) then setting autoHeight: true can cause issues with scrolling and will not generally work as expected since the panel will take -on the height of its contents rather than the height required by the Ext layout.
Panel autoScroll : Boolean
true to use overflow:'auto' on the panel's body element and show scroll bars automatically when -necessary, false to c...
true to use overflow:'auto' on the panel's body element and show scroll bars automatically when -necessary, false to clip any overflowing content (defaults to false).
Panel autoShow : Boolean
True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove +on the height of its contents rather than the height required by the Ext layout.
Panel autoScroll : Boolean
true to use overflow:'auto' on the components layout element and show scroll bars automatically when +necessary, false...
true to use overflow:'auto' on the components layout element and show scroll bars automatically when +necessary, false to clip any overflowing content (defaults to false).
BoxComponent autoShow : Boolean
True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render...
True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render (defaults to false).
Component baseCls : String
The base CSS class to apply to this panel's element (defaults to 'x-panel'). Another option available by default is t...
The base CSS class to apply to this panel's element (defaults to 'x-panel'). @@ -154,8 +154,18 @@ Ext.Element.addClass (defau...
Additional css class selec Ext.Element.applyStyles (defaults to nu...
Custom CSS styles to be applied to the body element in the format expected by Ext.Element.applyStyles (defaults to null). See bodyCfg.
Panel border : Boolean
True to display the borders of the panel's body element, false to hide them (defaults to true). By default, the bord...
True to display the borders of the panel's body element, false to hide them (defaults to true). By default, -the border is a 2px wide inset border, but this can be further altered by setting bodyBorder to false.
Panel bubbleEvents : Array

An array of events that, when fired, should be bubbled to any parent container. -Defaults to ['add', 'remove'].

TreePanel buttonAlign : String
The alignment of any buttons added to this panel. Valid values are 'right', +the border is a 2px wide inset border, but this can be further altered by setting bodyBorder to false.
Panel boxMaxHeight : Number
The maximum value in pixels which this BoxComponent will set its height to. +Warning: This will override any size mana...

The maximum value in pixels which this BoxComponent will set its height to.

+

Warning: This will override any size management applied by layout managers.

BoxComponent boxMaxWidth : Number
The maximum value in pixels which this BoxComponent will set its width to. +Warning: This will override any size manag...

The maximum value in pixels which this BoxComponent will set its width to.

+

Warning: This will override any size management applied by layout managers.

BoxComponent boxMinHeight : Number
The minimum value in pixels which this BoxComponent will set its height to. +Warning: This will override any size mana...

The minimum value in pixels which this BoxComponent will set its height to.

+

Warning: This will override any size management applied by layout managers.

BoxComponent boxMinWidth : Number
The minimum value in pixels which this BoxComponent will set its width to. +Warning: This will override any size manag...

The minimum value in pixels which this BoxComponent will set its width to.

+

Warning: This will override any size management applied by layout managers.

BoxComponent 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 [].

TreePanel buttonAlign : String
The alignment of any buttons added to this panel. Valid values are 'right', 'left' and 'center' (defaults to 'right'...
The alignment of any buttons added to this panel. Valid values are 'right', 'left' and 'center' (defaults to 'right').
Panel buttons : Array
buttons will be used as items for the toolbar in the footer (fbar). Typically the value of this configuration propert...
buttons will be used as items for the toolbar in @@ -194,7 +204,8 @@ 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):
ctCls: 'x-box-layout-ct custom-class'
-

Component ddAppendOnly : Boolean
true if the tree should only allow append drops (use for trees which are sorted)
TreePanel ddGroup : String
The DD group this TreePanel belongs to
TreePanel ddScroll : Boolean
true to enable body scrolling
TreePanel disabled : Boolean
Render this panel disabled (default is false). An important note when using the disabled +

Component data : Mixed
The initial set of data to apply to the tpl to +update the content area of the Component.
Component ddAppendOnly : Boolean
true if the tree should only allow append drops (use for trees which are sorted)
TreePanel ddGroup : String
The DD group this TreePanel belongs to
TreePanel ddScroll : Boolean
true to enable body scrolling
TreePanel disabled : Boolean
Render this panel disabled (default is false). An important note when using the disabled config on panels is that IE ...
Render this panel disabled (default is false). An important note when using the disabled config on panels is that IE will often fail to initialize the disabled mask element correectly if the panel's layout has not yet completed by the time the Panel is disabled during the render process. @@ -313,8 +324,8 @@ will be created automatically if ...
true to will be created automatically if buttons or a fbar have been configured. See bodyCfg for an example.
Panel footerCfg : Object
A DomHelper element specification object specifying the element structure of this Panel's footer Element. See bodyCf...

A DomHelper element specification object specifying the element structure -of this Panel's footer Element. See bodyCfg also.

Panel forceLayout : Boolean
If true the container will force a layout initially even if hidden or collapsed. This option -is useful for forcing f...
If true the container will force a layout initially even if hidden or collapsed. This option +of this Panel's footer Element. See bodyCfg also.

Panel forceLayout : Boolean
If true the container will force a layout initially even if hidden or collapsed. This option +is useful for forcing fo...
If true the container will force a layout initially even if hidden or collapsed. This option is useful for forcing forms to render in collapsed or hidden containers. (defaults to false).
Container frame : Boolean
false by default to render with plain 1px square borders. true to render with 9 elements, complete with custom rounde...
false by default to render with plain 1px square borders. true to render with 9 elements, complete with custom rounded corners (also see Ext.Element.boxWrap). @@ -581,7 +592,10 @@ when it is disabled, but masking the panel can provide an additional visual cue disabled.
Panel minButtonWidth : Number
Minimum width in pixels of all buttons in this panel (defaults to 75)
Panel 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 pageX : Number
The page level x coordinate for this component if contained within a positioning container.
BoxComponent pageY : Number
The page level y coordinate for this component if contained within a positioning container.
BoxComponent pathSeparator : String
The token used to separate sub-paths in path strings (defaults to '/')
TreePanel 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 padding : Number/String
A shortcut for setting a padding style on the body element. The value can either be +a number to be applied to all sid...
A shortcut for setting a padding style on the body element. The value can either be +a number to be applied to all sides, or a normal css string describing padding. +Defaults to undefined.
Panel pageX : Number
The page level x coordinate for this component if contained within a positioning container.
BoxComponent pageY : Number
The page level y coordinate for this component if contained within a positioning container.
BoxComponent pathSeparator : String
The token used to separate sub-paths in path strings (defaults to '/')
TreePanel 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 @@ -595,9 +609,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 ownerCt +specifying into which ancestor Container to place a named reference to this Component.

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:

var myGrid = new Ext.grid.EditorGridPanel({
     title: 'My EditorGridPanel',
@@ -616,9 +630,10 @@ For example, to put a reference to a Toolbar Button into the Panel which owns
         }
     }
 });
-

In the code above, if the ref had been 'saveButton' the reference would -have been placed into the Toolbar. Each '/' in the ref moves up one level from the -Component's ownerCt.

Component region : String
Note: this config is only used when this BoxComponent is rendered +

In the code above, if the ref had been 'saveButton' +the reference would have been placed into the Toolbar. Each '/' in the ref +moves up one level from the Component's ownerCt.

+

Also see the added and removed events.

Component region : String
Note: this config is only used when this BoxComponent is rendered by a Container which has been configured to use the...

Note: this config is only used when this BoxComponent is rendered by a Container which has been configured to use the BorderLayout layout manager (e.g. specifying layout:'border').


@@ -794,7 +809,7 @@ call when clicked. Arguments passed are:
  • event : Ext.EventObject
    The click event.
  • toolEl : Ext.Element
    The tool Element.
  • panel : Ext.Panel
    The host Panel
    • -
  • tc : Ext.Panel
    The tool configuration object
    • +
  • tc : Object
    The tool configuration object
  • stopEvent : Boolean
    Defaults to true. Specify as false to allow click event to propagate.
  • scope : Object
    The scope in which to call the handler.
    • @@ -829,7 +844,16 @@ a 15x15 image:

    .x-tool-help-over {background-image: url(images/help_over.png);} // if using an image sprite: .x-tool-help {background-image: url(images/help.png) no-repeat 0 0;} -.x-tool-help-over {background-position:-15px 0;}
    Panel trackMouseOver : Boolean
    false to disable mouse over highlighting
    TreePanel unstyled : Boolean
    Overrides the baseCls setting to baseCls = 'x-plain' which renders +.x-tool-help-over {background-position:-15px 0;}
    Panel 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 Ext.Template, Ext.XTemplate +or an array of strings to form an Ext.XTemplate. +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 trackMouseOver : Boolean
    false to disable mouse over highlighting
    TreePanel unstyled : Boolean
    Overrides the baseCls setting to baseCls = 'x-plain' which renders the panel unstyled except for required attributes ...
    Overrides the baseCls setting to baseCls = 'x-plain' which renders the panel unstyled except for required attributes for Ext layouts to function (e.g. overflow:hidden).
    Panel useArrows : Boolean
    true to use Vista-style arrows in the tree (defaults to false)
    TreePanel width : Number
    The 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). @@ -887,41 +911,43 @@ Note: see the Note for el al...
    The Panel's header

    Note: see the Note for el also.

    Panel 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...
    This Component's owner Container (defaults to undefined, and is set automatically when this 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 root : Ext.tree.TreeNode
    The root node of this tree.
    TreePanel

    Public Methods

    MethodDefined By
     rendered : Boolean
    True if this component has been rendered. Read-only.
    		Component
     root : Ext.tree.TreeNode
    The root node of this tree.
    		TreePanel

    Public Methods

    MethodDefined By

    Public Events

    EventDefined By