PhpExt : Tree [ class tree ] [ index ] [ all elements ]

Class: PhpExt_Tree_TreePanel

Source Location: /PhpExt/Tree/TreePanel.php

Class PhpExt_Tree_TreePanel

Class Overview

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.

Located in /PhpExt/Tree/TreePanel.php [line 31]

PhpExt_Object
   |
   --PhpExt_Observable
      |
      --PhpExt_Component
         |
         --PhpExt_BoxComponent
            |
            --PhpExt_Container
               |
               --PhpExt_Panel
                  |
                  --PhpExt_Tree_TreePanel

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From PhpExt_Panel

PhpExt_Panel::$BaseCssClass
PhpExt_Panel::$_bottomToolbar
PhpExt_Panel::$_buttons
PhpExt_Panel::$_tools
PhpExt_Panel::$_topToolbar

Inherited From PhpExt_Container

PhpExt_Container::$_defaultLayout
PhpExt_Container::$_items
PhpExt_Container::$_layout

Inherited From PhpExt_Component

PhpExt_Component::$_layoutData
PhpExt_Component::$_ownerCollection
PhpExt_Component::$_plugins
PhpExt_Component::$_xType

Inherited From PhpExt_Observable

PhpExt_Observable::$_listeners

Inherited From PhpExt_Object

PhpExt_Object::$_extClassName
PhpExt_Object::$_extConfigProperties
PhpExt_Object::$_validExtConfigProperties
PhpExt_Object::$_varName

Inherited From PhpExt_Panel

