Class: PhpExt_TabPanel

Source Location: /PhpExt/TabPanel.php

Class PhpExt_TabPanel

Class Overview

Located in /PhpExt/TabPanel.php [line 26]

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

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
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 ]

Constant Summary

TAB_POSITON_BOTTOM
TAB_POSITON_TOP

[ Top ]

Method Summary

PhpExt_TabPanel	__construct()
string\|integer	getActiveTab()	A string id or the numeric index of the tab that should be initially activated on render (defaults to none).
boolean	getAnimScroll()	True to animate tab scrolling so that hidden tabs slide smoothly into view (defaults to true). Only applies when enableTabScroll = true.
boolean	getAutoTabs()
string	getAutoTabSelector()	The CSS selector used to search for tabs in existing markup when autoTabs = true (defaults to 'div.x-tab'). This can be any valid selector supported by Ext.DomQuery.select. Note that the query will be executed within the scope of this tab panel only (so that multiple tab panels from markup can be supported on a page).
string	getBaseCssClass()	The base CSS class applied to the panel (defaults to 'x-tab-panel').
boolean	getDeferredRender()	Internally, the TabPanel uses a Ext.layout.CardLayout to manage its tabs. This property will be passed on to the layout as its Ext.layout.CardLayout.deferredRender config value, determining whether or not each tab is rendered only when first accessed (defaults to true).
boolean	getEnableTabScroll()	True to enable scrolling to tabs that may be invisible due to overflowing the overall TabPanel width. Only available with tabs on top. (defaults to false).
boolean	getLayoutOnTabChange()	Set to true to do a layout of tab items as tabs are changed.
integer	getMinTabWidth()	The minimum width in pixels for each tab when resizeTabs = true (defaults to 30).
boolean	getMonitorResize()	True to automatically monitor window resize events and rerender the layout on browser resize (defaults to true).
boolean	getPlain()	True to render the tab strip without a background container image (defaults to false).
boolean	getResizeTabs()	True to automatically resize each tab so that the tabs will completely fill the tab strip (defaults to false). Setting this to true may cause specific widths that might be set per tab to be overridden in order to fit them all into view (although minTabWidth will always be honored).
float	getScrollDuration()	The number of milliseconds that each scroll animation should last (defaults to .35). Only applies when animScroll = true.
integer	getScrollIncrement()	The number of pixels to scroll each time a tab scroll button is pressed (defaults to 100, or if resizeTabs = true, the calculated tab width). Only applies when enableTabScroll = true.
integer	getScrollRepeatInterval()	Number of milliseconds between each scroll while a tab scroll button is continuously pressed (defaults to 400).
integer	getTabMargin()	The number of pixels of space to calculate into the sizing and scrolling of tabs. If you change the margin in CSS, you will need to update this value so calculations are correct with either resizeTabs or scrolling tabs. (defaults to 2)
string	getTabPosition()	The position where the tab strip should be rendered (defaults to PhpExt_TabPanel::TAB_POSITION_TOP). The only other supported value is PhpExt_TabPanel::TAB_POSITION_BOTTOM. Note that tab scrolling is only supported for position PhpExt_TabPanel::TAB_POSITION_TOP
integer	getTabWidth()	The initial width in pixels of each new tab (defaults to 120).
integer	getWheelIncrement()	For scrolling tabs, the number of pixels to increment on mouse wheel scrolling (defaults to 20).
PhpExt_TabPanel	setActiveTab()	A string id or the numeric index of the tab that should be initially activated on render (defaults to none).
PhpExt_TabPanel	setAnimScroll()	True to animate tab scrolling so that hidden tabs slide smoothly into view (defaults to true). Only applies when enableTabScroll = true.
PhpExt_TabPanel	setAutoTabs()	True to query the DOM for any divs with a class of 'x-tab' to be automatically converted to tabs and added to this panel (defaults to false). Note that the query will be executed within the scope of the container element only (so that multiple tab panels from markup can be supported via this method).
PhpExt_TabPanel	setAutoTabSelector()	The CSS selector used to search for tabs in existing markup when autoTabs = true (defaults to 'div.x-tab'). This can be any valid selector supported by Ext.DomQuery.select. Note that the query will be executed within the scope of this tab panel only (so that multiple tab panels from markup can be supported on a page).
PhpExt_TabPanel	setBaseCssClass()	The base CSS class applied to the panel (defaults to 'x-tab-panel').
PhpExt_TabPanel	setDeferredRender()	Internally, the TabPanel uses a Ext.layout.CardLayout to manage its tabs. This property will be passed on to the layout as its Ext.layout.CardLayout.deferredRender config value, determining whether or not each tab is rendered only when first accessed (defaults to true).
PhpExt_TabPanel	setEnableTabScroll()	True to enable scrolling to tabs that may be invisible due to overflowing the overall TabPanel width. Only available with tabs on top. (defaults to false).
PhpExt_TabPanel	setLayoutOnTabChange()	Set to true to do a layout of tab items as tabs are changed.
PhpExt_TabPanel	setMinTabWidth()	The minimum width in pixels for each tab when resizeTabs = true (defaults to 30).
PhpExt_TabPanel	setMonitorResize()	True to automatically monitor window resize events and rerender the layout on browser resize (defaults to true).
PhpExt_TabPanel	setPlain()	True to render the tab strip without a background container image (defaults to false).
PhpExt_TabPanel	setResizeTabs()	True to automatically resize each tab so that the tabs will completely fill the tab strip (defaults to false). Setting this to true may cause specific widths that might be set per tab to be overridden in order to fit them all into view (although minTabWidth will always be honored).
PhpExt_TabPanel	setScrollDuration()	The number of milliseconds that each scroll animation should last (defaults to .35). Only applies when animScroll = true.
PhpExt_TabPanel	setScrollIncrement()	The number of pixels to scroll each time a tab scroll button is pressed (defaults to 100, or if resizeTabs = true, the calculated tab width). Only applies when enableTabScroll = true.
PhpExt_TabPanel	setScrollRepeatInterval()	Number of milliseconds between each scroll while a tab scroll button is continuously pressed (defaults to 400).
PhpExt_TabPanel	setTabMargin()	The number of pixels of space to calculate into the sizing and scrolling of tabs. If you change the margin in CSS, you will need to update this value so calculations are correct with either resizeTabs or scrolling tabs. (defaults to 2)
PhpExt_TabPanel	setTabPosition()	The position where the tab strip should be rendered (defaults to PhpExt_TabPanel::TAB_POSITION_TOP). The only other supported value is PhpExt_TabPanel::TAB_POSITION_BOTTOM. Note that tab scrolling is only supported for position PhpExt_TabPanel::TAB_POSITION_TOP.
PhpExt_TabPanel	setTabWidth()	The initial width in pixels of each new tab (defaults to 120).
PhpExt_TabPanel	setWheelIncrement()	For scrolling tabs, the number of pixels to increment on mouse wheel scrolling (defaults to 20).

