Class: PhpExt_Grid_GridPanel

Source Location: /PhpExt/Grid/GridPanel.php

Class PhpExt_Grid_GridPanel

Class Overview

This class represents the primary interface of a component based grid control.

Usage:

var grid = new Ext.grid.GridPanel({
store: new Ext.data.Store({
reader: reader,
data: xg.dummyData
}),
columns: [
{id:'company', header: "Company", width: 200, sortable: true, dataIndex: 'company'},
{header: "Price", width: 120, sortable: true, renderer: Ext.util.Format.usMoney, dataIndex: 'price'},
{header: "Change", width: 120, sortable: true, dataIndex: 'change'},
{header: "% Change", width: 120, sortable: true, dataIndex: 'pctChange'},
{header: "Last Updated", width: 135, sortable: true, renderer: Ext.util.Format.dateRenderer('m/d/Y'), dataIndex: 'lastChange'}
],
viewConfig: {
forceFit: true
},
sm: new Ext.grid.RowSelectionModel({singleSelect:true}),
width:600,
height:300,
frame:true,
title:'Framed with Checkbox Selection and Horizontal Scrolling',
iconCls:'icon-grid'
});

Note: Although this class inherits many configuration options from base classes, some of them (such as autoScroll, layout, items, etc) won't function as they do with the base Panel class.

To access the data in a Grid, it is necessary to use the data model encapsulated by the Store.

Located in /PhpExt/Grid/GridPanel.php [line 71]

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

Properties

$_columnModel

Methods

[ Top ]

Descendants

Child Class	Description
PhpExt_Grid_EditorGridPanel

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

Property Summary

PhpExt_Grid_ColumnModel

$_columnModel

[ Top ]

Method Summary