PhpExt_Panel::__construct()
PhpExt_Panel::addButton()
Adds a button to the footer
PhpExt_Panel::addTool()
A PhpExt_ToolConfigObject to add to the tools collection
PhpExt_Panel::getAnimCollapse()
True to animate the transition when the panel is collapsed, false to skip the animation (defaults to true if the Ext.Fx class is available, otherwise false).
PhpExt_Panel::getApplyTo()
The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some panel-specific structural markup. When applyTo is used, constituent parts of the panel can be specified by CSS class name within the main element, and the panel will automatically create those components from that markup. Any required components not specified in the markup will be autogenerated if necessary. The following class names are supported (baseCls will be replaced by BaseCssClass):
PhpExt_Panel::getAutoLoad()
PhpExt_Panel::getAutoScroll()
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).
PhpExt_Panel::getBaseCssClass()
The base CSS class to apply to this panel's element (defaults to 'x-panel').
PhpExt_Panel::getBodyBorder()
True to display an interior border on the body element of the panel, false to hide it (defaults to true). This only applies when border == true. If border == true and bodyBorder == false, the border will display as a 1px wide inset border, giving the entire body element an inset appearance.
PhpExt_Panel::getBodyStyle()
Custom CSS styles to be applied to the body element in the format expected by Ext.Element.applyStyles (defaults to null).
PhpExt_Panel::getBorder()
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.
PhpExt_Panel::getBottomToolbar()
The bottom toolbar of the panel. This is a PhpExt_Toolbar_Toolbar object or any of its descendants. To access the bottom toolbar after javascript render, use getBottomToolbar.
PhpExt_Panel::getButtonAlign()
PhpExt_Panel::getButtons()
PhpExt_Panel::getCollapsed()
True to render the panel collapsed, false to render it expanded (defaults to false).
PhpExt_Panel::getCollapsedCssClass()
A CSS class to add to the panel's element after it has been collapsed (defaults to 'x-panel-collapsed').
PhpExt_Panel::getCollapseFirst()
True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the panel's title bar, false to render it last (defaults to true).
PhpExt_Panel::getCollapsible()
True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into the header tool button area, false to keep the panel statically sized with no button (defaults to false).
PhpExt_Panel::getConfigParams()
PhpExt_Panel::getContentElement()
The id of an existing HTML node to use as the panel's body content (defaults to '').
PhpExt_Panel::getDraggable()
True to enable dragging of this Panel (defaults to false). For custom drag/drop implementations, an Ext.Panel.DD config could also be passed in this config instead of true, although Ext.Panel.DD is an internal, undocumented class.
PhpExt_Panel::getElements()
A comma-delimited list of panel elements to initialize when the panel is rendered. Normally, this list will be generated automatically based on the items added to the panel at config time, but sometimes it might be useful to make sure a structural element is rendered even if not specified at config time (for example, you may want to add a button or toolbar dynamically after the panel has been rendered). Adding those elements to this list will allocate the required placeholders in the panel when it is rendered. Valid values are
PhpExt_Panel::getFloating()
True to float the panel (absolute position it with automatic shimming and shadow), false to display it inline where it is rendered (defaults to false). Note that by default, setting floating to true will cause the panel to display at negative offsets so that it is hidden -- because the panel is absolute positioned, the position must be set explicitly after render (e.g., myPanel.setPosition(100,100);). Also, when floating a panel you should always assign a fixed width, otherwise it will be auto width and will expand to fill to the right edge of the viewport.
PhpExt_Panel::getFooter()
True to create the footer element explicitly, false to skip creating it. By default, when footer is not specified, if one or more buttons have been added to the panel the footer will be created automatically, otherwise it will not.
PhpExt_Panel::getFrame()
True to render the panel with custom rounded borders, false to render with plain 1px square borders (defaults to false).
PhpExt_Panel::getHeader()
True to create the header element explicitly, false to skip creating it. By default, when header is not specified, if a title is set the header will be created automatically, otherwise it will not. If a title is set but header is explicitly set to false, the header will not be rendered.
PhpExt_Panel::getHeaderAsText()
True to display the panel title in the header, false to hide it (defaults to true).
PhpExt_Panel::getHideCollapseTool()
True to hide the expand/collapse toggle button when collapsible = true, false to display it (defaults to false).
PhpExt_Panel::getHtml()
An HTML fragment, or a DomHelper specification to use as the panel's body content (defaults to '').
PhpExt_Panel::getIconCssClass()
A CSS class that will provide a background image to be used as the panel header icon (defaults to '').
PhpExt_Panel::getKeys()
A KeyMap config object (in the format expected by Ext.KeyMap.addBinding used to assign custom key handling to this panel (defaults to null).
PhpExt_Panel::getLoadMask()
The id of the DOM Element which servers as loading mask to show loading messages
PhpExt_Panel::getMaskDisabled()
True to mask the panel when it is disabled, false to not mask it (defaults to true).
PhpExt_Panel::getMinButtonWidth()
Minimum width in pixels of all buttons in this panel (defaults to 75)
PhpExt_Panel::getShadow()
True (or a valid PhpExt_Shadow.Mode value) to display a shadow behind the panel, false to display no shadow (defaults to 'PhpExt_MODE_SIDES'). Note that this option only applies when floating = true.
PhpExt_Panel::getShadowOffset()
The number of pixels to offset the shadow if displayed (defaults to 4). Note that this option only applies when floating = true.
PhpExt_Panel::getShim()
False to disable the iframe shim in browsers which need one (defaults to true). Note that this option only applies when floating = true.
PhpExt_Panel::getTitle()
The title text to display in the panel header (defaults to ''). When a title is specified the header element will automatically be created and displayed unless header is explicitly set to false. If you don't want to specify a title at config time, but you may want one later, you must either specify a non-empty title (a blank space ' ' will do) or header:true so that the container element will get created.
PhpExt_Panel::getTitleCollapse()
True to allow expanding and collapsing the panel (when collapsible = true) by clicking anywhere in the header bar, false to allow it only by clicking to tool button (defaults to false).
PhpExt_Panel::getTools()
A PhpExt_ToolConfigObjectCollection of tool buttons to be added to the header tool area.
PhpExt_Panel::getTopToolbar()
The top toolbar of the panel. This is a PhpExt_Toolbar_Toolbar object or any of its descendants.
PhpExt_Panel::setAnimCollapse()
True to animate the transition when the panel is collapsed, false to skip the animation (defaults to true if the Ext.Fx class is available, otherwise false).
PhpExt_Panel::setApplyTo()
The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some panel-specific structural markup. When applyTo is used, constituent parts of the panel can be specified by CSS class name within the main element, and the panel will automatically create those components from that markup. Any required components not specified in the markup will be autogenerated if necessary. The following class names are supported (baseCls will be replaced by BaseCssClass):
PhpExt_Panel::setAutoLoad()
PhpExt_Panel::setAutoScroll()
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).
PhpExt_Panel::setBaseCssClass()
The base CSS class to apply to this panel's element (defaults to 'x-panel').
PhpExt_Panel::setBodyBorder()
True to display an interior border on the body element of the panel, false to hide it (defaults to true). This only applies when border == true. If border == true and bodyBorder == false, the border will display as a 1px wide inset border, giving the entire body element an inset appearance.
PhpExt_Panel::setBodyStyle()
Custom CSS styles to be applied to the body element in the format expected by Ext.Element.applyStyles (defaults to null).
PhpExt_Panel::setBorder()
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.
PhpExt_Panel::setBottomToolbar()
The bottom toolbar of the panel. This is a PhpExt_Toolbar_Toolbar object or any of its descendants. To access the bottom toolbar after javascript render, use getBottomToolbar.
PhpExt_Panel::setButtonAlign()
The alignment of any buttons added to this panel. Valid values are:
PhpExt_Panel::setCollapsed()
True to render the panel collapsed, false to render it expanded (defaults to false).
PhpExt_Panel::setCollapsedCssClass()
A CSS class to add to the panel's element after it has been collapsed (defaults to 'x-panel-collapsed').
PhpExt_Panel::setCollapseFirst()
True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the panel's title bar, false to render it last (defaults to true).
PhpExt_Panel::setCollapsible()
True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into the header tool button area, false to keep the panel statically sized with no button (defaults to false).
PhpExt_Panel::setContentElement()
The id of an existing HTML node to use as the panel's body content (defaults to '').
PhpExt_Panel::setDraggable()
True to enable dragging of this Panel (defaults to false). For custom drag/drop implementations, an Ext.Panel.DD config could also be passed in this config instead of true, although Ext.Panel.DD is an internal, undocumented class.
PhpExt_Panel::setElements()
A comma-delimited list of panel elements to initialize when the panel is rendered. Normally, this list will be generated automatically based on the items added to the panel at config time, but sometimes it might be useful to make sure a structural element is rendered even if not specified at config time (for example, you may want to add a button or toolbar dynamically after the panel has been rendered). Adding those elements to this list will allocate the required placeholders in the panel when it is rendered. Valid values are
PhpExt_Panel::setFloating()
True to float the panel (absolute position it with automatic shimming and shadow), false to display it inline where it is rendered (defaults to false). Note that by default, setting floating to true will cause the panel to display at negative offsets so that it is hidden -- because the panel is absolute positioned, the position must be set explicitly after render (e.g., myPanel.setPosition(100,100);). Also, when floating a panel you should always assign a fixed width, otherwise it will be auto width and will expand to fill to the right edge of the viewport.
PhpExt_Panel::setFooter()
True to create the footer element explicitly, false to skip creating it. By default, when footer is not specified, if one or more buttons have been added to the panel the footer will be created automatically, otherwise it will not.
PhpExt_Panel::setFrame()
True to render the panel with custom rounded borders, false to render with plain 1px square borders (defaults to false).
PhpExt_Panel::setHeader()
True to create the header element explicitly, false to skip creating it. By default, when header is not specified, if a title is set the header will be created automatically, otherwise it will not. If a title is set but header is explicitly set to false, the header will not be rendered.
PhpExt_Panel::setHeaderAsText()
True to display the panel title in the header, false to hide it (defaults to true).
PhpExt_Panel::setHideCollapseTool()
True to hide the expand/collapse toggle button when collapsible = true, false to display it (defaults to false).
PhpExt_Panel::setHtml()
An HTML fragment, or a DomHelper specification to use as the panel's body content (defaults to '').
PhpExt_Panel::setIconCssClass()
A CSS class that will provide a background image to be used as the panel header icon (defaults to '').
PhpExt_Panel::setKeys()
A KeyMap config object (in the format expected by Ext.KeyMap.addBinding used to assign custom key handling to this panel (defaults to null).
PhpExt_Panel::setLoadMask()
The id of the DOM Element which servers as loading mask to show loading messages
PhpExt_Panel::setMaskDisabled()
True to mask the panel when it is disabled, false to not mask it (defaults to true).
PhpExt_Panel::setMinButtonWidth()
Minimum width in pixels of all buttons in this panel (defaults to 75)
PhpExt_Panel::setShadow()
True (or a valid PhpExt_Shadow.Mode value) to display a shadow behind the panel, false to display no shadow (defaults to 'PhpExt_MODE_SIDES'). Note that this option only applies when floating = true.
PhpExt_Panel::setShadowOffset()
The number of pixels to offset the shadow if displayed (defaults to 4). Note that this option only applies when floating = true.
PhpExt_Panel::setShim()
False to disable the iframe shim in browsers which need one (defaults to true). Note that this option only applies when floating = true.
PhpExt_Panel::setTitle()
The title text to display in the panel header (defaults to ''). When a title is specified the header element will automatically be created and displayed unless header is explicitly set to false. If you don't want to specify a title at config time, but you may want one later, you must either specify a non-empty title (a blank space ' ' will do) or header:true so that the container element will get created.
PhpExt_Panel::setTitleCollapse()
True to allow expanding and collapsing the panel (when collapsible = true) by clicking anywhere in the header bar, false to allow it only by clicking to tool button (defaults to false).
PhpExt_Panel::setTopToolbar()
The top toolbar of the panel. This is a PhpExt_Toolbar_Toolbar object or any of its descendants.

Inherited From PhpExt_Container

PhpExt_Container::__construct()
PhpExt_Container::addItem()
Adds a component to the items collection
PhpExt_Container::getActiveItem()
A string component id or the numeric index of the component that should be initially activated within the container's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first item in the container's collection). activeItem only applies to layout styles that can display items one at a time (like Ext.layout.Accordion, Ext.layout.CardLayout and Ext.layout.FitLayout). Related to Ext.layout.ContainerLayout.activeItem.
PhpExt_Container::getAutoDestroy()
If true the container will automatically destroy any contained component that is removed from it, else destruction must be handled manually (defaults to true).
PhpExt_Container::getBufferResize()
When set to true (100 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer the frequency it calculates and does a re-layout of components. This is useful for heavy containers or containers with a large amount of sub components that frequent calls to layout are expensive.
PhpExt_Container::getConfigParams()
PhpExt_Container::getDefaults()
PhpExt_Container::getDefaultType()
The default type of container represented by this object as registered in Ext.ComponentMgr (defaults to 'panel').
PhpExt_Container::getHideBorders()
True to hide the borders of each contained component, false to defer to the component's existing border settings (defaults to false).
PhpExt_Container::getItems()
A single item, or an array of child Components to be added to this container. Each item can be any type of object based on Ext.Component.
PhpExt_Container::getLayout()
The layout type to be used in this container. If not specified, a default PhpExt_Layout_ContainerLayout will be created and used.
PhpExt_Container::getMonitorResize()
True to automatically monitor window resize events to handle anything that is sensitive to the current size of the viewport. This value is typically managed by the chosen layout and should not need to be set manually.
PhpExt_Container::setActiveItem()
A string component id or the numeric index of the component that should be initially activated within the container's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first item in the container's collection). activeItem only applies to layout styles that can display items one at a time (like Ext.layout.Accordion, Ext.layout.CardLayout and Ext.layout.FitLayout). Related to Ext.layout.ContainerLayout.activeItem.
PhpExt_Container::setAutoDestroy()
If true the container will automatically destroy any contained component that is removed from it, else destruction must be handled manually (defaults to true).
PhpExt_Container::setBufferResize()
When set to true (100 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer the frequency it calculates and does a re-layout of components. This is useful for heavy containers or containers with a large amount of sub components that frequent calls to layout are expensive.
PhpExt_Container::setDefaults()
A config object that will be applied to all components added to this container either via the items config or via the add or insert methods. The defaults config can contain any number of name/value property pairs to be added to each item, and should be valid for the types of items being added to the container. For example, to automatically apply padding to the body of each of a set of contained PhpExt_Panel items, you could pass: new PhpExt_Config_ConfigObject(array('bodyStyle'=>'padding:15px')).
PhpExt_Container::setDefaultType()
The default type of container represented by this object as registered in Ext.ComponentMgr (defaults to 'panel').
PhpExt_Container::setHideBorders()
True to hide the borders of each contained component, false to defer to the component's existing border settings (defaults to false).
PhpExt_Container::setLayout()
The layout type to be used in this container. If not specified, a default PhpExt_Layout_ContainerLayout will be created and used.
PhpExt_Container::setMonitorResize()
True to automatically monitor window resize events to handle anything that is sensitive to the current size of the viewport. This value is typically managed by the chosen layout and should not need to be set manually.

Inherited From PhpExt_BoxComponent

PhpExt_BoxComponent::__construct()
PhpExt_BoxComponent::getAutoHeight()
True to use height:'auto', false to use fixed height (defaults to false).
PhpExt_BoxComponent::getAutoWidth()
True to use width:'auto', false to use fixed width (defaults to false).
PhpExt_BoxComponent::getHeight()
The height of this component in pixels (defaults to auto).
PhpExt_BoxComponent::getWidth()
The width of this component in pixels (defaults to auto).
PhpExt_BoxComponent::setAutoHeight()
True to use height:'auto', false to use fixed height (defaults to false).
PhpExt_BoxComponent::setAutoWidth()
True to use width:'auto', false to use fixed width (defaults to false).
PhpExt_BoxComponent::setHeight()
The height of this component in pixels (defaults to auto).
PhpExt_BoxComponent::setWidth()
The width of this component in pixels (defaults to auto).

Inherited From PhpExt_Component

PhpExt_Component::__construct()
** Overrides ***
PhpExt_Component::getAllowDomMove()
Whether the component can move the Dom node when rendering (defaults to true).
PhpExt_Component::getApplyTo()
The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component. When applyTo is used, constituent parts of the component can also be specified by id or CSS class name within the main element, and the component being created may attempt to create its subcomponents from that markup if applicable. Using this config, a call to render() is not required. 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.
PhpExt_Component::getAutoShow()
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).
PhpExt_Component::getConfigParams()
PhpExt_Component::getContainerCssClass()
An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.
PhpExt_Component::getCssClass()
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.
PhpExt_Component::getCssStyle()
A custom style specification to be applied to this component's Element.
PhpExt_Component::getDisabledCssClass()
CSS class added to the component when it is disabled (defaults to "x-item-disabled").
PhpExt_Component::getEl()
The DOM element to which this component show be rendered to. This should be used instead of renderTo or applyTo if using lazy render.
PhpExt_Component::getHideMode()
How this component should hidden. Supported values are
  1. PhpExt_Component::HIDE_MODE_VISIBILITY
