Class: PhpExt_Grid_GroupingView

Source Location: /PhpExt/Grid/GroupingView.php

Class PhpExt_Grid_GroupingView

Class Overview

Adds the ability for single level grouping to the grid.

Example:

// A groupingStore is required for a GroupingView
$grpStore = new PhpExt_Data_GroupingStore();
$grpStore->setReader($reader)
->setData($dummyData)
->setGroupField('industry');
$grpView = new PhpExt_Grid_GroupingView();
// custom grouping text template to display the number of items per group
$grpView->setForceFit(true)
->setGroupTextTemplate('{text} ({[values.rs.length]} {[values.rs.length > 1 ? "Items" : "Item"]})');
// Set grouping required properties
$grid = new PhpExt_Grid_GridPanel();
$grid->setStore($grpStore);
->setView($grpView);

Located in /PhpExt/Grid/GroupingView.php [line 44]

PhpExt_Object
   |
   --PhpExt_Observable
      |
      --PhpExt_Grid_GridView
         |
         --PhpExt_Grid_GroupingView

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

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_Grid_GridView

PhpExt_Grid_GridView::__construct()

PhpExt_Grid_GridView::getAutoFill()

True to auto expand the columns to fit the grid when the grid is created.

PhpExt_Grid_GridView::getEmptyText()

Default text to display in the grid body when no rows are available (defaults to '').

PhpExt_Grid_GridView::getEnableRowBody()

True to add a second TR element per row that can be used to provide a row body that spans beneath the data row. Use the getRowClass method's rowParams config to customize the row body.

PhpExt_Grid_GridView::getForceFit()

True to auto expand/contract the size of the columns to fit the grid width and prevent horizontal scrolling.

PhpExt_Grid_GridView::setAutoFill()

True to auto expand the columns to fit the grid when the grid is created.

PhpExt_Grid_GridView::setEmptyText()

Default text to display in the grid body when no rows are available (defaults to '').

PhpExt_Grid_GridView::setEnableRowBody()

True to add a second TR element per row that can be used to provide a row body that spans beneath the data row. Use the getRowClass method's rowParams config to customize the row body.

PhpExt_Grid_GridView::setForceFit()

True to auto expand/contract the size of the columns to fit the grid width and prevent horizontal scrolling.

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

[ Top ]

Method Summary

PhpExt_Grid_GroupingView	__construct()
string	getEmptyGroupText()	The text to display when there is an empty group value
boolean	getEnableGrouping()	False to disable grouping functionality (defaults to true)
boolean	getEnableGroupingMenu()	True to enable the grouping control in the column menu
boolean	getEnableNoGroups()	True to allow the user to turn off grouping
string	getGroupByText()	Text displayed in the grid header menu for grouping by a column (defaults to 'Group By This Field').
string	getGroupTextTemplate()	The template used to render the group text
boolean	getHideGroupedColumn()	True to hide the column that is currently grouped
boolean	getIgnoreAdd()	True to skip refreshing the view when new rows are added (defaults to false)
boolean	getShowGroupName()	True to display the name for each set of grouped rows (defaults to false)
string	getShowGroupsText()	Text displayed in the grid header for enabling/disabling grouping (defaults to 'Show in Groups').
boolean	getStartCollapsed()	True to start all groups collapsed
PhpExt_Grid_GroupingView	setEmptyGroupText()	The text to display when there is an empty group value
PhpExt_Grid_GroupingView	setEnableGrouping()	False to disable grouping functionality (defaults to true)
PhpExt_Grid_GroupingView	setEnableGroupingMenu()	True to enable the grouping control in the column menu
PhpExt_Grid_GroupingView	setEnableNoGroups()	True to allow the user to turn off grouping
PhpExt_Grid_GroupingView	setGroupByText()	Text displayed in the grid header menu for grouping by a column (defaults to 'Group By This Field').
PhpExt_Grid_GroupingView	setGroupTextTemplate()	The template used to render the group text
PhpExt_Grid_GroupingView	setHideGroupedColumn()	True to hide the column that is currently grouped
PhpExt_Grid_GroupingView	setIgnoreAdd()	True to skip refreshing the view when new rows are added (defaults to false)
PhpExt_Grid_GroupingView	setShowGroupName()	True to display the name for each set of grouped rows (defaults to false)
PhpExt_Grid_GroupingView	setShowGroupsText()	Text displayed in the grid header for enabling/disabling grouping (defaults to 'Show in Groups').
PhpExt_Grid_GroupingView	setStartCollapsed()	True to start all groups collapsed