PhpExt_Grid_GridPanel	__construct()
string	getAutoExpandColumn()	The id of a column in this grid that should expand to fill unused space. This id can not be 0.
integer	getAutoExpandMax()	The maximum width the autoExpandColumn can have (if enabled). Defaults to 1000.
integer	getAutoExpandMin()	The minimum width the autoExpandColumn can have (if enabled). defaults to 50.
PhpExt_Grid_ColumnModel	getColumnModel()	The PhpExt_Grid_ColumnModel to use when rendering the grid (required).
boolean	getDisableSelection()	True to disable selections in the grid (defaults to false). - ignored a SelectionModel is specified
boolean	getEnableColumnHide()	True to enable hiding of columns with the header context menu.
boolean	getEnableColumnMove()	True to enable drag and drop reorder of columns.
boolean	getEnableColumnResize()	False to turn off column resizing for the whole grid (defaults to true).
boolean	getEnableDragDrop()	True to enable drag and drop of rows.
boolean	getEnableHeaderMenu()	True to enable the drop down button for menu in the headers.
boolean	getEnableRowHeightSync()	True to manually sync row heights across locked and not locked rows.
PhpExt_LoadMask\|boolean	getLoadMask()	An PhpExt_LoadMask object or true to mask the grid while loading (defaults to false).
integer	getMaxHeight()	Sets the maximum height of the grid - ignored if autoHeight is not on.
integer	getMinColumnWidth()	The minimum width a column can be resized to. Defaults to 25.
boolean	getMonitorWindowResize()	True to autoSize the grid when the window resizes. Defaults to true.
PhpExt_Grid_AbstractSelectionModel	getSelectionModel()	Any subclass of PhpExt_Grid_AbstractSelectionModel that will provide the selection model for the grid (defaults to PhpExt_Grid_RowSelectionModel if not specified).
PhpExt_Data_Store	getStore()	The PhpExt_Data_Store the grid should use as its data source (required).
boolean	getStripeRows()	True to stripe the rows. Default is false.
boolean	getTrackMouseOver()	True to highlight rows when the mouse is over. Default is true.
PhpExt_Grid_GridView	getView()	The PhpExt_Grid_GridView used by the grid. This can be set before a call to render().
PhpExt_Grid_GridPanel	setAutoExpandColumn()	The id of a column in this grid that should expand to fill unused space. This id can not be 0.
PhpExt_Grid_GridPanel	setAutoExpandMax()	The maximum width the autoExpandColumn can have (if enabled). Defaults to 1000.
PhpExt_Grid_GridPanel	setAutoExpandMin()	The minimum width the autoExpandColumn can have (if enabled). defaults to 50.
PhpExt_Grid_GridPanel	setColumnModel()	The PhpExt_Grid_ColumnModel to use when rendering the grid (required).
PhpExt_Grid_GridPanel	setDisableSelection()	True to disable selections in the grid (defaults to false). - ignored a SelectionModel is specified
PhpExt_Grid_GridPanel	setEnableColumnHide()	True to enable hiding of columns with the header context menu.
PhpExt_Grid_GridPanel	setEnableColumnMove()	True to enable drag and drop reorder of columns.
PhpExt_Grid_GridPanel	setEnableColumnResize()	False to turn off column resizing for the whole grid (defaults to true).
PhpExt_Grid_GridPanel	setEnableDragDrop()	True to enable drag and drop of rows.
PhpExt_Grid_GridPanel	setEnableHeaderMenu()	True to enable the drop down button for menu in the headers.
PhpExt_Grid_GridPanel	setEnableRowHeightSync()	True to manually sync row heights across locked and not locked rows.
PhpExt_Grid_GridPanel	setLoadMask()	An PhpExt_LoadMask object or true to mask the grid while loading (defaults to false).
PhpExt_Grid_GridPanel	setMaxHeight()	Sets the maximum height of the grid - ignored if autoHeight is not on.
PhpExt_Grid_GridPanel	setMinColumnWidth()	The minimum width a column can be resized to. Defaults to 25.
PhpExt_Grid_GridPanel	setMonitorWindowResize()	True to autoSize the grid when the window resizes. Defaults to true.
PhpExt_Grid_GridPanel	setSelectionModel()	Any subclass of PhpExt_Grid_AbstractSelectionModel that will provide the selection model for the grid (defaults to PhpExt_Grid_RowSelectionModel if not specified).
PhpExt_Grid_GridPanel	setStore()	The PhpExt_Data_Store the grid should use as its data source (required).
PhpExt_Grid_GridPanel	setStripeRows()	True to stripe the rows. Default is false.
PhpExt_Grid_GridPanel	setTrackMouseOver()	True to highlight rows when the mouse is over. Default is true.
PhpExt_Grid_GridPanel	setView()	The PhpExt_Grid_GridView used by the grid. This can be set before a call to render().

[ Top ]

Properties

PhpExt_Grid_ColumnModel $_columnModel = null [line 131]

API Tags:

Access:

public

[ Top ]

Methods

Constructor __construct [line 444]

PhpExt_Grid_GridPanel __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Panel::__construct()

Redefined in descendants as:

[ Top ]

getAutoExpandColumn [line 87]

string getAutoExpandColumn(
)

The id of a column in this grid that should expand to fill unused space. This id can not be 0.

API Tags:

Access:

public

[ Top ]

getAutoExpandMax [line 105]

integer getAutoExpandMax(
)

The maximum width the autoExpandColumn can have (if enabled). Defaults to 1000.

API Tags:

Access:

public

[ Top ]

getAutoExpandMin [line 123]

integer getAutoExpandMin(
)

The minimum width the autoExpandColumn can have (if enabled). defaults to 50.

API Tags:

Access:

public

[ Top ]

getColumnModel [line 146]

PhpExt_Grid_ColumnModel getColumnModel(
)

The PhpExt_Grid_ColumnModel to use when rendering the grid (required).

API Tags:

Access:

public

[ Top ]

getDisableSelection [line 164]

boolean getDisableSelection(
)