[ Top ]

Properties

Methods

Constructor __construct [line 384]

PhpExt_TabPanel __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Panel::__construct()

[ Top ]

getActiveTab [line 45]

string|integer getActiveTab(
)

A string id or the numeric index of the tab that should be initially activated on render (defaults to none).

API Tags:

Access:

public

[ Top ]

getAnimScroll [line 63]

boolean getAnimScroll(
)

True to animate tab scrolling so that hidden tabs slide smoothly into view (defaults to true). Only applies when enableTabScroll = true.

API Tags:

Access:

public

[ Top ]

getAutoTabs [line 110]

boolean getAutoTabs(
)

API Tags:

Access:

public

[ Top ]

getAutoTabSelector [line 81]

string getAutoTabSelector(
)

The CSS selector used to search for tabs in existing markup when autoTabs = true (defaults to 'div.x-tab'). This can be any valid selector supported by Ext.DomQuery.select. Note that the query will be executed within the scope of this tab panel only (so that multiple tab panels from markup can be supported on a page).

API Tags:

Access:

public

[ Top ]

getBaseCssClass [line 127]

string getBaseCssClass(
)

The base CSS class applied to the panel (defaults to 'x-tab-panel').

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

getDeferredRender [line 145]

boolean getDeferredRender(
)

Internally, the TabPanel uses a Ext.layout.CardLayout to manage its tabs. This property will be passed on to the layout as its Ext.layout.CardLayout.deferredRender config value, determining whether or not each tab is rendered only when first accessed (defaults to true).

