Class: PhpExt_Grid_ColumnConfigObject

Source Location: /PhpExt/Grid/ColumnConfigObject.php

Class PhpExt_Grid_ColumnConfigObject

Class Overview

Implements interfaces:

PhpExt_Grid_IColumn

Located in /PhpExt/Grid/ColumnConfigObject.php [line 27]

PhpExt_Object
   |
   --PhpExt_Config_ConfigObject
      |
      --PhpExt_Grid_ColumnConfigObject

Methods

[ Top ]

Descendants

Child Class	Description
PhpExtUx_Grid_CheckColumn

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From PhpExt_Config_ConfigObject

PhpExt_Config_ConfigObject::$_options

Inherited From PhpExt_Object

PhpExt_Object::$_extClassName

PhpExt_Object::$_extConfigProperties

PhpExt_Object::$_validExtConfigProperties

PhpExt_Object::$_varName

Inherited From PhpExt_Config_ConfigObject

PhpExt_Config_ConfigObject::__construct()

PhpExt_Config_ConfigObject::getJavascript()

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

static PhpExt_Data_ColumnConfigObject	createColumn()	Helper function to create a ColumnConfigObject
PhpExt_Grid_ColumnConfigObject	__construct()
string	getAlign()	(optional) Set the CSS text-align property of the column. Defaults to undefined.
string	getDataIndex()	(optional) The name of the field in the grid's Ext.data.Store's Ext.data.Record definition from which to draw the column's value. If not specified, the column's index is used as an index into the Record's data Array.
PhpExt_Form_Field	getEditor()	(optional) The Ext.form.Field to use when editing values in this column if editing is supported by the grid.
boolean	getFixed()	(optional) True if the column width cannot be changed. Defaults to false.
string	getHeader()	The header text to display in the Grid view.
boolean	getHidden()	(optional) True to hide the column. Defaults to false.
boolean	getHideable()	(optional) Specify as false to prevent the user from hiding this column. Defaults to true.
string	getId()
boolean	getLocked()	False if the column's position can be changed by the user
PhpExt_JavascriptStm\|PhpExt_Object	getRenderer()
boolean	getResizable()	(optional) False to disable column resizing. Defaults to true.
boolean	getSortable()	(optional) True if sorting is to be allowed on this column. Defaults to the value of the defaultSortable property. Whether local/remote sorting is used is specified in Ext.data.Store.remoteSort.
integer	getWidth()	(optional) The initial width in pixels of the column. Using this instead of Ext.grid.Grid.autoSizeColumns is more efficient.
PhpExt_Grid_ColumnConfigObject	setAlign()	(optional) Set the CSS text-align property of the column. Defaults to undefined.
PhpExt_Grid_ColumnConfigObject	setDataIndex()	(optional) The name of the field in the grid's Ext.data.Store's Ext.data.Record definition from which to draw the column's value. If not specified, the column's index is used as an index into the Record's data Array.
PhpExt_Grid_ColumnConfigObject	setEditor()	(optional) The Ext.form.Field to use when editing values in this column if editing is supported by the grid.
PhpExt_Grid_ColumnConfigObject	setFixed()	(optional) True if the column width cannot be changed. Defaults to false.
PhpExt_Grid_ColumnConfigObject	setHeader()	The header text to display in the Grid view.
PhpExt_Grid_ColumnConfigObject	setHidden()	(optional) True to hide the column. Defaults to false.
PhpExt_Grid_ColumnConfigObject	setHideable()	(optional) Specify as false to prevent the user from hiding this column. Defaults to true.
PhpExt_Grid_ColumnConfigObject	setId()	(optional) Defaults to the column's initial ordinal position. A name which identifies this column. The id is used to create a CSS class name which is applied to all table cells (including headers) in that column.
PhpExt_Grid_ColumnConfigObject	setLocked()	False if the column's position can be changed by the user
PhpExt_Grid_ColumnConfigObject	setRenderer()	(optional) A function used to generate HTML markup for a cell given the cell's data value. If not specified, the default renderer uses the raw data value.
PhpExt_Grid_ColumnConfigObject	setResizable()	(optional) False to disable column resizing. Defaults to true.
PhpExt_Grid_ColumnConfigObject	setSortable()	(optional) True if sorting is to be allowed on this column. Defaults to the value of the defaultSortable property. Whether local/remote sorting is used is specified in Ext.data.Store.remoteSort.
PhpExt_Grid_ColumnConfigObject	setWidth()	(optional) The initial width in pixels of the column. Using this instead of Ext.grid.Grid.autoSizeColumns is more efficient.