(css visibility),
  1. PhpExt_Component::HIDE_MODE_OFFSETS
(negative offset position) and
  1. PhpExt_Component::HIDE_MODE_DISPLAY
(css display) - defaults to
  1. PhpExt_Component::HIDE_MODE_DISPLAY
.
PhpExt_Component::getHideParent()
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.
PhpExt_Component::getId()
The unique id of this component (defaults to an auto-assigned id).
PhpExt_Component::getLayoutData()
PhpExt_Component::getOwnerCollection()
PhpExt_Component::getPlugins()
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.
PhpExt_Component::getRenderTo()
The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.
PhpExt_Component::render()
** Ext Object Methods ***
PhpExt_Component::setAllowDomMove()
Whether the component can move the Dom node when rendering (defaults to true).
PhpExt_Component::setApplyTo()
The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component. When applyTo is used, constituent parts of the component can also be specified by id or CSS class name within the main element, and the component being created may attempt to create its subcomponents from that markup if applicable. Using this config, a call to render() is not required. 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.
PhpExt_Component::setAutoShow()
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).
PhpExt_Component::setContainerCssClass()
An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.
PhpExt_Component::setCssClass()
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.
PhpExt_Component::setCssStyle()
A custom style specification to be applied to this component's Element.
PhpExt_Component::setDisabledCssClass()
CSS class added to the component when it is disabled (defaults to "x-item-disabled").
PhpExt_Component::setEl()
The DOM element to which this component show be rendered to. This should be used instead of renderTo or applyTo if using lazy render.
PhpExt_Component::setExtClassInfo()
PhpExt_Component::setHideMode()
How this component should hidden. Supported values are
  1. PhpExt_Component::HIDE_MODE_VISIBILITY
