Class: PhpExt_Panel

Source Location: /PhpExt/Panel.php

Class PhpExt_Panel

Class Overview

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

Properties

Methods

[ Top ]

Descendants

Child Class	Description
PhpExt_Form_FieldSet	Standard container used for grouping form fields.
PhpExt_Form_FormPanel	Standard form container.
PhpExt_Grid_GridPanel	This class represents the primary interface of a component based grid control.
PhpExt_TabPanel
PhpExt_Tree_TreePanel	The TreePanel provides tree-structured UI representation of tree-structured data.
PhpExt_Window	A specialized panel intended for use as an application window. Windows are floated and draggable by default, and also provide specific behavior like the ability to maximize and restore (with an event for minimizing, since the minimize behavior is application-specific).

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

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_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
PhpExt_Component::HIDE_MODE_VISIBILITY

(css visibility),
PhpExt_Component::HIDE_MODE_OFFSETS

(negative offset position) and
PhpExt_Component::HIDE_MODE_DISPLAY

(css display) - defaults to
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
PhpExt_Component::HIDE_MODE_VISIBILITY

(css visibility),
PhpExt_Component::HIDE_MODE_OFFSETS

(negative offset position) and
PhpExt_Component::HIDE_MODE_DISPLAY

(css display) - defaults to
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 ]

Property Summary

mixed	$BaseCssClass
PhpExt_Toolbar_Toolbar	$_bottomToolbar
PhpExt_ButtonCollection	$_buttons	A collection of PhpExt_Button Objects
PhpExt_ToolConfigObjectCollection	$_tools
PhpExt_Toolbar_Toolbar	$_topToolbar

[ Top ]

Method Summary

PhpExt_Panel	__construct()
PhpExt_Button	addButton()	Adds a button to the footer
PhpExt_Panel	addTool()	A PhpExt_ToolConfigObject to add to the tools collection
boolean	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).
string\|DOMNode\|Element	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_AutoLoadConfigObject	getAutoLoad()
boolean	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).
string	getBaseCssClass()	The base CSS class to apply to this panel's element (defaults to 'x-panel').
boolean	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.
string	getBodyStyle()	Custom CSS styles to be applied to the body element in the format expected by Ext.Element.applyStyles (defaults to null).
boolean	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_Toolbar_Toolbar	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.
string	getButtonAlign()
PhpExt_ButtonCollection	getButtons()
boolean	getCollapsed()	True to render the panel collapsed, false to render it expanded (defaults to false).
string	getCollapsedCssClass()	A CSS class to add to the panel's element after it has been collapsed (defaults to 'x-panel-collapsed').
boolean	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).
boolean	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).
void	getConfigParams()
string	getContentElement()	The id of an existing HTML node to use as the panel's body content (defaults to '').
boolean	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.
string	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
boolean	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.
boolean	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.
boolean	getFrame()	True to render the panel with custom rounded borders, false to render with plain 1px square borders (defaults to false).
boolean	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.
boolean	getHeaderAsText()	True to display the panel title in the header, false to hide it (defaults to true).
boolean	getHideCollapseTool()	True to hide the expand/collapse toggle button when collapsible = true, false to display it (defaults to false).
string	getHtml()	An HTML fragment, or a DomHelper specification to use as the panel's body content (defaults to '').
string	getIconCssClass()	A CSS class that will provide a background image to be used as the panel header icon (defaults to '').
string	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).
string	getLoadMask()	The id of the DOM Element which servers as loading mask to show loading messages
boolean	getMaskDisabled()	True to mask the panel when it is disabled, false to not mask it (defaults to true).
integer	getMinButtonWidth()	Minimum width in pixels of all buttons in this panel (defaults to 75)
boolean	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.
integer	getShadowOffset()	The number of pixels to offset the shadow if displayed (defaults to 4). Note that this option only applies when floating = true.
boolean	getShim()	False to disable the iframe shim in browsers which need one (defaults to true). Note that this option only applies when floating = true.
string	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.
boolean	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_ToolConfigObjectCollection	getTools()	A PhpExt_ToolConfigObjectCollection of tool buttons to be added to the header tool area.
PhpExt_Toolbar_Toolbar	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.

[ Top ]

Properties

