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
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 specified using the root config option, or using the setRootNode method.

Config Options

Config Options Defined By
  allowDomMove : Boolean
Whether the component can move the Dom node when rendering (defaults to true).
Component
  animate : Boolean
true to enable animated expand/collapse (defaults to the value of Ext.enableFx)
TreePanel
  autoHeight : Boolean
True to use height:'auto', false to use fixed height (defaults to false).
BoxComponent
  autoWidth : Boolean
True to use width:'auto', false to use fixed width (defaults to false).
BoxComponent
  baseCls : String
The base CSS class to apply to this panel's element (defaults to 'x-panel').
Panel
  buttonAlign : String
The alignment of any buttons added to this panel. Valid values are 'right,' 'left' and 'center' (defaults to 'right').
Panel
  buttons : Array
An array of Ext.Button configs used to add buttons to the footer of this panel.
Panel
  collapsed : Boolean
True to render the panel collapsed, false to render it expanded (defaults to false).
Panel
  collapsedCls : String
A CSS class to add to the panel's element after it has been collapsed (defaults to 'x-panel-collapsed').
Panel
  containerScroll : Boolean
true to register this container with ScrollManager
TreePanel
  contentEl : String
The id of an existing HTML node to use as the panel's body content (defaults to '').
Panel
  ddAppendOnly : String
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
  defaultType : String
The default type of container represented by this object as registered in Ext.ComponentMgr (defaults to 'panel').
Container
  disabledClass : String
CSS class added to the component when it is disabled (defaults to "x-item-disabled").
Component
  dragConfig : Object
Custom config to pass to the Ext.tree.TreeDragZone instance
TreePanel
  dropConfig : Object
Custom config to pass to the Ext.tree.TreeDropZone instance
TreePanel
  enableDD : Boolean
true to enable drag and drop
TreePanel
  enableDrag : Boolean
true to enable just drag
TreePanel
  enableDrop : Boolean
true to enable just drop
TreePanel
  frame : Boolean
True to render the panel with custom rounded borders, false to render with plain 1px square borders (defaults to false).
Panel
  headerAsText : Boolean
True to display the panel title in the header, false to hide it (defaults to true).
Panel
  height : Number
The height of this component in pixels (defaults to auto).
BoxComponent
  hideCollapseTool : Boolean
True to hide the expand/collapse toggle button when collapsible = true, false to display it (defaults to false).
Panel
  hlColor : String
The color of the node highlight (defaults to C3DAF9)
TreePanel
  hlDrop : Boolean
false to disable node highlight on drop (defaults to the value of Ext.enableFx)
TreePanel
  html : String/Object
An HTML fragment, or a DomHelper specification to use as the panel's body content (defaults to '').
Panel
  iconCls : String
A CSS class that will provide a background image to be used as the panel header icon (defaults to '').
Panel
  id : String
The unique id of this component (defaults to an auto-assigned id).
Component
  lines : Boolean
false to disable tree lines (defaults to true)
TreePanel
  loader : Ext.tree.TreeLoader
A Ext.tree.TreeLoader for use with this TreePanel
TreePanel
  minButtonWidth : Number
Minimum width in pixels of all buttons in this panel (defaults to 75)
Panel
  pathSeparator : String
The token used to separate sub-paths in path strings (defaults to '/')
TreePanel
  root : Ext.tree.TreeNode
The root node for the tree.
TreePanel
  rootVisible : Boolean
false to hide the root node (defaults to true)
TreePanel
  selModel : Boolean
A tree selection model to use with this TreePanel (defaults to a Ext.tree.DefaultSelectionModel)
TreePanel
  singleExpand : Boolean
true if only 1 node per branch may be expanded
TreePanel
  stateId : String
The unique id for this component to use for state management purposes (defaults to the component id).
Component
  width : Number
The width of this component in pixels (defaults to auto).
BoxComponent

Public Properties

Property Defined By
  buttons : Array
This Panel's Array of buttons as created from the buttons config property. Read only.
Panel
  disabled : Boolean
True if this component is disabled. Read-only.
Component
  dragZone : Ext.tree.TreeDragZone
The dragZone used by this tree if drag is enabled
TreePanel
  dropZone : Ext.tree.TreeDropZone
The dropZone used by this tree if drop is enabled
TreePanel
  footer : Ext.Element
The Panel's footer Element. Read-only.

This Element is used to house the Panel's buttons.

Panel
  header : Ext.Element
The Panel's header Element. Read-only.

This Element is used to house the title and tools

Panel
  hidden : Boolean
True if this component is hidden. Read-only.
Component
  initialConfig : Object
This Component's initial configuration specification. Read-only.
Component
  items : MixedCollection
The collection of components in this container as a Ext.util.MixedCollection
Container
  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

Method Defined By

Public Events

Event Defined By