True to disable selections in the grid (defaults to false). - ignored a SelectionModel is specified

API Tags:

Access:

public

[ Top ]

getEnableColumnHide [line 182]

boolean getEnableColumnHide(
)

True to enable hiding of columns with the header context menu.

API Tags:

Access:

public

[ Top ]

getEnableColumnMove [line 200]

boolean getEnableColumnMove(
)

True to enable drag and drop reorder of columns.

API Tags:

Access:

public

[ Top ]

getEnableColumnResize [line 218]

boolean getEnableColumnResize(
)

False to turn off column resizing for the whole grid (defaults to true).

API Tags:

Access:

public

[ Top ]

getEnableDragDrop [line 236]

boolean getEnableDragDrop(
)

True to enable drag and drop of rows.

API Tags:

Access:

public

[ Top ]

getEnableHeaderMenu [line 254]

boolean getEnableHeaderMenu(
)

True to enable the drop down button for menu in the headers.

API Tags:

Access:

public

[ Top ]

getEnableRowHeightSync [line 272]

boolean getEnableRowHeightSync(
)

True to manually sync row heights across locked and not locked rows.

API Tags:

Access:

public

[ Top ]

getLoadMask [line 290]

PhpExt_LoadMask|boolean getLoadMask(
)

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

API Tags:

Access:

public

Redefinition of:

PhpExt_Panel::getLoadMask(): The id of the DOM Element which servers as loading mask to show loading messages

[ Top ]

getMaxHeight [line 308]

integer getMaxHeight(
)

Sets the maximum height of the grid - ignored if autoHeight is not on.

API Tags:

Access:

public

[ Top ]

getMinColumnWidth [line 326]

integer getMinColumnWidth(
)

The minimum width a column can be resized to. Defaults to 25.

API Tags:

Access:

public

[ Top ]

getMonitorWindowResize [line 344]

boolean getMonitorWindowResize(
)

True to autoSize the grid when the window resizes. Defaults to true.

API Tags:

Access:

public

[ Top ]

getSelectionModel [line 364]

PhpExt_Grid_AbstractSelectionModel getSelectionModel(
)

Any subclass of PhpExt_Grid_AbstractSelectionModel that will provide the selection model for the grid (defaults to PhpExt_Grid_RowSelectionModel if not specified).

API Tags:

Access:

public

[ Top ]

getStore [line 382]

PhpExt_Data_Store getStore(
)

The PhpExt_Data_Store the grid should use as its data source (required).

API Tags:

Access:

public

[ Top ]

getStripeRows [line 400]

boolean getStripeRows(
)

True to stripe the rows. Default is false.

API Tags:

Access:

public

[ Top ]

getTrackMouseOver [line 418]

boolean getTrackMouseOver(
)

True to highlight rows when the mouse is over. Default is true.

API Tags:

Access:

public

[ Top ]

getView [line 440]

PhpExt_Grid_GridView getView(
)

The PhpExt_Grid_GridView used by the grid. This can be set before a call to render().

API Tags:

See:	PhpExt_Grid_GridView
See:	PhpExt_Grid_GroupingView
Access:	public

[ Top ]

setAutoExpandColumn [line 79]

PhpExt_Grid_GridPanel setAutoExpandColumn(
string
$value 
)

The id of a column in this grid that should expand to fill unused space. This id can not be 0.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setAutoExpandMax [line 97]

PhpExt_Grid_GridPanel setAutoExpandMax(
integer
$value 
)

The maximum width the autoExpandColumn can have (if enabled). Defaults to 1000.

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setAutoExpandMin [line 115]

PhpExt_Grid_GridPanel setAutoExpandMin(
integer
$value 
)

The minimum width the autoExpandColumn can have (if enabled). defaults to 50.

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setColumnModel [line 137]

PhpExt_Grid_GridPanel setColumnModel(
PhpExt_Grid_ColumnModel
$value 
)

