TQuickGrid
extends TDataGrid
in package
Create quick datagrids through its simple interface
Tags
Table of Contents
Properties
- $action_groups : mixed
- $actions : mixed
- $actionSide : mixed
- $actionWidth : mixed
- $children : mixed
- $columns : mixed
- $columnValues : mixed
- $columnValuesGroup : mixed
- $defaultClick : mixed
- $forPrinting : mixed
- $groupColumn : mixed
- $groupContent : mixed
- $groupCount : mixed
- $groupMask : mixed
- $groupRowCount : mixed
- $groupTotal : mixed
- $groupTransformer : mixed
- $hasInlineEditing : mixed
- $hasTotalFunction : mixed
- $height : mixed
- $hiddenFields : mixed
- $HTMLOutputConversion : mixed
- $modelCreated : mixed
- $mutationAction : mixed
- $objects : mixed
- $objectsGroup : mixed
- $outputData : mixed
- $pageNavigation : mixed
- $pageOrientation : mixed
- $pageSize : mixed
- $popovers : mixed
- $prependRows : mixed
- $rowcount : mixed
- $scrollable : mixed
- $searchAttributes : mixed
- $searchForm : mixed
- $tbody : mixed
- $tfoot : mixed
- $thead : mixed
- $afterElement : mixed
- $hidden : mixed
- $isVoidElement : mixed
- $properties : mixed
- $section : mixed
- $tagname : mixed
- $useLineBreaks : mixed
- $useSingleQuotes : mixed
- $voidelements : mixed
- $wrapped : mixed
Methods
- __clone() : mixed
- Clone the object
- __construct() : mixed
- Class Constructor
- __get() : mixed
- Returns a property's value
- __isset() : mixed
- Returns is a property's is set
- __set() : mixed
- Intercepts whenever someones assign a new property's value
- __toString() : mixed
- Converts the object into a string
- __unset() : mixed
- Intercepts whenever someones unset a property's value
- add() : mixed
- Add an child element
- addAction() : mixed
- Add an Action to the DataGrid
- addActionGroup() : mixed
- Add an Action Group to the DataGrid
- addColumn() : mixed
- Add a Column to the DataGrid
- addItem() : mixed
- Add an object to the DataGrid
- addItems() : mixed
- Add objects to the DataGrid
- addMany() : mixed
- Add many children
- addQuickAction() : mixed
- Add action to the datagrid
- addQuickColumn() : mixed
- Add a column
- addRow() : TTableRow
- Add a new row (TTableRow object) to the table
- addRowSet() : TTableRow
- Add a new row (TTableRow object) with many cells
- addSection() : mixed
- Add section
- after() : mixed
- Insert element after
- appendRow() : mixed
- Append table row via Javascript
- clear() : mixed
- Clear the DataGrid contents
- clearChildren() : mixed
- Clear element children
- close() : mixed
- BC only
- closeTag() : mixed
- Closes the tag
- create() : mixed
- Create a table
- createModel() : mixed
- Creates the DataGrid Structure
- del() : mixed
- Del an child element
- disableDefaultClick() : mixed
- disable the default click action
- disableHtmlConversion() : mixed
- Disable htmlspecialchars on output
- enablePopover() : mixed
- Enable popover
- enableSearch() : mixed
- Enable fuse search
- enableVoidElement() : mixed
- Turn element into a void element
- find() : mixed
- Find child element
- fromData() : mixed
- Create a table from data array
- generateHiddenFields() : mixed
- Generate hidden fields
- get() : mixed
- Get an child element
- getAfterElement() : mixed
- Return the after element
- getBody() : mixed
- Return tbody
- getChildren() : mixed
- get children
- getColumns() : mixed
- Returns an array of TDataGridColumn
- getContents() : mixed
- Returns the element content as a string
- getHead() : mixed
- Return thead
- getHeight() : mixed
- Return datagrid height
- getIsWrapped() : mixed
- Return if the element is wrapped inside another one
- getItems() : mixed
- Return datagrid items
- getName() : mixed
- Returns tag name
- getOutputData() : mixed
- Get raw processed output data
- getPageNavigation() : mixed
- Return the assigned PageNavigation object
- getPageOrientation() : mixed
- Return the page orientation
- getPageSize() : mixed
- Return the page size
- getProperties() : mixed
- Return element properties
- getProperty() : mixed
- Return a property
- getRow() : mixed
- Return the row by position
- getRowIndex() : mixed
- Find the row index by object attribute
- getSearchForm() : TForm
- Return the assigned Search form object
- getTotalColumns() : mixed
- Returns the total columns
- getWidth() : An
- Returns the DataGrid's width
- hide() : mixed
- hide object
- insert() : mixed
- insert content
- isScrollable() : mixed
- Returns if datagrid is scrollable
- makeScrollable() : mixed
- Make the datagrid scrollable
- open() : mixed
- BC only
- openTag() : mixed
- Opens the tag
- prepareForPrinting() : mixed
- Prepare for printing
- prependRow() : mixed
- Prepend row
- removeRowById() : mixed
- Remove row by id
- replaceRowById() : mixed
- Replace row by id
- setActions() : mixed
- Set actions to the DataGrid
- setActionSide() : mixed
- Set actions side
- setActionWidth() : mixed
- Set the column action width
- setGroupColumn() : mixed
- Set the group column for break
- setHeight() : mixed
- Define the Height
- setId() : mixed
- Set id
- setIsWrapped() : mixed
- Define if the element is wrapped inside another one
- setMutationAction() : mixed
- Define mutation action
- setName() : mixed
- Change the element name
- setPageNavigation() : mixed
- Assign a PageNavigation object
- setPageOrientation() : mixed
- Set page orientation
- setPageSize() : mixed
- Set page Size
- setProperties() : mixed
- Set element properties
- setProperty() : mixed
- Set tag property
- setSearchAttributes() : mixed
- Set serach attributes
- setSearchForm() : mixed
- Assign a TForm object
- setUseLineBreaks() : mixed
- Set the use of linebreaks
- setUseSingleQuotes() : mixed
- Set the use of single quotes
- show() : mixed
- Shows the DataGrid
- tag() : mixed
- Create an element
- useGroupTotal() : mixed
- Set the group column for break
- createHeaderActionCells() : mixed
- Create header action cells
- createItemActions() : mixed
- Create item actions
- hasCustomWidth() : mixed
- Returns true if has custom width
- processGroupTotals() : mixed
- processPopovers() : mixed
- Run popover according to their conditions
- processTotals() : mixed
- Process column totals
Properties
$action_groups
protected
mixed
$action_groups
$actions
protected
mixed
$actions
$actionSide
protected
mixed
$actionSide
$actionWidth
protected
mixed
$actionWidth
$children
protected
mixed
$children
$columns
protected
mixed
$columns
$columnValues
protected
mixed
$columnValues
$columnValuesGroup
protected
mixed
$columnValuesGroup
$defaultClick
protected
mixed
$defaultClick
$forPrinting
protected
mixed
$forPrinting
$groupColumn
protected
mixed
$groupColumn
$groupContent
protected
mixed
$groupContent
$groupCount
protected
mixed
$groupCount
$groupMask
protected
mixed
$groupMask
$groupRowCount
protected
mixed
$groupRowCount
$groupTotal
protected
mixed
$groupTotal
$groupTransformer
protected
mixed
$groupTransformer
$hasInlineEditing
protected
mixed
$hasInlineEditing
$hasTotalFunction
protected
mixed
$hasTotalFunction
$height
protected
mixed
$height
$hiddenFields
protected
mixed
$hiddenFields
$HTMLOutputConversion
protected
mixed
$HTMLOutputConversion
$modelCreated
protected
mixed
$modelCreated
$mutationAction
protected
mixed
$mutationAction
$objects
protected
mixed
$objects
$objectsGroup
protected
mixed
$objectsGroup
$outputData
protected
mixed
$outputData
$pageNavigation
protected
mixed
$pageNavigation
$pageOrientation
protected
mixed
$pageOrientation
$pageSize
protected
mixed
$pageSize
$popovers
protected
mixed
$popovers
$prependRows
protected
mixed
$prependRows
$rowcount
protected
mixed
$rowcount
$scrollable
protected
mixed
$scrollable
$searchAttributes
protected
mixed
$searchAttributes
$searchForm
protected
mixed
$searchForm
$tbody
protected
mixed
$tbody
$tfoot
protected
mixed
$tfoot
$thead
protected
mixed
$thead
$afterElement
private
mixed
$afterElement
$hidden
private
mixed
$hidden
$isVoidElement
private
mixed
$isVoidElement
$properties
private
mixed
$properties
$section
private
mixed
$section
$tagname
private
mixed
$tagname
$useLineBreaks
private
mixed
$useLineBreaks
$useSingleQuotes
private
mixed
$useSingleQuotes
$voidelements
private
static mixed
$voidelements
$wrapped
private
mixed
$wrapped
Methods
__clone()
Clone the object
public
__clone() : mixed
__construct()
Class Constructor
public
__construct() : mixed
__get()
Returns a property's value
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
__isset()
Returns is a property's is set
public
__isset(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
__set()
Intercepts whenever someones assign a new property's value
public
__set(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
-
Property Name
- $value : mixed
-
Property Value
__toString()
Converts the object into a string
public
__toString() : mixed
__unset()
Intercepts whenever someones unset a property's value
public
__unset(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
add()
Add an child element
public
add(mixed $child) : mixed
Parameters
- $child : mixed
-
Any object that implements the show() method
addAction()
Add an Action to the DataGrid
public
addAction(TDataGridAction $action[, mixed $label = null ][, mixed $image = null ]) : mixed
Parameters
- $action : TDataGridAction
- $label : mixed = null
- $image : mixed = null
addActionGroup()
Add an Action Group to the DataGrid
public
addActionGroup(mixed $object) : mixed
Parameters
- $object : mixed
-
A TDataGridActionGroup object
addColumn()
Add a Column to the DataGrid
public
addColumn(mixed $object[, TAction|null $action = null ]) : mixed
Parameters
- $object : mixed
-
A TDataGridColumn object
- $action : TAction|null = null
addItem()
Add an object to the DataGrid
public
addItem(mixed $object) : mixed
Parameters
- $object : mixed
-
An Active Record Object
addItems()
Add objects to the DataGrid
public
addItems(mixed $objects) : mixed
Parameters
- $objects : mixed
-
An array of Objects
addMany()
Add many children
public
addMany(mixed $children) : mixed
Parameters
- $children : mixed
-
Array of child
addQuickAction()
Add action to the datagrid
public
addQuickAction(mixed $label, mixed $action, mixed $field[, mixed $icon = NULL ]) : mixed
Parameters
- $label : mixed
-
Action Label
- $action : mixed
-
TAction Object
- $field : mixed
- $icon : mixed = NULL
-
Action Icon
addQuickColumn()
Add a column
public
addQuickColumn(mixed $label, mixed $name[, mixed $align = 'left' ][, mixed $size = 200 ][, TAction|null $action = NULL ][, mixed $param = NULL ]) : mixed
Parameters
- $label : mixed
-
Field Label
- $name : mixed
- $align : mixed = 'left'
- $size : mixed = 200
-
Field Size
- $action : TAction|null = NULL
- $param : mixed = NULL
addRow()
Add a new row (TTableRow object) to the table
public
addRow() : TTableRow
Return values
TTableRowaddRowSet()
Add a new row (TTableRow object) with many cells
public
addRowSet() : TTableRow
Return values
TTableRowaddSection()
Add section
public
addSection(mixed $type) : mixed
Parameters
- $type : mixed
after()
Insert element after
public
after(mixed $element) : mixed
Parameters
- $element : mixed
appendRow()
Append table row via Javascript
public
static appendRow(mixed $table_id, mixed $row) : mixed
Parameters
- $table_id : mixed
- $row : mixed
clear()
Clear the DataGrid contents
public
clear([mixed $preserveHeader = TRUE ][, mixed $rows = 0 ]) : mixed
Parameters
- $preserveHeader : mixed = TRUE
- $rows : mixed = 0
clearChildren()
Clear element children
public
clearChildren() : mixed
close()
BC only
public
close() : mixed
closeTag()
Closes the tag
public
closeTag() : mixed
create()
Create a table
public
static create(mixed $properties) : mixed
Parameters
- $properties : mixed
createModel()
Creates the DataGrid Structure
public
createModel([mixed $create_header = true ]) : mixed
Parameters
- $create_header : mixed = true
del()
Del an child element
public
del(mixed $object) : mixed
Parameters
- $object : mixed
disableDefaultClick()
disable the default click action
public
disableDefaultClick() : mixed
disableHtmlConversion()
Disable htmlspecialchars on output
public
disableHtmlConversion() : mixed
enablePopover()
Enable popover
public
enablePopover(mixed $title, mixed $content[, mixed $popside = null ][, mixed $popcondition = null ]) : mixed
Parameters
- $title : mixed
-
Title
- $content : mixed
-
Content
- $popside : mixed = null
- $popcondition : mixed = null
enableSearch()
Enable fuse search
public
enableSearch(mixed $input, mixed $attributes) : mixed
Parameters
- $input : mixed
-
Field input for search
- $attributes : mixed
enableVoidElement()
Turn element into a void element
public
enableVoidElement() : mixed
find()
Find child element
public
find(mixed $element[, mixed $properties = null ]) : mixed
Parameters
- $element : mixed
-
tag name
- $properties : mixed = null
-
match properties
fromData()
Create a table from data array
public
static fromData(mixed $array_data[, mixed $table_properties = null ][, mixed $header_properties = null ][, mixed $body_properties = null ]) : mixed
Parameters
- $array_data : mixed
-
Array with raw data
- $table_properties : mixed = null
-
Array of CSS properties for table
- $header_properties : mixed = null
-
Array of CSS properties for header
- $body_properties : mixed = null
-
Array of CSS properties for body
generateHiddenFields()
Generate hidden fields
public
generateHiddenFields() : mixed
get()
Get an child element
public
get(mixed $position) : mixed
Parameters
- $position : mixed
-
Element position
getAfterElement()
Return the after element
public
getAfterElement() : mixed
getBody()
Return tbody
public
getBody() : mixed
getChildren()
get children
public
getChildren() : mixed
getColumns()
Returns an array of TDataGridColumn
public
getColumns() : mixed
getContents()
Returns the element content as a string
public
getContents() : mixed
getHead()
Return thead
public
getHead() : mixed
getHeight()
Return datagrid height
public
getHeight() : mixed
getIsWrapped()
Return if the element is wrapped inside another one
public
getIsWrapped() : mixed
getItems()
Return datagrid items
public
getItems() : mixed
getName()
Returns tag name
public
getName() : mixed
getOutputData()
Get raw processed output data
public
getOutputData() : mixed
getPageNavigation()
Return the assigned PageNavigation object
public
getPageNavigation() : mixed
Tags
getPageOrientation()
Return the page orientation
public
getPageOrientation() : mixed
getPageSize()
Return the page size
public
getPageSize() : mixed
getProperties()
Return element properties
public
getProperties() : mixed
getProperty()
Return a property
public
getProperty(mixed $name) : mixed
Parameters
- $name : mixed
-
property name
getRow()
Return the row by position
public
getRow(mixed $position) : mixed
Parameters
- $position : mixed
-
Row position
getRowIndex()
Find the row index by object attribute
public
getRowIndex(mixed $attribute, mixed $value) : mixed
Parameters
- $attribute : mixed
-
Object attribute
- $value : mixed
-
Object value
getSearchForm()
Return the assigned Search form object
public
getSearchForm() : TForm
Return values
TForm —object
getTotalColumns()
Returns the total columns
public
getTotalColumns() : mixed
getWidth()
Returns the DataGrid's width
public
getWidth() : An
Return values
An —integer containing the DataGrid's width
hide()
hide object
public
hide() : mixed
insert()
insert content
public
insert(mixed $position, mixed $content) : mixed
Parameters
- $position : mixed
-
Element position
- $content : mixed
isScrollable()
Returns if datagrid is scrollable
public
isScrollable() : mixed
makeScrollable()
Make the datagrid scrollable
public
makeScrollable() : mixed
open()
BC only
public
open() : mixed
openTag()
Opens the tag
public
openTag() : mixed
prepareForPrinting()
Prepare for printing
public
prepareForPrinting() : mixed
prependRow()
Prepend row
public
prependRow(mixed $row) : mixed
Parameters
- $row : mixed
removeRowById()
Remove row by id
public
static removeRowById(mixed $table_id, mixed $id) : mixed
Parameters
- $table_id : mixed
- $id : mixed
replaceRowById()
Replace row by id
public
static replaceRowById(mixed $table_id, mixed $id, mixed $row) : mixed
Parameters
- $table_id : mixed
- $id : mixed
- $row : mixed
setActions()
Set actions to the DataGrid
public
setActions(mixed $actions) : mixed
Parameters
- $actions : mixed
-
TDataGridAction objects
setActionSide()
Set actions side
public
setActionSide(mixed $side) : mixed
Parameters
- $side : mixed
setActionWidth()
Set the column action width
public
setActionWidth(mixed $width) : mixed
Parameters
- $width : mixed
setGroupColumn()
Set the group column for break
public
setGroupColumn(mixed $column, mixed $mask[, mixed $transformer = null ]) : mixed
Parameters
- $column : mixed
- $mask : mixed
- $transformer : mixed = null
setHeight()
Define the Height
public
setHeight(mixed $height) : mixed
Parameters
- $height : mixed
-
An integer containing the height
setId()
Set id
public
setId(mixed $id) : mixed
Parameters
- $id : mixed
setIsWrapped()
Define if the element is wrapped inside another one
public
setIsWrapped(mixed $bool) : mixed
Parameters
- $bool : mixed
setMutationAction()
Define mutation action
public
setMutationAction(TAction $action) : mixed
Parameters
- $action : TAction
setName()
Change the element name
public
setName(mixed $tagname) : mixed
Parameters
- $tagname : mixed
-
Element name
setPageNavigation()
Assign a PageNavigation object
public
setPageNavigation(mixed $pageNavigation) : mixed
Parameters
- $pageNavigation : mixed
-
object
setPageOrientation()
Set page orientation
public
setPageOrientation(mixed $page_orientation) : mixed
Parameters
- $page_orientation : mixed
-
(portrait, landscape)
setPageSize()
Set page Size
public
setPageSize(mixed $page_size) : mixed
Parameters
- $page_size : mixed
-
(a3,a4,a5,letter,legal)
setProperties()
Set element properties
public
setProperties(mixed $properties) : mixed
Parameters
- $properties : mixed
setProperty()
Set tag property
public
setProperty(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
-
Property Name
- $value : mixed
-
Property Value
setSearchAttributes()
Set serach attributes
public
setSearchAttributes(mixed $attributes) : mixed
Parameters
- $attributes : mixed
setSearchForm()
Assign a TForm object
public
setSearchForm(mixed $searchForm) : mixed
Parameters
- $searchForm : mixed
-
object
setUseLineBreaks()
Set the use of linebreaks
public
setUseLineBreaks(mixed $linebreaks) : mixed
Parameters
- $linebreaks : mixed
-
boolean
setUseSingleQuotes()
Set the use of single quotes
public
setUseSingleQuotes(mixed $singlequotes) : mixed
Parameters
- $singlequotes : mixed
-
boolean
show()
Shows the DataGrid
public
show() : mixed
tag()
Create an element
public
static tag(mixed $tagname, mixed $value[, mixed $attributes = NULL ]) : mixed
Parameters
- $tagname : mixed
-
Element name
- $value : mixed
-
Element value
- $attributes : mixed = NULL
-
Element attributes
useGroupTotal()
Set the group column for break
public
useGroupTotal([mixed $groupTotal = null ]) : mixed
Parameters
- $groupTotal : mixed = null
createHeaderActionCells()
Create header action cells
private
createHeaderActionCells(mixed $row) : mixed
Parameters
- $row : mixed
createItemActions()
Create item actions
private
createItemActions(mixed $row, mixed $object) : mixed
Parameters
- $row : mixed
-
DOM Row
- $object : mixed
-
Data Object
hasCustomWidth()
Returns true if has custom width
private
hasCustomWidth() : mixed
processGroupTotals()
private
processGroupTotals(mixed $valueGroup) : mixed
Parameters
- $valueGroup : mixed
processPopovers()
Run popover according to their conditions
private
processPopovers(mixed $row, mixed $object) : mixed
Parameters
- $row : mixed
- $object : mixed
processTotals()
Process column totals
private
processTotals() : mixed