TFieldList
extends TTable
in package
Create a field list
Tags
Table of Contents
Properties
- $totalUpdateAction : mixed
- $allow_post_empty : mixed
- $automatic_aria : mixed
- $body_created : mixed
- $clone_function : mixed
- $detail_row : mixed
- $field_prefix : mixed
- $fields : mixed
- $fields_properties : mixed
- $labels : mixed
- $remove_action : mixed
- $remove_enabled : mixed
- $remove_function : mixed
- $remove_icon : mixed
- $remove_title : mixed
- $row_actions : mixed
- $row_functions : mixed
- $section : mixed
- $sort_action : mixed
- $sorting : mixed
- $summarize : mixed
- $tbody : mixed
- $tfoot : mixed
- $thead : mixed
- $total_functions : mixed
- $totals : mixed
Methods
- __construct() : mixed
- Class Constructor
- addButtonAction() : mixed
- Add action
- addButtonFunction() : mixed
- Add function
- addCloneAction() : mixed
- Add clone action
- addDetail() : mixed
- Add detail row
- addField() : mixed
- Add a field
- addHeader() : mixed
- Add table header
- addRow() : TTableRow
- Add a new row (TTableRow object) to the table
- addRows() : mixed
- Add rows on field list
- addRowSet() : TTableRow
- Add a new row (TTableRow object) with many cells
- addSection() : mixed
- Add section
- addTotalFields() : mixed
- clear() : mixed
- Clear field list
- clearRows() : mixed
- Clear some field list rows
- create() : mixed
- Create a table
- disableField() : mixed
- Disable the field
- disablePostEmptyRow() : mixed
- disableRemoveButton() : mixed
- Disable remove button
- enableField() : mixed
- Enable the field
- enableSorting() : mixed
- Enable sorting
- fromData() : mixed
- Create a table from data array
- generateAria() : mixed
- Generate automatic aria-labels
- getBody() : mixed
- Get body
- getFieldPrefix() : mixed
- Get field prefix
- getFoot() : mixed
- Get foot
- getHead() : mixed
- Get head
- getPostData() : mixed
- Get post data as object list
- getRowCount() : mixed
- Get post row count
- makeScrollable() : mixed
- Enable scrolling
- setCloneFunction() : mixed
- Set the clone javascript action
- setFieldPrefix() : mixed
- Set field prefix
- setRemoveAction() : mixed
- Set the remove action
- setRemoveFunction() : mixed
- Set the remove javascript action
- setSortAction() : mixed
- Define the action to be executed when the user sort rows
- setTotalUpdateAction() : mixed
- Define total update action
- show() : mixed
- Show component
Properties
$totalUpdateAction
protected
mixed
$totalUpdateAction
$allow_post_empty
private
mixed
$allow_post_empty
$automatic_aria
private
mixed
$automatic_aria
$body_created
private
mixed
$body_created
$clone_function
private
mixed
$clone_function
$detail_row
private
mixed
$detail_row
$field_prefix
private
mixed
$field_prefix
$fields
private
mixed
$fields
$fields_properties
private
mixed
$fields_properties
$labels
private
mixed
$labels
$remove_action
private
mixed
$remove_action
$remove_enabled
private
mixed
$remove_enabled
$remove_function
private
mixed
$remove_function
$remove_icon
private
mixed
$remove_icon
$remove_title
private
mixed
$remove_title
$row_actions
private
mixed
$row_actions
$row_functions
private
mixed
$row_functions
$section
private
mixed
$section
$sort_action
private
mixed
$sort_action
$sorting
private
mixed
$sorting
$summarize
private
mixed
$summarize
$tbody
private
mixed
$tbody
$tfoot
private
mixed
$tfoot
$thead
private
mixed
$thead
$total_functions
private
mixed
$total_functions
$totals
private
mixed
$totals
Methods
__construct()
Class Constructor
public
__construct() : mixed
addButtonAction()
Add action
public
addButtonAction(TAction $action, mixed $icon, mixed $title) : mixed
Parameters
- $action : TAction
- $icon : mixed
- $title : mixed
addButtonFunction()
Add function
public
addButtonFunction(mixed $function, mixed $icon, mixed $title) : mixed
Parameters
- $function : mixed
- $icon : mixed
- $title : mixed
addCloneAction()
Add clone action
public
addCloneAction([TAction $clone_action = null ][, mixed $icon = null ][, mixed $title = null ]) : mixed
Parameters
- $clone_action : TAction = null
- $icon : mixed = null
- $title : mixed = null
addDetail()
Add detail row
public
addDetail( $item) : mixed
Parameters
addField()
Add a field
public
addField( $label, AdiantiWidgetInterface $field[, mixed $properties = null ]) : mixed
Parameters
- $label :
-
Field Label
- $field : AdiantiWidgetInterface
- $properties : mixed = null
addHeader()
Add table header
public
addHeader() : mixed
addRow()
Add a new row (TTableRow object) to the table
public
addRow() : TTableRow
Return values
TTableRowaddRows()
Add rows on field list
public
static addRows( $name, $rows[, $timeout = 50 ]) : mixed
Parameters
addRowSet()
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
addTotalFields()
public
addTotalFields(mixed $row) : mixed
Parameters
- $row : mixed
clear()
Clear field list
public
static clear( $name) : mixed
Parameters
clearRows()
Clear some field list rows
public
static clearRows( $name[, mixed $start = 0 ][, mixed $length = 0 ]) : mixed
Parameters
create()
Create a table
public
static create(mixed $properties) : mixed
Parameters
- $properties : mixed
disableField()
Disable the field
public
static disableField( $field) : mixed
Parameters
disablePostEmptyRow()
public
disablePostEmptyRow() : mixed
disableRemoveButton()
Disable remove button
public
disableRemoveButton() : mixed
enableField()
Enable the field
public
static enableField( $field) : mixed
Parameters
enableSorting()
Enable sorting
public
enableSorting() : mixed
fromData()
Create a table from data array
public
static fromData( $array_data[, $table_properties = null ][, $header_properties = null ][, $body_properties = null ]) : mixed
Parameters
generateAria()
Generate automatic aria-labels
public
generateAria() : mixed
getBody()
Get body
public
getBody() : mixed
getFieldPrefix()
Get field prefix
public
getFieldPrefix() : mixed
getFoot()
Get foot
public
getFoot() : mixed
getHead()
Get head
public
getHead() : mixed
getPostData()
Get post data as object list
public
getPostData() : mixed
getRowCount()
Get post row count
public
getRowCount([mixed $field_name = null ]) : mixed
Parameters
- $field_name : mixed = null
makeScrollable()
Enable scrolling
public
makeScrollable(mixed $height) : mixed
Parameters
- $height : mixed
setCloneFunction()
Set the clone javascript action
public
setCloneFunction(mixed $action) : mixed
Parameters
- $action : mixed
setFieldPrefix()
Set field prefix
public
setFieldPrefix(mixed $prefix) : mixed
Parameters
- $prefix : mixed
setRemoveAction()
Set the remove action
public
setRemoveAction([TAction $action = null ][, mixed $icon = null ][, mixed $title = null ]) : mixed
Parameters
- $action : TAction = null
- $icon : mixed = null
- $title : mixed = null
setRemoveFunction()
Set the remove javascript action
public
setRemoveFunction(mixed $action[, mixed $icon = null ][, mixed $title = null ]) : mixed
Parameters
- $action : mixed
- $icon : mixed = null
- $title : mixed = null
setSortAction()
Define the action to be executed when the user sort rows
public
setSortAction( $action) : mixed
Parameters
setTotalUpdateAction()
Define total update action
public
setTotalUpdateAction(TAction $action) : mixed
Parameters
- $action : TAction
show()
Show component
public
show() : mixed