(css visibility),
  1. PhpExt_Component::HIDE_MODE_OFFSETS
(negative offset position) and
  1. PhpExt_Component::HIDE_MODE_DISPLAY
(css display) - defaults to
  1. PhpExt_Component::HIDE_MODE_DISPLAY
.
PhpExt_Component::setHideParent()
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.
PhpExt_Component::setId()
The unique id of this component (defaults to an auto-assigned id).
PhpExt_Component::setLayoutData()
Layout specific properties for the corresponding layout of the container.
PhpExt_Component::setOwnerCollection()
PhpExt_Component::setRenderTo()
The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.

Inherited From PhpExt_Observable

PhpExt_Observable::__construct()
PhpExt_Observable::attachListener()
Adds a PhpExt_Listener to the specified $eventName. This lintener will execute when the Javascript object fires that event.
PhpExt_Observable::getConfigParams()
PhpExt_Observable::getListeners()

Inherited From PhpExt_Object

PhpExt_Object::__construct()
PhpExt_Object::addValidConfigProperties()
PhpExt_Object::createMethodSignature()
PhpExt_Object::getConfigParams()
PhpExt_Object::getExtConfigProperty()
PhpExt_Object::getJavascript()
PhpExt_Object::getMethodInvokeStm()
PhpExt_Object::isExtObject()
PhpExt_Object::paramToString()
PhpExt_Object::setExtClassInfo()
PhpExt_Object::setExtConfigProperty()
PhpExt_Object::__get()
PhpExt_Object::__set()

