TFieldList
extends TTable
in package
Create a field list
Tags
Table of Contents
Properties
- $children : mixed
- $totalUpdateAction : mixed
- $afterElement : 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
- $hidden : mixed
- $isVoidElement : mixed
- $labels : mixed
- $properties : 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
- $tagname : mixed
- $tbody : mixed
- $tfoot : mixed
- $thead : mixed
- $total_functions : mixed
- $totals : 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
- 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
- addMany() : mixed
- Add many children
- 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
- after() : mixed
- Insert element after
- clear() : mixed
- Clear field list
- clearChildren() : mixed
- Clear element children
- clearRows() : mixed
- Clear some field list rows
- close() : mixed
- BC only
- closeTag() : mixed
- Closes the tag
- create() : mixed
- Create a table
- del() : mixed
- Del an child element
- disableField() : mixed
- Disable the field
- disablePostEmptyRow() : mixed
- disableRemoveButton() : mixed
- Disable remove button
- enableField() : mixed
- Enable the field
- enableSorting() : mixed
- Enable sorting
- enableVoidElement() : mixed
- Turn element into a void element
- find() : mixed
- Find child element
- fromData() : mixed
- Create a table from data array
- generateAria() : mixed
- Generate automatic aria-labels
- get() : mixed
- Get an child element
- getAfterElement() : mixed
- Return the after element
- getBody() : mixed
- Get body
- getChildren() : mixed
- get children
- getContents() : mixed
- Returns the element content as a string
- getFieldPrefix() : mixed
- Get field prefix
- getFoot() : mixed
- Get foot
- getHead() : mixed
- Get head
- getIsWrapped() : mixed
- Return if the element is wrapped inside another one
- getName() : mixed
- Returns tag name
- getPostData() : mixed
- Get post data as object list
- getProperties() : mixed
- Return element properties
- getProperty() : mixed
- Return a property
- getRowCount() : mixed
- Get post row count
- hide() : mixed
- hide object
- insert() : mixed
- Insert an child element
- makeScrollable() : mixed
- Enable scrolling
- open() : mixed
- BC only
- openTag() : mixed
- Opens the tag
- setCloneFunction() : mixed
- Set the clone javascript action
- setFieldPrefix() : mixed
- Set field prefix
- setIsWrapped() : mixed
- Define if the element is wrapped inside another one
- setName() : mixed
- Change the element name
- setProperties() : mixed
- Set element properties
- setProperty() : mixed
- Set tag property
- 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
- setUseLineBreaks() : mixed
- Set the use of linebreaks
- setUseSingleQuotes() : mixed
- Set the use of single quotes
- show() : mixed
- Show component
- tag() : mixed
- Create an element
Properties
$children
protected
mixed
$children
$totalUpdateAction
protected
mixed
$totalUpdateAction
$afterElement
private
mixed
$afterElement
$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
$hidden
private
mixed
$hidden
$isVoidElement
private
mixed
$isVoidElement
$labels
private
mixed
$labels
$properties
private
mixed
$properties
$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
$tagname
private
mixed
$tagname
$tbody
private
mixed
$tbody
$tfoot
private
mixed
$tfoot
$thead
private
mixed
$thead
$total_functions
private
mixed
$total_functions
$totals
private
mixed
$totals
$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
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|null $clone_action = null ][, mixed $icon = null ][, mixed $title = null ]) : mixed
Parameters
- $clone_action : TAction|null = null
- $icon : mixed = null
- $title : mixed = null
addDetail()
Add detail row
public
addDetail(mixed $item[, callable|null $callback = null ]) : mixed
Parameters
- $item : mixed
-
Data object
- $callback : callable|null = null
addField()
Add a field
public
addField(mixed $label, AdiantiWidgetInterface $field[, mixed $properties = null ]) : mixed
Parameters
- $label : mixed
-
Field Label
- $field : AdiantiWidgetInterface
- $properties : mixed = null
addHeader()
Add table header
public
addHeader() : mixed
addMany()
Add many children
public
addMany(mixed $children) : mixed
Parameters
- $children : mixed
-
Array of child
addRow()
Add a new row (TTableRow object) to the table
public
addRow() : TTableRow
Return values
TTableRowaddRows()
Add rows on field list
public
static addRows(mixed $name, mixed $rows[, mixed $timeout = 50 ]) : mixed
Parameters
- $name : mixed
-
field list name
- $rows : mixed
-
quantity rows
- $timeout : mixed = 50
-
timeout
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
after()
Insert element after
public
after(mixed $element) : mixed
Parameters
- $element : mixed
clear()
Clear field list
public
static clear(mixed $name) : mixed
Parameters
- $name : mixed
-
field list name
clearChildren()
Clear element children
public
clearChildren() : mixed
clearRows()
Clear some field list rows
public
static clearRows(mixed $name[, mixed $start = 0 ][, mixed $length = 0 ]) : mixed
Parameters
- $name : mixed
-
field list name
- $start : mixed = 0
- $length : mixed = 0
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
del()
Del an child element
public
del(mixed $object) : mixed
Parameters
- $object : mixed
disableField()
Disable the field
public
static disableField(mixed $field) : mixed
Parameters
- $field : mixed
-
Field name
disablePostEmptyRow()
public
disablePostEmptyRow() : mixed
disableRemoveButton()
Disable remove button
public
disableRemoveButton() : mixed
enableField()
Enable the field
public
static enableField(mixed $field) : mixed
Parameters
- $field : mixed
-
Field name
enableSorting()
Enable sorting
public
enableSorting() : 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
generateAria()
Generate automatic aria-labels
public
generateAria() : 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()
Get body
public
getBody() : mixed
getChildren()
get children
public
getChildren() : mixed
getContents()
Returns the element content as a string
public
getContents() : mixed
getFieldPrefix()
Get field prefix
public
getFieldPrefix() : mixed
getFoot()
Get foot
public
getFoot() : mixed
getHead()
Get head
public
getHead() : mixed
getIsWrapped()
Return if the element is wrapped inside another one
public
getIsWrapped() : mixed
getName()
Returns tag name
public
getName() : mixed
getPostData()
Get post data as object list
public
getPostData() : mixed
getProperties()
Return element properties
public
getProperties() : mixed
getProperty()
Return a property
public
getProperty(mixed $name) : mixed
Parameters
- $name : mixed
-
property name
getRowCount()
Get post row count
public
getRowCount([mixed $field_name = null ]) : mixed
Parameters
- $field_name : mixed = null
hide()
hide object
public
hide() : mixed
insert()
Insert an child element
public
insert(mixed $position, mixed $child) : mixed
Parameters
- $position : mixed
-
Element position
- $child : mixed
-
Any object that implements the show() method
makeScrollable()
Enable scrolling
public
makeScrollable(mixed $height) : mixed
Parameters
- $height : mixed
open()
BC only
public
open() : mixed
openTag()
Opens the tag
public
openTag() : 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
setIsWrapped()
Define if the element is wrapped inside another one
public
setIsWrapped(mixed $bool) : mixed
Parameters
- $bool : mixed
setName()
Change the element name
public
setName(mixed $tagname) : mixed
Parameters
- $tagname : mixed
-
Element name
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
setRemoveAction()
Set the remove action
public
setRemoveAction([TAction|null $action = null ][, mixed $icon = null ][, mixed $title = null ]) : mixed
Parameters
- $action : TAction|null = 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(mixed $action) : mixed
Parameters
- $action : mixed
-
TAction object
setTotalUpdateAction()
Define total update action
public
setTotalUpdateAction(TAction $action) : mixed
Parameters
- $action : TAction
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()
Show component
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