mixed $BaseCssClass = null [line 147]

API Tags:

Access:

public

[ Top ]

PhpExt_Toolbar_Toolbar $_bottomToolbar [line 153]

API Tags:

Access:

protected

[ Top ]

PhpExt_ButtonCollection $_buttons = null [line 259]

A collection of PhpExt_Button Objects

API Tags:

Access:

protected

[ Top ]

PhpExt_ToolConfigObjectCollection $_tools [line 751]

API Tags:

Access:

protected

[ Top ]

PhpExt_Toolbar_Toolbar $_topToolbar = null [line 674]

API Tags:

Access:

protected

[ Top ]

Methods

Constructor __construct [line 773]

PhpExt_Panel __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Container::__construct()

Redefined in descendants as:

[ Top ]

addButton [line 845]

PhpExt_Button addButton(

$button, PhpExt_Button
$field 
)

Adds a button to the footer

Parameters:

PhpExt_Button	$field:
	$button:

API Tags:

Access:

public

[ Top ]

addTool [line 767]

PhpExt_Panel addTool(
PhpExt_ToolConfigObject
$tool, [string
$name = null] 
)

A PhpExt_ToolConfigObject to add to the tools collection

Parameters:

PhpExt_ToolConfigObject	$tool:
string	$name:	Optional key to locate the tool on the collection

API Tags:

Access:

public

[ Top ]

getAnimCollapse [line 50]

boolean 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).

API Tags:

Access:

public

[ Top ]

getApplyTo [line 89]

string|DOMNode|Element 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):

 baseCls + '-header'
 baseCls + '-header-text'
 baseCls + '-bwrap'
 baseCls + '-tbar'
 baseCls + '-body'
 baseCls + '-bbar'
 baseCls + '-footer'

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 panel's container.

API Tags:

Access:

public

Redefinition of:

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.

[ Top ]

getAutoLoad [line 108]

PhpExt_AutoLoadConfigObject getAutoLoad(
)

API Tags:

Access:

public

[ Top ]

getAutoScroll [line 126]

boolean 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).

API Tags:

Access:

public

[ Top ]

getBaseCssClass [line 144]

string getBaseCssClass(
)

The base CSS class to apply to this panel's element (defaults to 'x-panel').

API Tags:

Access:

public

Redefined in descendants as:

PhpExt_Form_FieldSet::getBaseCssClass() : The base CSS class applied to the fieldset (defaults to 'x-fieldset').
PhpExt_TabPanel::getBaseCssClass() : The base CSS class applied to the panel (defaults to 'x-tab-panel').
PhpExt_Window::getBaseCssClass() : The base CSS class to apply to this panel's element (defaults to 'x-window').

[ Top ]

getBodyBorder [line 186]

boolean 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.

API Tags:

Access:

public

[ Top ]

getBodyStyle [line 204]

string getBodyStyle(
)

Custom CSS styles to be applied to the body element in the format expected by Ext.Element.applyStyles (defaults to null).

API Tags:

Access:

public

[ Top ]

getBorder [line 223]

boolean 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.

API Tags:

Access:

public

[ Top ]

getBottomToolbar [line 168]

PhpExt_Toolbar_Toolbar 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.

API Tags:

Access:

public

[ Top ]

getButtonAlign [line 249]

string getButtonAlign(
)

API Tags:

Access:

public

Redefined in descendants as:

PhpExt_Form_FormPanel::getButtonAlign()

[ Top ]

getButtons [line 264]

PhpExt_ButtonCollection getButtons(
)

API Tags:

Access:

public

[ Top ]

getCollapsed [line 300]

boolean getCollapsed(
)

True to render the panel collapsed, false to render it expanded (defaults to false).

API Tags:

Access:

public

[ Top ]

getCollapsedCssClass [line 318]

string getCollapsedCssClass(
)

A CSS class to add to the panel's element after it has been collapsed (defaults to 'x-panel-collapsed').

API Tags:

Access:

public

[ Top ]

getCollapseFirst [line 282]

boolean 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).

API Tags:

Access:

public

[ Top ]

getCollapsible [line 336]

boolean 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).

API Tags:

Access:

public

[ Top ]

getConfigParams [line 828]

void getConfigParams(
[
$lazy = false] 
)