Inherited From PhpExt_Component

PhpExt_Component::HIDE_MODE_DISPLAY
PhpExt_Component::HIDE_MODE_OFFSETS
PhpExt_Component::HIDE_MODE_VISIBILITY

[ Top ]
Method Summary
PhpExt_Tree_TreePanel   __construct()  
void   collapseAll()   Collapse all nodes
void   expandAll()   Expand all nodes
boolean   getAnimate()   true to enable animated expand/collapse (defaults to the value of Ext.enableFx)
boolean   getContainerScroll()   true to register this container with ScrollManager
boolean   getDdAppendOnly()   True if the tree should only allow append drops (use for trees which are sorted)
string   getDdGroup()   The DD group this TreePanel belongs to
boolean   getDdScroll()   true to enable body scrolling
boolean   getEnableDd()   true to enable drag and drop
boolean   getEnableDrag()   true to enable just drag
boolean   getEnableDrop()   true to enable just drop
string   getHighlightColor()   The color of the node highlight (defaults to C3DAF9)
boolean   getHighlightDrop()   false to disable node highlight on drop (defaults to the value of Ext.enableFx)
boolean   getLines()   false to disable tree lines (defaults to true)
PhpExt_Tree_TreeLoader   getLoader()   A PhpExt_Tree_TreeLoader for use with this TreePanel
string   getPathSeparator()   The token used to separate sub-paths in path strings (defaults to '/')
PhpExt_Tree_TreeNode   getRoot()   The root node for the tree.
boolean   getRootVisible()   false to hide the root node (defaults to true)
PhpExt_Tree_AbstractSelectionModel   getSelectionModel()   A tree selection model to use with this TreePanel (defaults to a PhpExt_Tree_DefaultSelectionModel)
boolean   getSingleExpand()   true if only 1 node per branch may be expanded
boolean   getTrackMouseOver()   False to disable mouse over highlighting
boolean   getUseArrows()   True to use Vista-style arrows in the tree (defaults to false)
PhpExt_Tree_TreePanel   setAnimate()   true to enable animated expand/collapse (defaults to the value of Ext.enableFx)
PhpExt_Tree_TreePanel   setContainerScroll()   true to register this container with ScrollManager
PhpExt_Tree_TreePanel   setDdAppendOnly()   True if the tree should only allow append drops (use for trees which are sorted)
PhpExt_Tree_TreePanel   setDdGroup()   The DD group this TreePanel belongs to
PhpExt_Tree_TreePanel   setDdScroll()   true to enable body scrolling
PhpExt_Tree_TreePanel   setEnableDd()   true to enable drag and drop
PhpExt_Tree_TreePanel   setEnableDrag()   true to enable just drag
PhpExt_Tree_TreePanel   setEnableDrop()   true to enable just drop
PhpExt_Tree_TreePanel   setHighlightColor()   The color of the node highlight (defaults to C3DAF9)
PhpExt_Tree_TreePanel   setHighlightDrop()   false to disable node highlight on drop (defaults to the value of Ext.enableFx)
PhpExt_Tree_TreePanel   setLines()   false to disable tree lines (defaults to true)
PhpExt_Tree_TreePanel   setLoader()   A PhpExt_Tree_TreeLoader for use with this TreePanel
PhpExt_Tree_TreePanel   setPathSeparator()   The token used to separate sub-paths in path strings (defaults to '/')
PhpExt_Tree_TreePanel   setRoot()   The root node for the tree.
void   setRootNode()   Sets the root node for this tree during initialization.
PhpExt_Tree_TreePanel   setRootVisible()   false to hide the root node (defaults to true)
PhpExt_Tree_TreePanel   setSelectionModel()   A tree selection model to use with this TreePanel (defaults to a PhpExt_Tree_DefaultSelectionModel)
PhpExt_Tree_TreePanel   setSingleExpand()   true if only 1 node per branch may be expanded
PhpExt_Tree_TreePanel   setTrackMouseOver()   False to disable mouse over highlighting
PhpExt_Tree_TreePanel   setUseArrows()   True to use Vista-style arrows in the tree (defaults to false)