API Tags:

Access:

public

[ Top ]

getEnableTabScroll [line 163]

boolean getEnableTabScroll(
)

True to enable scrolling to tabs that may be invisible due to overflowing the overall TabPanel width. Only available with tabs on top. (defaults to false).

API Tags:

Access:

public

[ Top ]

getLayoutOnTabChange [line 181]

boolean getLayoutOnTabChange(
)

Set to true to do a layout of tab items as tabs are changed.

API Tags:

Access:

public

[ Top ]

getMinTabWidth [line 199]

integer getMinTabWidth(
)

The minimum width in pixels for each tab when resizeTabs = true (defaults to 30).

API Tags:

Access:

public

[ Top ]

getMonitorResize [line 216]

boolean getMonitorResize(
)

True to automatically monitor window resize events and rerender the layout on browser resize (defaults to true).

API Tags:

Access:

public

Redefinition of:

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.

[ Top ]

getPlain [line 234]

boolean getPlain(
)

True to render the tab strip without a background container image (defaults to false).

API Tags:

Access:

public

[ Top ]

getResizeTabs [line 252]

boolean getResizeTabs(
)

True to automatically resize each tab so that the tabs will completely fill the tab strip (defaults to false). Setting this to true may cause specific widths that might be set per tab to be overridden in order to fit them all into view (although minTabWidth will always be honored).

API Tags:

Access:

public

[ Top ]

getScrollDuration [line 270]

float getScrollDuration(
)

The number of milliseconds that each scroll animation should last (defaults to .35). Only applies when animScroll = true.

API Tags:

Access:

public

[ Top ]

getScrollIncrement [line 288]

integer getScrollIncrement(
)

The number of pixels to scroll each time a tab scroll button is pressed (defaults to 100, or if resizeTabs = true, the calculated tab width). Only applies when enableTabScroll = true.

API Tags:

Access:

public

[ Top ]

getScrollRepeatInterval [line 306]

integer getScrollRepeatInterval(
)

Number of milliseconds between each scroll while a tab scroll button is continuously pressed (defaults to 400).

API Tags:

Access:

public

[ Top ]

getTabMargin [line 324]

integer getTabMargin(
)

The number of pixels of space to calculate into the sizing and scrolling of tabs. If you change the margin in CSS, you will need to update this value so calculations are correct with either resizeTabs or scrolling tabs. (defaults to 2)

API Tags:

Access:

public

[ Top ]

getTabPosition [line 342]

string getTabPosition(
)

The position where the tab strip should be rendered (defaults to PhpExt_TabPanel::TAB_POSITION_TOP). The only other supported value is PhpExt_TabPanel::TAB_POSITION_BOTTOM. Note that tab scrolling is only supported for position PhpExt_TabPanel::TAB_POSITION_TOP

API Tags:

Access:

public

[ Top ]

getTabWidth [line 361]

integer getTabWidth(
)

The initial width in pixels of each new tab (defaults to 120).

API Tags:

Access:

public

[ Top ]

getWheelIncrement [line 379]

integer getWheelIncrement(
)

For scrolling tabs, the number of pixels to increment on mouse wheel scrolling (defaults to 20).

API Tags:

Access:

public

[ Top ]

setActiveTab [line 37]

PhpExt_TabPanel setActiveTab(
string|integer
$value 
)

A string id or the numeric index of the tab that should be initially activated on render (defaults to none).

Parameters:

string|integer

$value:

API Tags:

Access:

public

[ Top ]

setAnimScroll [line 55]

PhpExt_TabPanel setAnimScroll(
boolean
$value 
)

True to animate tab scrolling so that hidden tabs slide smoothly into view (defaults to true). Only applies when enableTabScroll = true.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setAutoTabs [line 102]

PhpExt_TabPanel setAutoTabs(
boolean
$value 
)

True to query the DOM for any divs with a class of 'x-tab' to be automatically converted to tabs and added to this panel (defaults to false). Note that the query will be executed within the scope of the container element only (so that multiple tab panels from markup can be supported via this method).