The PhpExt_Grid_ColumnModel to use when rendering the grid (required).

Parameters:

PhpExt_Grid_ColumnModel

$value:

API Tags:

Access:

public

[ Top ]

setDisableSelection [line 156]

PhpExt_Grid_GridPanel setDisableSelection(
boolean
$value 
)

True to disable selections in the grid (defaults to false). - ignored a SelectionModel is specified

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setEnableColumnHide [line 174]

PhpExt_Grid_GridPanel setEnableColumnHide(
boolean
$value 
)

True to enable hiding of columns with the header context menu.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setEnableColumnMove [line 192]

PhpExt_Grid_GridPanel setEnableColumnMove(
boolean
$value 
)

True to enable drag and drop reorder of columns.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setEnableColumnResize [line 210]

PhpExt_Grid_GridPanel setEnableColumnResize(
boolean
$value 
)

False to turn off column resizing for the whole grid (defaults to true).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setEnableDragDrop [line 228]

PhpExt_Grid_GridPanel setEnableDragDrop(
boolean
$value 
)

True to enable drag and drop of rows.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setEnableHeaderMenu [line 246]

PhpExt_Grid_GridPanel setEnableHeaderMenu(
boolean
$value 
)

True to enable the drop down button for menu in the headers.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setEnableRowHeightSync [line 264]

PhpExt_Grid_GridPanel setEnableRowHeightSync(
boolean
$value 
)

True to manually sync row heights across locked and not locked rows.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setLoadMask [line 282]

PhpExt_Grid_GridPanel setLoadMask(
PhpExt_LoadMask|boolean
$value 
)

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

Parameters:

PhpExt_LoadMask|boolean

$value:

API Tags:

Access:

public

Redefinition of:

PhpExt_Panel::setLoadMask(): The id of the DOM Element which servers as loading mask to show loading messages

[ Top ]

setMaxHeight [line 300]

PhpExt_Grid_GridPanel setMaxHeight(
integer
$value 
)

Sets the maximum height of the grid - ignored if autoHeight is not on.

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setMinColumnWidth [line 318]

PhpExt_Grid_GridPanel setMinColumnWidth(
integer
$value 
)

The minimum width a column can be resized to. Defaults to 25.

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

setMonitorWindowResize [line 336]

PhpExt_Grid_GridPanel setMonitorWindowResize(
boolean
$value 
)

True to autoSize the grid when the window resizes. Defaults to true.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setSelectionModel [line 355]

PhpExt_Grid_GridPanel setSelectionModel(
PhpExt_Grid_AbstractSelectionModel
$value 
)

Any subclass of PhpExt_Grid_AbstractSelectionModel that will provide the selection model for the grid (defaults to PhpExt_Grid_RowSelectionModel if not specified).

Parameters:

PhpExt_Grid_AbstractSelectionModel

$value:

API Tags:

Access:

public

[ Top ]

setStore [line 374]

PhpExt_Grid_GridPanel setStore(
PhpExt_Data_Store
$value 
)

The PhpExt_Data_Store the grid should use as its data source (required).

Parameters:

PhpExt_Data_Store

$value:

API Tags:

Access:

public

[ Top ]

setStripeRows [line 392]

PhpExt_Grid_GridPanel setStripeRows(
boolean
$value 
)

True to stripe the rows. Default is false.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setTrackMouseOver [line 410]

PhpExt_Grid_GridPanel setTrackMouseOver(
boolean
$value 
)

True to highlight rows when the mouse is over. Default is true.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setView [line 430]

PhpExt_Grid_GridPanel setView(
PhpExt_Grid_GridView
$value 
)

The PhpExt_Grid_GridView used by the grid. This can be set before a call to render().

Parameters:

PhpExt_Grid_GridView

$value:

API Tags:

See:	PhpExt_Grid_GridView
See:	PhpExt_Grid_GroupingView
Access:	public

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:54:37 -0500 by phpDocumentor 1.4.0