Parameters:

$lazy:

API Tags:

Access:

protected

Redefinition of:

PhpExt_Container::getConfigParams()

Redefined in descendants as:

PhpExt_Grid_PropertyGrid::getConfigParams()

[ Top ]

getContentElement [line 354]

string getContentElement(
)

The id of an existing HTML node to use as the panel's body content (defaults to '').

API Tags:

Access:

public

[ Top ]

getDraggable [line 372]

boolean 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.

API Tags:

Access:

public

Redefined in descendants as:

PhpExt_Window::getDraggable() : True to allow the window to be dragged by the header bar, false to disable dragging (defaults to true). Note that by default the window will be centered in the viewport, so if dragging is disabled the window may need to be positioned programmatically after render (e.g., myWindow.setPosition(100, 100);).

[ Top ]

getElements [line 408]

string 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

header tbar (top bar) body bbar (bottom bar) footer

Defaults to 'body'.

API Tags:

Access:

public

[ Top ]

getFloating [line 426]

boolean 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.

API Tags:

Access:

public

[ Top ]

getFooter [line 444]

boolean 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.

API Tags:

Access:

public

[ Top ]

getFrame [line 462]

boolean getFrame(
)

True to render the panel with custom rounded borders, false to render with plain 1px square borders (defaults to false).

API Tags:

Access:

public

[ Top ]

getHeader [line 480]

boolean 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.

API Tags:

Access:

public

[ Top ]

getHeaderAsText [line 498]

boolean getHeaderAsText(
)

True to display the panel title in the header, false to hide it (defaults to true).

API Tags:

Access:

public

[ Top ]

getHideCollapseTool [line 516]

boolean getHideCollapseTool(
)

True to hide the expand/collapse toggle button when collapsible = true, false to display it (defaults to false).

API Tags:

Access:

public

[ Top ]

getHtml [line 534]

string getHtml(
)

An HTML fragment, or a DomHelper specification to use as the panel's body content (defaults to '').

API Tags:

Access:

public

[ Top ]

getIconCssClass [line 552]

string getIconCssClass(
)

A CSS class that will provide a background image to be used as the panel header icon (defaults to '').

API Tags:

Access:

public

[ Top ]

getKeys [line 570]

string 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).

API Tags:

Access:

public

[ Top ]

getLoadMask [line 743]

string getLoadMask(
)

The id of the DOM Element which servers as loading mask to show loading messages

API Tags:

Access:

public

Redefined in descendants as:

PhpExt_Grid_GridPanel::getLoadMask() : An PhpExt_LoadMask object or true to mask the grid while loading (defaults to false).

[ Top ]

getMaskDisabled [line 592]

boolean getMaskDisabled(
)

True to mask the panel when it is disabled, false to not mask it (defaults to true).

Either way, the panel will always tell its contained elements to disable themselves when it is disabled, but masking the panel can provide an additional visual cue that the panel is disabled.

API Tags:

Access:

public

[ Top ]

getMinButtonWidth [line 610]

integer getMinButtonWidth(
)

Minimum width in pixels of all buttons in this panel (defaults to 75)

API Tags:

Access:

public

Redefined in descendants as:

PhpExt_Form_FormPanel::getMinButtonWidth() : Minimum width of all buttons in pixels (defaults to 75)

[ Top ]

getShadow [line 628]

boolean 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.

API Tags:

Access:

public

[ Top ]

getShadowOffset [line 646]

integer getShadowOffset(
)

The number of pixels to offset the shadow if displayed (defaults to 4). Note that this option only applies when floating = true.

API Tags:

Access:

public

[ Top ]

getShim [line 665]

boolean getShim(
)

False to disable the iframe shim in browsers which need one (defaults to true). Note that this option only applies when floating = true.

API Tags:

Access:

public

[ Top ]

getTitle [line 707]

string 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.

API Tags:

Access:

public

[ Top ]

getTitleCollapse [line 725]

boolean 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).

API Tags:

Access:

public

[ Top ]

getTools [line 757]

PhpExt_ToolConfigObjectCollection getTools(
)

A PhpExt_ToolConfigObjectCollection of tool buttons to be added to the header tool area.