[ Top ]

Properties

Methods

static method createColumn [line 326]

static PhpExt_Data_ColumnConfigObject createColumn(
string
$header, [string|integer
$dataIndex = null], [string
$id = null], [integer
$width = null], [string
$align = null], [PhpExt_JavascriptStm
$renderer = null], [boolean
$sortable = null], [
$locked = null] 
)

Helper function to create a ColumnConfigObject

Parameters:

string	$header:
string\|integer	$dataIndex:
string	$id:
integer	$width:
string	$align:
PhpExt_JavascriptStm	$renderer:
boolean	$sortable:
	$locked:

API Tags:

Access:

public

[ Top ]

Constructor __construct [line 291]

PhpExt_Grid_ColumnConfigObject __construct(

$header 
)

Parameters:

$header:

API Tags:

Access:

public

Redefinition of:

PhpExt_Config_ConfigObject::__construct()

Redefined in descendants as:

PhpExtUx_Grid_CheckColumn::__construct()

[ Top ]

getAlign [line 43]

string getAlign(
)

(optional) Set the CSS text-align property of the column. Defaults to undefined.

API Tags:

Access:

public

[ Top ]

getDataIndex [line 61]

string getDataIndex(
)

(optional) The name of the field in the grid's Ext.data.Store's Ext.data.Record definition from which to draw the column's value. If not specified, the column's index is used as an index into the Record's data Array.

API Tags:

Access:

public

[ Top ]

getEditor [line 79]

PhpExt_Form_Field getEditor(
)

(optional) The Ext.form.Field to use when editing values in this column if editing is supported by the grid.

API Tags:

Access:

public

[ Top ]

getFixed [line 97]

boolean getFixed(
)

(optional) True if the column width cannot be changed. Defaults to false.

API Tags:

Access:

public

[ Top ]

getHeader [line 115]

string getHeader(
)

The header text to display in the Grid view.

API Tags:

Access:

public

[ Top ]

getHidden [line 133]

boolean getHidden(
)

(optional) True to hide the column. Defaults to false.

API Tags:

Access:

public

[ Top ]

getHideable [line 151]

boolean getHideable(
)

(optional) Specify as false to prevent the user from hiding this column. Defaults to true.

API Tags:

Access:

public

[ Top ]

getId [line 175]

string getId(
)

API Tags:

Access:

public

[ Top ]

getLocked [line 287]

boolean getLocked(
)

False if the column's position can be changed by the user

API Tags:

Access:

public

[ Top ]

getRenderer [line 215]

PhpExt_JavascriptStm|PhpExt_Object getRenderer(
)

API Tags:

Access:

public

[ Top ]

getResizable [line 233]

boolean getResizable(
)

(optional) False to disable column resizing. Defaults to true.

API Tags:

Access:

public

[ Top ]

getSortable [line 251]

boolean getSortable(
)

(optional) True if sorting is to be allowed on this column. Defaults to the value of the defaultSortable property. Whether local/remote sorting is used is specified in Ext.data.Store.remoteSort.

API Tags:

Access:

public

[ Top ]

getWidth [line 269]

integer getWidth(
)

(optional) The initial width in pixels of the column. Using this instead of Ext.grid.Grid.autoSizeColumns is more efficient.

API Tags:

Access:

public

[ Top ]

setAlign [line 35]

