Class: PhpExt_Grid_CheckboxSelectionModel

Source Location: /PhpExt/Grid/CheckboxSelectionModel.php

Class PhpExt_Grid_CheckboxSelectionModel

Class Overview

Implements interfaces:

PhpExt_Grid_IColumn

A custom selection model that renders a column of checkboxes that can be toggled to select or deselect rows.

Located in /PhpExt/Grid/CheckboxSelectionModel.php [line 29]

PhpExt_Object
   |
   --PhpExt_Observable
      |
      --PhpExt_Grid_AbstractSelectionModel
         |
         --PhpExt_Grid_RowSelectionModel
            |
            --PhpExt_Grid_CheckboxSelectionModel

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_RowSelectionModel

PhpExt_Grid_RowSelectionModel::__construct()

PhpExt_Grid_RowSelectionModel::getSingleSelect()

True to allow selection of only one row at a time (defaults to false)

PhpExt_Grid_RowSelectionModel::setSingleSelect()

True to allow selection of only one row at a time (defaults to false)

Inherited From PhpExt_Grid_AbstractSelectionModel

PhpExt_Grid_AbstractSelectionModel::__construct()

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_CheckboxSelectionModel	__construct()
string	getHeader()	Any valid text or HTML fragment to display in the header cell for the checkbox column (defaults to '<div class="x-grid3-hd-checker"> </div>'). The default CSS class of 'x-grid3-hd-checker' displays a checkbox in the header and provides support for automatic check all/none behavior on header click. This string can be replaced by any valid HTML fragment, including a simple text string (e.g., 'Select Rows'), but the automatic check all/none behavior will only work if the 'x-grid3-hd-checker' class is supplied.
boolean	getSortable()	True if the checkbox column is sortable (defaults to false).
integer	getWidth()	The default width in pixels of the checkbox column (defaults to 20).
PhpExt_Grid_CheckboxSelectionModel	setHeader()	Any valid text or HTML fragment to display in the header cell for the checkbox column (defaults to '<div class="x-grid3-hd-checker"> </div>'). The default CSS class of 'x-grid3-hd-checker' displays a checkbox in the header and provides support for automatic check all/none behavior on header click. This string can be replaced by any valid HTML fragment, including a simple text string (e.g., 'Select Rows'), but the automatic check all/none behavior will only work if the 'x-grid3-hd-checker' class is supplied.
PhpExt_Grid_CheckboxSelectionModel	setSortable()	True if the checkbox column is sortable (defaults to false).
PhpExt_Grid_CheckboxSelectionModel	setWidth()	The default width in pixels of the checkbox column (defaults to 20).

[ Top ]

Properties

Methods

Constructor __construct [line 86]

PhpExt_Grid_CheckboxSelectionModel __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Grid_RowSelectionModel::__construct()

[ Top ]

getHeader [line 45]

string getHeader(
)

Any valid text or HTML fragment to display in the header cell for the checkbox column (defaults to '<div class="x-grid3-hd-checker"> </div>'). The default CSS class of 'x-grid3-hd-checker' displays a checkbox in the header and provides support for automatic check all/none behavior on header click. This string can be replaced by any valid HTML fragment, including a simple text string (e.g., 'Select Rows'), but the automatic check all/none behavior will only work if the 'x-grid3-hd-checker' class is supplied.

API Tags:

Access:

public

[ Top ]

getSortable [line 63]

boolean getSortable(
)

True if the checkbox column is sortable (defaults to false).

API Tags:

Access:

public

[ Top ]

getWidth [line 81]

integer getWidth(
)

The default width in pixels of the checkbox column (defaults to 20).

API Tags:

Access:

public

[ Top ]

setHeader [line 37]

PhpExt_Grid_CheckboxSelectionModel setHeader(
string
$value 
)

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setSortable [line 55]

PhpExt_Grid_CheckboxSelectionModel setSortable(
boolean
$value 
)

True if the checkbox column is sortable (defaults to false).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setWidth [line 73]

PhpExt_Grid_CheckboxSelectionModel setWidth(
integer
$value 
)

The default width in pixels of the checkbox column (defaults to 20).

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

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