Note that apart from the toggle tool which is provided when a panel is collapsible, these tools only provide the visual button. Any required functionality must be provided by adding handlers that implement the necessary behavior.

API Tags:

Access:

public

[ Top ]

getTopToolbar [line 689]

PhpExt_Toolbar_Toolbar getTopToolbar(
)

The top toolbar of the panel. This is a PhpExt_Toolbar_Toolbar object or any of its descendants.

API Tags:

Access:

public

[ Top ]

setAnimCollapse [line 42]

PhpExt_Panel setAnimCollapse(
boolean
$value 
)

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).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setApplyTo [line 71]

PhpExt_Panel setApplyTo(
string|DOMNode|Element
$value 
)

 baseCls + '-header'
 baseCls + '-header-text'
 baseCls + '-bwrap'
 baseCls + '-tbar'
 baseCls + '-body'
 baseCls + '-bbar'
 baseCls + '-footer'

Parameters:

string|DOMNode|Element

$value:

API Tags:

Access:

public

Redefinition of:

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.

[ Top ]

setAutoLoad [line 100]

PhpExt_Panel setAutoLoad(
$value
$value 
)

Parameters:

$value

$value:

PhpExt_AutoLoadConfigObject

API Tags:

Access:

public

[ Top ]

setAutoScroll [line 118]

PhpExt_Panel setAutoScroll(
boolean
$value 
)

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).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setBaseCssClass [line 136]

PhpExt_Panel setBaseCssClass(
string
$value 
)

The base CSS class to apply to this panel's element (defaults to 'x-panel').

Parameters:

string

$value:

API Tags:

Access:

public

Redefined in descendants as:

PhpExt_Form_FieldSet::setBaseCssClass() : The base CSS class applied to the fieldset (defaults to 'x-fieldset').
PhpExt_TabPanel::setBaseCssClass() : The base CSS class applied to the panel (defaults to 'x-tab-panel').
PhpExt_Window::setBaseCssClass() : The base CSS class to apply to this panel's element (defaults to 'x-window').

[ Top ]

setBodyBorder [line 178]

PhpExt_Panel setBodyBorder(
boolean
$value 
)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setBodyStyle [line 196]

PhpExt_Panel setBodyStyle(
string
$value 
)

Custom CSS styles to be applied to the body element in the format expected by Ext.Element.applyStyles (defaults to null).

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setBorder [line 215]

PhpExt_Panel setBorder(
boolean
$value 
)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setBottomToolbar [line 159]

PhpExt_Panel setBottomToolbar(
PhpExt_Toolbar_Toolbar
$value 
)

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.

Parameters:

PhpExt_Toolbar_Toolbar

$value:

API Tags:

Access:

public

[ Top ]

setButtonAlign [line 241]

PhpExt_Panel setButtonAlign(
string
$value 
)

The alignment of any buttons added to this panel. Valid values are:

PhpExt_Ext::EXT_HALIGN_LEFT
PhpExt_Ext::EXT_HALIGN_RIGHT
PhpExt_Ext::EXT_HALIGN_CENTER

Defaults to PhpExt_Ext::EXT_HALIGN_RIGHT

Parameters:

string

$value:

API Tags:

Access:	public
Uses:	PhpExt_Ext::EXT_HALIGN_RIGHT
Uses:	PhpExt_Ext::EXT_HALIGN_LEFT
Uses:	PhpExt_Ext::EXT_HALIGN_CENTER

Redefined in descendants as:

PhpExt_Form_FormPanel::setButtonAlign() : The alignment of any buttons added to this panel. Valid values are:

[ Top ]

setCollapsed [line 292]

PhpExt_Panel setCollapsed(
boolean
$value 
)

True to render the panel collapsed, false to render it expanded (defaults to false).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setCollapsedCssClass [line 310]

PhpExt_Panel setCollapsedCssClass(
string
$value 
)

A CSS class to add to the panel's element after it has been collapsed (defaults to 'x-panel-collapsed').

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setCollapseFirst [line 274]

PhpExt_Panel setCollapseFirst(
boolean
$value 
)

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).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setCollapsible [line 328]

PhpExt_Panel setCollapsible(
boolean
$value 
)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setContentElement [line 346]

PhpExt_Panel setContentElement(
string
$value 
)