[ Top ]
Methods
Constructor __construct  [line 379]

  PhpExt_Tree_TreePanel __construct( )


API Tags:
Access:  public


Redefinition of:
PhpExt_Panel::__construct()

[ Top ]
collapseAll  [line 414]

  void collapseAll( )

Collapse all nodes


API Tags:
Access:  public


[ Top ]
expandAll  [line 423]

  void expandAll( )

Expand all nodes


API Tags:
Access:  public


[ Top ]
getAnimate  [line 47]

  boolean getAnimate( )

true to enable animated expand/collapse (defaults to the value of Ext.enableFx)


API Tags:
Access:  public


[ Top ]
getContainerScroll  [line 65]

  boolean getContainerScroll( )

true to register this container with ScrollManager


API Tags:
Access:  public


[ Top ]
getDdAppendOnly  [line 83]

  boolean getDdAppendOnly( )

True if the tree should only allow append drops (use for trees which are sorted)


API Tags:
Access:  public


[ Top ]
getDdGroup  [line 101]

  string getDdGroup( )

The DD group this TreePanel belongs to


API Tags:
Access:  public


[ Top ]
getDdScroll  [line 119]

  boolean getDdScroll( )

true to enable body scrolling


API Tags:
Access:  public


[ Top ]
getEnableDd  [line 140]

  boolean getEnableDd( )

