Adianti Solutions

Class TDataGrid

Description

DataGrid Widget: Allows to create datagrids with rows, columns and actions

author: Pablo Dall'Oglio
version: 7.4
copyright: Copyright (c) 2006 Adianti Solutions Ltd. (http://www.adianti.com.br)
license: http://www.adianti.com.br/framework-license

Located in /widget/datagrid/TDataGrid.php (line 28)

TElement
   |
   --TTable
      |
      --TDataGrid

Direct descendents

Class	Description
TQuickGrid	Create quick datagrids through its simple interface

Variable Summary

mixed $actions

mixed $actionSide

mixed $actionWidth

mixed $action_groups

mixed $columns

mixed $columnValues

mixed $defaultClick

mixed $groupColumn

mixed $groupContent

mixed $groupCount

mixed $groupMask

mixed $groupRowCount

mixed $hasInlineEditing

mixed $hasTotalFunction

mixed $height

mixed $hiddenFields

mixed $HTMLOutputConversion

mixed $modelCreated

mixed $mutationAction

mixed $objects

mixed $outputData

mixed $pageNavigation

mixed $popcondition

mixed $popcontent

mixed $popover

mixed $popside

mixed $poptitle

mixed $prependRows

mixed $rowcount

mixed $scrollable

mixed $searchAttributes

mixed $tbody

mixed $tfoot

mixed $thead

Method Summary

static appendRow ($table_id, $row)

static removeRowById ($table_id, $id)

static replaceRowById ($table_id, $id, $row)

__construct ()

addAction ($action, [$label = null], [$image = null])

addActionGroup ($object)

addColumn ($object, [$action = null])

addItem ($object)

addItems ($objects)

clear ([$preserveHeader = TRUE], [$rows = 0])

createModel ([$create_header = true])

disableDefaultClick ()

disableHtmlConversion ()

enablePopover ($title, $content, [$popside = null], [$popcondition = null])

enableSearch ($input, $attributes)

generateHiddenFields ()

getBody ()

getColumns ()

getHead ()

getHeight ()

getItems ()

getOutputData ()

getPageNavigation ()

getRow ($position)

getRowIndex ($attribute, $value)

getTotalColumns ()

getWidth ()

insert ($position, $content)

isScrollable ()

makeScrollable ()

prepareForPrinting ()

prependRow ($row)

setActionSide ($side)

setActionWidth ($width)

setGroupColumn ($column, $mask)

setHeight ($height)

setId ($id)

setMutationAction ($action)

setPageNavigation ($pageNavigation)

setSearchAttributes ($attributes)

show ()

Variables

mixed $actions (line 31)

access: protected

mixed $actionSide (line 62)

access: protected

mixed $actionWidth (line 51)

access: protected

mixed $action_groups (line 32)

access: protected

mixed $columns (line 30)

access: protected

mixed $columnValues (line 54)

access: protected

mixed $defaultClick (line 41)

access: protected

mixed $groupColumn (line 42)

access: protected

mixed $groupContent (line 43)

access: protected

mixed $groupCount (line 52)

access: protected

mixed $groupMask (line 44)

access: protected

mixed $groupRowCount (line 53)

access: protected

mixed $hasInlineEditing (line 60)

access: protected

mixed $hasTotalFunction (line 61)

access: protected

mixed $height (line 37)

access: protected

mixed $hiddenFields (line 58)

access: protected

mixed $HTMLOutputConversion (line 55)

access: protected

mixed $modelCreated (line 39)

access: protected

mixed $mutationAction (line 63)

access: protected

mixed $objects (line 50)

access: protected

mixed $outputData (line 57)

access: protected

mixed $pageNavigation (line 40)

access: protected

mixed $popcondition (line 49)

access: protected

mixed $popcontent (line 48)

access: protected

mixed $popover (line 45)

access: protected

mixed $popside (line 47)

access: protected

mixed $poptitle (line 46)

access: protected

mixed $prependRows (line 59)

access: protected

mixed $rowcount (line 33)

access: protected

mixed $scrollable (line 38)

access: protected

mixed $searchAttributes (line 56)

access: protected

mixed $tbody (line 35)

access: protected

mixed $tfoot (line 36)

access: protected

mixed $thead (line 34)

access: protected

Inherited Variables

Inherited from TElement

TElement::$children

Methods

static appendRow (line 973)

Append table row via Javascript

access: public

static appendRow ($table_id, $row)

$table_id
$row

static removeRowById (line 982)

Remove row by id

access: public

static removeRowById ($table_id, $id)

$table_id
$id

static replaceRowById (line 990)

Replace row by id

access: public

static replaceRowById ($table_id, $id, $row)

$table_id
$id
$row

Constructor __construct (line 68)

Class Constructor

access: public

__construct ()

Redefinition of:

TTable::__construct(): Class Constructor

addAction (line 263)

Add an Action to the DataGrid

access: public

addAction ($action, [$label = null], [$image = null])

$action: A TDataGridAction object
$label
$image

addActionGroup (line 314)

Add an Action Group to the DataGrid

access: public

addActionGroup ($object)

$object: A TDataGridActionGroup object

addColumn (line 232)

Add a Column to the DataGrid

access: public

addColumn ($object, [$action = null])

$object: A TDataGridColumn object
$action

addItem (line 737)

Add an object to the DataGrid

access: public

addItem ($object)

$object: An Active Record Object

addItems (line 593)

Add objects to the DataGrid

access: public

addItems ($objects)

$objects: An array of Objects

clear (line 346)

Clear the DataGrid contents

access: public

clear ([$preserveHeader = TRUE], [$rows = 0])

$preserveHeader
$rows

createModel (line 421)

Creates the DataGrid Structure

access: public

createModel ([$create_header = true])

$create_header

disableDefaultClick (line 199)

disable the default click action

access: public

disableDefaultClick ()

disableHtmlConversion (line 132)

Disable htmlspecialchars on output

access: public

disableHtmlConversion ()

enablePopover (line 150)

Enable popover

access: public

enablePopover ($title, $content, [$popside = null], [$popcondition = null])

$title: Title
$content: Content
$popside
$popcondition

enableSearch (line 1206)

Enable fuse search

access: public

enableSearch ($input, $attributes)

$input: Field input for search
$attributes: Attribute name

generateHiddenFields (line 124)

Generate hidden fields

access: public

generateHiddenFields ()

getBody (line 566)

Return tbody

access: public

getBody ()

getColumns (line 254)

Returns an array of TDataGridColumn

access: public

getColumns ()

getHead (line 558)

Return thead

access: public

getHead ()

getHeight (line 223)

Return datagrid height

access: public

getHeight ()

getItems (line 999)

Return datagrid items

access: public

getItems ()

getOutputData (line 140)

Get raw processed output data

access: public

getOutputData ()

getPageNavigation (line 1188)

Return the assigned PageNavigation object

return: object
access: public

getPageNavigation ()

getRow (line 1140)

Return the row by position

access: public

getRow ($position)

$position: Row position

getRowIndex (line 1124)

Find the row index by object attribute

access: public

getRowIndex ($attribute, $value)

$attribute: Object attribute
$value: Object value

getTotalColumns (line 329)

Returns the total columns

access: public

getTotalColumns ()

getWidth (line 1149)

Returns the DataGrid's width

return: integer containing the DataGrid's width
access: public

getWidth ()

insert (line 584)

insert content

access: public

insert ($position, $content)

$position
$content

Redefinition of:

TElement::insert(): Insert an child element

isScrollable (line 175)

Returns if datagrid is scrollable

access: public

isScrollable ()

makeScrollable (line 162)

Make the datagrid scrollable

access: public

makeScrollable ()

prepareForPrinting (line 293)

Prepare for printing

access: public

prepareForPrinting ()

prependRow (line 574)

Prepend row

access: public

prependRow ($row)

$row

setActionSide (line 116)

Set actions side

access: public

setActionSide ($side)

$side

setActionWidth (line 191)

Set the column action width

access: public

setActionWidth ($width)

$width

setGroupColumn (line 337)

Set the group column for break

access: public

setGroupColumn ($column, $mask)

$column
$mask

setHeight (line 208)

Define the Height

access: public

setHeight ($height)

$height: An integer containing the height

setId (line 100)

Set id

access: public

setId ($id)

setMutationAction (line 108)

Define mutation action

access: public

setMutationAction ($action)

$action

setPageNavigation (line 1179)

Assign a PageNavigation object

access: public

setPageNavigation ($pageNavigation)

$pageNavigation: object

setSearchAttributes (line 1196)

Set serach attributes

access: public

setSearchAttributes ($attributes)

$attributes

show (line 1235)

Shows the DataGrid

access: public

show ()

Redefinition of:

TElement::show(): Shows the tag

Inherited Methods

Inherited From TTable

TTable::__construct()
TTable::addRow()
TTable::addRowSet()
TTable::addSection()
TTable::create()
TTable::fromData()

Inherited From TElement

TElement::__construct()
TElement::add()
TElement::after()
TElement::clearChildren()
TElement::close()
TElement::closeTag()
TElement::del()
TElement::find()
TElement::get()
TElement::getAfterElement()
TElement::getChildren()
TElement::getContents()
TElement::getIsWrapped()
TElement::getName()
TElement::getProperties()
TElement::getProperty()
TElement::hide()
TElement::insert()
TElement::open()
TElement::openTag()
TElement::setIsWrapped()
TElement::setName()
TElement::setProperties()
TElement::setProperty()
TElement::setUseLineBreaks()
TElement::setUseSingleQuotes()
TElement::show()
TElement::tag()
TElement::__clone()
TElement::__get()
TElement::__isset()
TElement::__set()
TElement::__toString()
TElement::__unset()

Adianti Solutions

API

Class TDataGrid

Inherited Variables

Inherited Methods