The id of an existing HTML node to use as the panel's body content (defaults to '').

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setDraggable [line 364]

PhpExt_Panel setDraggable(
boolean
$value 
)

Parameters:

boolean

$value:

API Tags:

Access:

public

Redefined in descendants as:

PhpExt_Window::setDraggable() : True to allow the window to be dragged by the header bar, false to disable dragging (defaults to true). Note that by default the window will be centered in the viewport, so if dragging is disabled the window may need to be positioned programmatically after render (e.g., myWindow.setPosition(100, 100);).

[ Top ]

setElements [line 391]

PhpExt_Panel setElements(
string
$value 
)

header tbar (top bar) body bbar (bottom bar) footer

Defaults to 'body'.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setFloating [line 418]

PhpExt_Panel setFloating(
boolean
$value 
)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setFooter [line 436]

PhpExt_Panel setFooter(
boolean
$value 
)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setFrame [line 454]

PhpExt_Panel setFrame(
boolean
$value 
)

True to render the panel with custom rounded borders, false to render with plain 1px square borders (defaults to false).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setHeader [line 472]

PhpExt_Panel setHeader(
boolean
$value 
)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setHeaderAsText [line 490]

PhpExt_Panel setHeaderAsText(
boolean
$value 
)

True to display the panel title in the header, false to hide it (defaults to true).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setHideCollapseTool [line 508]

PhpExt_Panel setHideCollapseTool(
boolean
$value 
)

True to hide the expand/collapse toggle button when collapsible = true, false to display it (defaults to false).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setHtml [line 526]

PhpExt_Panel setHtml(
string
$value 
)

An HTML fragment, or a DomHelper specification to use as the panel's body content (defaults to '').

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setIconCssClass [line 544]

PhpExt_Panel setIconCssClass(
string
$value 
)

A CSS class that will provide a background image to be used as the panel header icon (defaults to '').

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setKeys [line 562]

PhpExt_Panel setKeys(
string
$value 
)

A KeyMap config object (in the format expected by Ext.KeyMap.addBinding used to assign custom key handling to this panel (defaults to null).

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setLoadMask [line 735]

PhpExt_Panel setLoadMask(
string
$value 
)

The id of the DOM Element which servers as loading mask to show loading messages

Parameters:

string

$value:

API Tags:

Access:

public

Redefined in descendants as:

PhpExt_Grid_GridPanel::setLoadMask() : An PhpExt_LoadMask object or true to mask the grid while loading (defaults to false).

[ Top ]

setMaskDisabled [line 582]

PhpExt_Panel setMaskDisabled(
boolean
$value 
)

True to mask the panel when it is disabled, false to not mask it (defaults to true).

Either way, the panel will always tell its contained elements to disable themselves when it is disabled, but masking the panel can provide an additional visual cue that the panel is disabled.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setMinButtonWidth [line 602]

PhpExt_Panel setMinButtonWidth(
integer
$value 
)

Minimum width in pixels of all buttons in this panel (defaults to 75)

Parameters:

integer

$value:

API Tags:

Access:

public

Redefined in descendants as:

PhpExt_Form_FormPanel::setMinButtonWidth() : Minimum width of all buttons in pixels (defaults to 75)

[ Top ]

setShadow [line 620]

PhpExt_Panel setShadow(
boolean
$value 
)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setShadowOffset [line 638]

PhpExt_Panel setShadowOffset(
integer
$value 
)

The number of pixels to offset the shadow if displayed (defaults to 4). Note that this option only applies when floating = true.

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setShim [line 657]

PhpExt_Panel setShim(
boolean
$value 
)

False to disable the iframe shim in browsers which need one (defaults to true). Note that this option only applies when floating = true.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setTitle [line 699]

PhpExt_Panel setTitle(
string
$value 
)

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setTitleCollapse [line 717]

PhpExt_Panel setTitleCollapse(
boolean
$value 
)

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).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setTopToolbar [line 680]

PhpExt_Panel setTopToolbar(
PhpExt_Toolbar_Toolbar
$value 
)

The top toolbar of the panel. This is a PhpExt_Toolbar_Toolbar object or any of its descendants.

Parameters:

PhpExt_Toolbar_Toolbar

$value:

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:57:46 -0500 by phpDocumentor 1.4.0