true to enable drag and drop


API Tags:
Access:  public


[ Top ]
getEnableDrag  [line 158]

  boolean getEnableDrag( )

true to enable just drag


API Tags:
Access:  public


[ Top ]
getEnableDrop  [line 176]

  boolean getEnableDrop( )

true to enable just drop


API Tags:
Access:  public


[ Top ]
getHighlightColor  [line 194]

  string getHighlightColor( )

The color of the node highlight (defaults to C3DAF9)


API Tags:
Access:  public


[ Top ]
getHighlightDrop  [line 212]

  boolean getHighlightDrop( )

false to disable node highlight on drop (defaults to the value of Ext.enableFx)


API Tags:
Access:  public


[ Top ]
getLines  [line 230]

  boolean getLines( )

false to disable tree lines (defaults to true)


API Tags:
Access:  public


[ Top ]
getLoader  [line 248]

  PhpExt_Tree_TreeLoader getLoader( )

A PhpExt_Tree_TreeLoader for use with this TreePanel


API Tags:
Access:  public


[ Top ]
getPathSeparator  [line 266]

  string getPathSeparator( )

The token used to separate sub-paths in path strings (defaults to '/')


API Tags:
Access:  public


[ Top ]
getRoot  [line 284]

  PhpExt_Tree_TreeNode getRoot( )

The root node for the tree.


API Tags:
Access:  public


[ Top ]
getRootVisible  [line 302]

  boolean getRootVisible( )

false to hide the root node (defaults to true)


API Tags:
Access:  public


[ Top ]
getSelectionModel  [line 320]

  PhpExt_Tree_AbstractSelectionModel getSelectionModel( )