This method is only possible when the markup is structured correctly as a container with nested divs containing the class 'x-tab'. To create TabPanels without these limitations, or to pull tab content from other elements on the page, see the example at the top of the class for generating tabs from markup. There are a couple of things to note when using this method:

When using the autoTabs config (as opposed to passing individual tab configs in the TabPanel's items collection), you must use applyTo to correctly use the specified id as the tab container. The autoTabs method replaces existing content with the TabPanel components.
Make sure that you set deferredRender to false so that the content elements for each tab will be rendered into the TabPanel immediately upon page load, otherwise they will not be transformed until each tab is activated and will be visible outside the TabPanel.
1. // This markup will be converted to a TabPanel from the code above
2. <div id="my-tabs">
3. <div class="x-tab" title="Tab 1">A simple tab</div>
4. <div class="x-tab" title="Tab 2">Another one</div>
5. </div>

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setAutoTabSelector [line 73]

PhpExt_TabPanel setAutoTabSelector(
string
$value 
)

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setBaseCssClass [line 120]

PhpExt_TabPanel setBaseCssClass(
string
$value 
)

The base CSS class applied to the panel (defaults to 'x-tab-panel').

Parameters:

string

$value:

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

setDeferredRender [line 137]

PhpExt_TabPanel setDeferredRender(
boolean
$value 
)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setEnableTabScroll [line 155]

PhpExt_TabPanel setEnableTabScroll(
boolean
$value 
)

True to enable scrolling to tabs that may be invisible due to overflowing the overall TabPanel width. Only available with tabs on top. (defaults to false).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setLayoutOnTabChange [line 173]

PhpExt_TabPanel setLayoutOnTabChange(
boolean
$value 
)

Set to true to do a layout of tab items as tabs are changed.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setMinTabWidth [line 191]

PhpExt_TabPanel setMinTabWidth(
integer
$value 
)

The minimum width in pixels for each tab when resizeTabs = true (defaults to 30).

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setMonitorResize [line 209]

PhpExt_TabPanel setMonitorResize(
boolean
$value 
)

True to automatically monitor window resize events and rerender the layout on browser resize (defaults to true).

Parameters:

boolean

$value:

API Tags:

Access:

public

Redefinition of:

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.

[ Top ]

setPlain [line 226]

PhpExt_TabPanel setPlain(
boolean
$value 
)

True to render the tab strip without a background container image (defaults to false).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setResizeTabs [line 244]

PhpExt_TabPanel setResizeTabs(
boolean
$value 
)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setScrollDuration [line 262]

PhpExt_TabPanel setScrollDuration(
float
$value 
)

The number of milliseconds that each scroll animation should last (defaults to .35). Only applies when animScroll = true.

Parameters:

float

$value:

API Tags:

Access:

public

[ Top ]

setScrollIncrement [line 280]

PhpExt_TabPanel setScrollIncrement(
integer
$value 
)

The number of pixels to scroll each time a tab scroll button is pressed (defaults to 100, or if resizeTabs = true, the calculated tab width). Only applies when enableTabScroll = true.

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setScrollRepeatInterval [line 298]

PhpExt_TabPanel setScrollRepeatInterval(
integer
$value 
)

Number of milliseconds between each scroll while a tab scroll button is continuously pressed (defaults to 400).

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setTabMargin [line 316]

PhpExt_TabPanel setTabMargin(
integer
$value 
)

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setTabPosition [line 334]

PhpExt_TabPanel setTabPosition(
string
$value 
)

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setTabWidth [line 353]

PhpExt_TabPanel setTabWidth(
integer
$value 
)

The initial width in pixels of each new tab (defaults to 120).

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setWheelIncrement [line 371]

PhpExt_TabPanel setWheelIncrement(
integer
$value 
)

For scrolling tabs, the number of pixels to increment on mouse wheel scrolling (defaults to 20).

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

Constants

TAB_POSITON_BOTTOM = 'bottom' [line 29]

[ Top ]

TAB_POSITON_TOP = 'top' [line 28]

[ Top ]

Documentation generated on Fri, 08 Aug 2008 16:00:56 -0500 by phpDocumentor 1.4.0