[ Top ]

Properties

Methods

Constructor __construct [line 244]

PhpExt_Grid_GroupingView __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Grid_GridView::__construct()

[ Top ]

getEmptyGroupText [line 60]

string getEmptyGroupText(
)

The text to display when there is an empty group value

API Tags:

Access:

public

[ Top ]

getEnableGrouping [line 78]

boolean getEnableGrouping(
)

False to disable grouping functionality (defaults to true)

API Tags:

Access:

public

[ Top ]

getEnableGroupingMenu [line 96]

boolean getEnableGroupingMenu(
)

True to enable the grouping control in the column menu

API Tags:

Access:

public

[ Top ]

getEnableNoGroups [line 114]

boolean getEnableNoGroups(
)

True to allow the user to turn off grouping

API Tags:

Access:

public

[ Top ]

getGroupByText [line 132]

string getGroupByText(
)

Text displayed in the grid header menu for grouping by a column (defaults to 'Group By This Field').

API Tags:

Access:

public

[ Top ]

getGroupTextTemplate [line 150]

string getGroupTextTemplate(
)

The template used to render the group text

API Tags:

Access:

public

[ Top ]

getHideGroupedColumn [line 168]

boolean getHideGroupedColumn(
)

True to hide the column that is currently grouped

API Tags:

Access:

public

[ Top ]

getIgnoreAdd [line 186]

boolean getIgnoreAdd(
)

True to skip refreshing the view when new rows are added (defaults to false)

API Tags:

Access:

public

[ Top ]

getShowGroupName [line 204]

boolean getShowGroupName(
)

True to display the name for each set of grouped rows (defaults to false)

API Tags:

Access:

public

[ Top ]

getShowGroupsText [line 222]

string getShowGroupsText(
)

Text displayed in the grid header for enabling/disabling grouping (defaults to 'Show in Groups').

API Tags:

Access:

public

[ Top ]

getStartCollapsed [line 240]

boolean getStartCollapsed(
)

True to start all groups collapsed

API Tags:

Access:

public

[ Top ]

setEmptyGroupText [line 52]

PhpExt_Grid_GroupingView setEmptyGroupText(
string
$value 
)

The text to display when there is an empty group value

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setEnableGrouping [line 70]

PhpExt_Grid_GroupingView setEnableGrouping(
boolean
$value 
)

False to disable grouping functionality (defaults to true)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setEnableGroupingMenu [line 88]

PhpExt_Grid_GroupingView setEnableGroupingMenu(
boolean
$value 
)

True to enable the grouping control in the column menu

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setEnableNoGroups [line 106]

PhpExt_Grid_GroupingView setEnableNoGroups(
boolean
$value 
)

True to allow the user to turn off grouping

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setGroupByText [line 124]

PhpExt_Grid_GroupingView setGroupByText(
string
$value 
)

Text displayed in the grid header menu for grouping by a column (defaults to 'Group By This Field').

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setGroupTextTemplate [line 142]

PhpExt_Grid_GroupingView setGroupTextTemplate(
string
$value 
)

The template used to render the group text

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setHideGroupedColumn [line 160]

PhpExt_Grid_GroupingView setHideGroupedColumn(
boolean
$value 
)

True to hide the column that is currently grouped

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setIgnoreAdd [line 178]

PhpExt_Grid_GroupingView setIgnoreAdd(
boolean
$value 
)

True to skip refreshing the view when new rows are added (defaults to false)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setShowGroupName [line 196]

PhpExt_Grid_GroupingView setShowGroupName(
boolean
$value 
)

True to display the name for each set of grouped rows (defaults to false)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setShowGroupsText [line 214]

PhpExt_Grid_GroupingView setShowGroupsText(
string
$value 
)

Text displayed in the grid header for enabling/disabling grouping (defaults to 'Show in Groups').

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setStartCollapsed [line 232]

PhpExt_Grid_GroupingView setStartCollapsed(
boolean
$value 
)

True to start all groups collapsed

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

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