A tree selection model to use with this TreePanel (defaults to a PhpExt_Tree_DefaultSelectionModel)


API Tags:
Access:  public


[ Top ]
getSingleExpand  [line 338]

  boolean getSingleExpand( )

true if only 1 node per branch may be expanded


API Tags:
Access:  public


[ Top ]
getTrackMouseOver  [line 356]

  boolean getTrackMouseOver( )

False to disable mouse over highlighting


API Tags:
Access:  public


[ Top ]
getUseArrows  [line 374]

  boolean getUseArrows( )

True to use Vista-style arrows in the tree (defaults to false)


API Tags:
Access:  public


[ Top ]
setAnimate  [line 39]

  PhpExt_Tree_TreePanel setAnimate( boolean $value  )

true to enable animated expand/collapse (defaults to the value of Ext.enableFx)

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setContainerScroll  [line 57]

  PhpExt_Tree_TreePanel setContainerScroll( boolean $value  )

true to register this container with ScrollManager

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setDdAppendOnly  [line 75]

  PhpExt_Tree_TreePanel setDdAppendOnly( boolean $value  )

True if the tree should only allow append drops (use for trees which are sorted)

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setDdGroup  [line 93]

  PhpExt_Tree_TreePanel setDdGroup( string $value  )

The DD group this TreePanel belongs to

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setDdScroll  [line 111]

  PhpExt_Tree_TreePanel setDdScroll( boolean $value  )

true to enable body scrolling

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setEnableDd  [line 132]

  PhpExt_Tree_TreePanel setEnableDd( boolean $value  )

true to enable drag and drop

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setEnableDrag  [line 150]

  PhpExt_Tree_TreePanel setEnableDrag( boolean $value  )

true to enable just drag

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setEnableDrop  [line 168]

  PhpExt_Tree_TreePanel setEnableDrop( boolean $value  )

true to enable just drop

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setHighlightColor  [line 186]

  PhpExt_Tree_TreePanel setHighlightColor( string $value  )

The color of the node highlight (defaults to C3DAF9)

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setHighlightDrop  [line 204]

  PhpExt_Tree_TreePanel setHighlightDrop( boolean $value  )

false to disable node highlight on drop (defaults to the value of Ext.enableFx)

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setLines  [line 222]

  PhpExt_Tree_TreePanel setLines( boolean $value  )

false to disable tree lines (defaults to true)

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setLoader  [line 240]

A PhpExt_Tree_TreeLoader for use with this TreePanel

Parameters:
PhpExt_Tree_TreeLoader   $value: 

API Tags:
Access:  public


[ Top ]
setPathSeparator  [line 258]

  PhpExt_Tree_TreePanel setPathSeparator( string $value  )

The token used to separate sub-paths in path strings (defaults to '/')

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setRoot  [line 276]

The root node for the tree.

Parameters:
PhpExt_Tree_TreeNode   $value: 

API Tags:
Access:  public


[ Top ]
setRootNode  [line 433]

Sets the root node for this tree during initialization.

Parameters:
PhpExt_Data_Node|PhpExt_Tree_TreeNode|PhpExt_JavascriptStm   $node:  Node variable reference

API Tags:
Access:  public


[ Top ]
setRootVisible  [line 294]

  PhpExt_Tree_TreePanel setRootVisible( boolean $value  )

false to hide the root node (defaults to true)

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setSelectionModel  [line 312]

A tree selection model to use with this TreePanel (defaults to a PhpExt_Tree_DefaultSelectionModel)

Parameters:
PhpExt_Tree_AbstractSelectionModel   $value: 

API Tags:
Access:  public


[ Top ]
setSingleExpand  [line 330]

  PhpExt_Tree_TreePanel setSingleExpand( boolean $value  )

true if only 1 node per branch may be expanded

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setTrackMouseOver  [line 348]

  PhpExt_Tree_TreePanel setTrackMouseOver( boolean $value  )

False to disable mouse over highlighting

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
setUseArrows  [line 366]

  PhpExt_Tree_TreePanel setUseArrows( boolean $value  )

True to use Vista-style arrows in the tree (defaults to false)

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]

Documentation generated on Fri, 08 Aug 2008 16:02:13 -0500 by phpDocumentor 1.4.0