PhpExt_Grid_ColumnConfigObject setAlign(
string
$value 
)

(optional) Set the CSS text-align property of the column. Defaults to undefined.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setDataIndex [line 53]

PhpExt_Grid_ColumnConfigObject setDataIndex(
string
$value 
)

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setEditor [line 71]

PhpExt_Grid_ColumnConfigObject setEditor(
PhpExt_Form_Field
$value 
)

(optional) The Ext.form.Field to use when editing values in this column if editing is supported by the grid.

Parameters:

PhpExt_Form_Field

$value:

API Tags:

Access:

public

[ Top ]

setFixed [line 89]

PhpExt_Grid_ColumnConfigObject setFixed(
boolean
$value 
)

(optional) True if the column width cannot be changed. Defaults to false.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setHeader [line 107]

PhpExt_Grid_ColumnConfigObject setHeader(
string
$value 
)

The header text to display in the Grid view.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setHidden [line 125]

PhpExt_Grid_ColumnConfigObject setHidden(
boolean
$value 
)

(optional) True to hide the column. Defaults to false.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setHideable [line 143]

PhpExt_Grid_ColumnConfigObject setHideable(
boolean
$value 
)

(optional) Specify as false to prevent the user from hiding this column. Defaults to true.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setId [line 167]

PhpExt_Grid_ColumnConfigObject setId(
string
$value 
)

(optional) Defaults to the column's initial ordinal position. A name which identifies this column. The id is used to create a CSS class name which is applied to all table cells (including headers) in that column.

The class name takes the form of: 'x-grid3-td-id'

Header cells will also recieve this class name, but will also have the class x-grid3-hd, so to target header cells, use CSS selectors such as: '.x-grid3-hd.x-grid3-td-id'

The Ext.grid.Grid.autoExpandColumn grid config option references the column via this identifier.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setLocked [line 279]

PhpExt_Grid_ColumnConfigObject setLocked(
boolean
$value 
)

False if the column's position can be changed by the user

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setRenderer [line 207]

PhpExt_Grid_ColumnConfigObject setRenderer(
PhpExt_JavascriptStm|PhpExt_Object
$value 
)

(optional) A function used to generate HTML markup for a cell given the cell's data value. If not specified, the default renderer uses the raw data value.

The render function is called with the following parameters: <dl> <dt>value : Object</dt> <dd>The data value for the cell.</dd> <dt>metadata : Object <dd>An object in which you may set the following attributes: <dl> <dt>css : String</dt> <dd>A CSS class name to add to the cell's TD element.</dd> <dt>attr : String</dt> <dd>An HTML attribute definition string to apply to the data container element within the table cell (e.g. 'style="color:red;"').</dd> </dd> <dt>record : Ext.data.record</dt> <dd>The Ext.data.Record from which the data was extracted.</dd> <dt>rowIndex : Number</dt> <dd>Row index</dd> <dt>colIndex : Number</dt> <dd>Column index</dd> <dt>store : Ext.data.Store</dt> <dd>The Ext.data.Store object from which the Record was extracted.</dd> </dl>

Parameters:

PhpExt_JavascriptStm|PhpExt_Object

$value:

API Tags:

Access:

public

[ Top ]

setResizable [line 225]

PhpExt_Grid_ColumnConfigObject setResizable(
boolean
$value 
)

(optional) False to disable column resizing. Defaults to true.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setSortable [line 243]

PhpExt_Grid_ColumnConfigObject setSortable(
boolean
$value 
)

(optional) True if sorting is to be allowed on this column. Defaults to the value of the defaultSortable property. Whether local/remote sorting is used is specified in Ext.data.Store.remoteSort.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setWidth [line 261]

PhpExt_Grid_ColumnConfigObject setWidth(
integer
$value 
)

(optional) The initial width in pixels of the column. Using this instead of Ext.grid.Grid.autoSizeColumns is more efficient.

Parameters:

integer

$value:

API Tags:

Access:

public

[ Top ]

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