TCardView
extends TElement
in package
Card
Tags
Table of Contents
Properties
- $children : mixed
- $colorField : mixed
- $contentField : mixed
- $contentHeight : mixed
- $forPrinting : mixed
- $itemActionGroups : mixed
- $itemActions : mixed
- $itemClass : mixed
- $itemDatabase : mixed
- $itemHeight : mixed
- $items : mixed
- $itemTemplate : mixed
- $itemTemplateCallback : mixed
- $itemWidth : mixed
- $pageNavigation : mixed
- $pageOrientation : mixed
- $pageSize : mixed
- $searchAttributes : mixed
- $searchForm : mixed
- $templatePath : mixed
- $titleField : mixed
- $titleTemplate : mixed
- $useButton : mixed
- $useDefaultClickBody : mixed
- $useDefaultClickHead : mixed
- $afterElement : mixed
- $hidden : mixed
- $isVoidElement : mixed
- $properties : 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 item action
- addActionGroup() : mixed
- Add action group
- addItem() : mixed
- Add item
- addMany() : mixed
- Add many children
- after() : mixed
- Insert element after
- clear() : mixed
- Clear items
- clearChildren() : mixed
- Clear element children
- close() : mixed
- BC only
- closeTag() : mixed
- Closes the tag
- del() : mixed
- Del an child element
- enableDefaultClick() : mixed
- Enable default click in title and body
- enableSearch() : mixed
- Enable fuse search
- enableVoidElement() : mixed
- Turn element into a void element
- find() : mixed
- Find child element
- get() : mixed
- Get an child element
- getAfterElement() : mixed
- Return the after element
- getChildren() : mixed
- get children
- getContents() : mixed
- Returns the element content as a string
- getIsWrapped() : mixed
- Return if the element is wrapped inside another one
- getName() : mixed
- Returns tag name
- 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
- getSearchForm() : TForm
- Return the assigned Search form object
- hide() : mixed
- hide object
- insert() : mixed
- Insert an child element
- open() : mixed
- BC only
- openTag() : mixed
- Opens the tag
- prepareForPrinting() : mixed
- Prepare for printing
- setColorAttribute() : mixed
- Set color attribute
- setContentAttribute() : mixed
- Set content attribute
- setContentHeight() : mixed
- Set content min height
- setIsWrapped() : mixed
- Define if the element is wrapped inside another one
- setItemClass() : mixed
- Set custom class card
- setItemDatabase() : mixed
- Set item min database
- setItemHeight() : mixed
- Set item min height
- setItemTemplate() : mixed
- Set card item template for rendering
- setItemTemplateCallback() : mixed
- Set card item callback for rendering
- setItemWidth() : mixed
- Set item min width
- 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
- setSearchForm() : mixed
- Assign a TForm object
- setTemplatePath() : mixed
- Set card item template for rendering
- setTitleAttribute() : mixed
- Set title attribute
- setTitleTemplate() : mixed
- Set card title template for rendering
- setUseButton() : mixed
- Display icons as buttons
- setUseLineBreaks() : mixed
- Set the use of linebreaks
- setUseSingleQuotes() : mixed
- Set the use of single quotes
- show() : mixed
- Show cards
- tag() : mixed
- Create an element
- renderItem() : mixed
- Render item
- renderItemActions() : mixed
- Render item actions
Properties
$children
protected
mixed
$children
$colorField
protected
mixed
$colorField
$contentField
protected
mixed
$contentField
$contentHeight
protected
mixed
$contentHeight
$forPrinting
protected
mixed
$forPrinting
$itemActionGroups
protected
mixed
$itemActionGroups
$itemActions
protected
mixed
$itemActions
$itemClass
protected
mixed
$itemClass
$itemDatabase
protected
mixed
$itemDatabase
$itemHeight
protected
mixed
$itemHeight
$items
protected
mixed
$items
$itemTemplate
protected
mixed
$itemTemplate
$itemTemplateCallback
protected
mixed
$itemTemplateCallback
$itemWidth
protected
mixed
$itemWidth
$pageNavigation
protected
mixed
$pageNavigation
$pageOrientation
protected
mixed
$pageOrientation
$pageSize
protected
mixed
$pageSize
$searchAttributes
protected
mixed
$searchAttributes
$searchForm
protected
mixed
$searchForm
$templatePath
protected
mixed
$templatePath
$titleField
protected
mixed
$titleField
$titleTemplate
protected
mixed
$titleTemplate
$useButton
protected
mixed
$useButton
$useDefaultClickBody
protected
mixed
$useDefaultClickBody
$useDefaultClickHead
protected
mixed
$useDefaultClickHead
$afterElement
private
mixed
$afterElement
$hidden
private
mixed
$hidden
$isVoidElement
private
mixed
$isVoidElement
$properties
private
mixed
$properties
$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 item action
public
addAction(mixed $action, mixed $label[, mixed $icon = NULL ][, mixed $display_condition = NULL ][, mixed $title = NULL ]) : mixed
Parameters
- $action : mixed
-
Action callback (TAction)
- $label : mixed
-
Action label
- $icon : mixed = NULL
-
Action icon
- $display_condition : mixed = NULL
-
Display condition
- $title : mixed = NULL
addActionGroup()
Add action group
public
addActionGroup(mixed $title, mixed $actions, mixed $icon) : mixed
Parameters
- $title : mixed
-
Action group title
- $actions : mixed
-
Array of actions
- $icon : mixed
-
Action group icon
addItem()
Add item
public
addItem(mixed $object) : mixed
Parameters
- $object : mixed
-
Item data object
addMany()
Add many children
public
addMany(mixed $children) : mixed
Parameters
- $children : mixed
-
Array of child
after()
Insert element after
public
after(mixed $element) : mixed
Parameters
- $element : mixed
clear()
Clear items
public
clear() : mixed
clearChildren()
Clear element children
public
clearChildren() : mixed
close()
BC only
public
close() : mixed
closeTag()
Closes the tag
public
closeTag() : mixed
del()
Del an child element
public
del(mixed $object) : mixed
Parameters
- $object : mixed
enableDefaultClick()
Enable default click in title and body
public
enableDefaultClick([mixed $head = TRUE ][, mixed $body = TRUE ]) : mixed
Parameters
- $head : mixed = TRUE
- $body : mixed = TRUE
enableSearch()
Enable fuse search
public
enableSearch(mixed $input, mixed $attribute) : mixed
Parameters
- $input : mixed
-
Field input for search
- $attribute : mixed
-
Attribute name
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
get()
Get an child element
public
get(mixed $position) : mixed
Parameters
- $position : mixed
-
Element position
getAfterElement()
Return the after element
public
getAfterElement() : mixed
getChildren()
get children
public
getChildren() : mixed
getContents()
Returns the element content as a string
public
getContents() : mixed
getIsWrapped()
Return if the element is wrapped inside another one
public
getIsWrapped() : mixed
getName()
Returns tag name
public
getName() : 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
getSearchForm()
Return the assigned Search form object
public
getSearchForm() : TForm
Return values
TForm —object
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
open()
BC only
public
open() : mixed
openTag()
Opens the tag
public
openTag() : mixed
prepareForPrinting()
Prepare for printing
public
prepareForPrinting() : mixed
setColorAttribute()
Set color attribute
public
setColorAttribute(mixed $field) : mixed
Parameters
- $field : mixed
-
attribute name
setContentAttribute()
Set content attribute
public
setContentAttribute(mixed $field) : mixed
Parameters
- $field : mixed
-
attribute name
setContentHeight()
Set content min height
public
setContentHeight(mixed $height) : mixed
Parameters
- $height : mixed
-
min height
setIsWrapped()
Define if the element is wrapped inside another one
public
setIsWrapped(mixed $bool) : mixed
Parameters
- $bool : mixed
setItemClass()
Set custom class card
public
setItemClass(mixed $class) : mixed
Parameters
- $class : mixed
-
class name
setItemDatabase()
Set item min database
public
setItemDatabase(mixed $database) : mixed
Parameters
- $database : mixed
-
min database
setItemHeight()
Set item min height
public
setItemHeight(mixed $height) : mixed
Parameters
- $height : mixed
-
min height
setItemTemplate()
Set card item template for rendering
public
setItemTemplate(mixed $template) : mixed
Parameters
- $template : mixed
-
Template content
setItemTemplateCallback()
Set card item callback for rendering
public
setItemTemplateCallback(mixed $callback) : mixed
Parameters
- $callback : mixed
-
Callback
setItemWidth()
Set item min width
public
setItemWidth(mixed $width) : mixed
Parameters
- $width : mixed
-
min width
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
setSearchForm()
Assign a TForm object
public
setSearchForm(mixed $searchForm) : mixed
Parameters
- $searchForm : mixed
-
object
setTemplatePath()
Set card item template for rendering
public
setTemplatePath(mixed $path) : mixed
Parameters
- $path : mixed
-
Template path
setTitleAttribute()
Set title attribute
public
setTitleAttribute(mixed $field) : mixed
Parameters
- $field : mixed
-
attribute name
setTitleTemplate()
Set card title template for rendering
public
setTitleTemplate(mixed $template) : mixed
Parameters
- $template : mixed
-
Template content
setUseButton()
Display icons as buttons
public
setUseButton() : mixed
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 cards
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
renderItem()
Render item
private
renderItem(mixed $item) : mixed
Parameters
- $item : mixed
renderItemActions()
Render item actions
private
renderItemActions([mixed $object = NULL ]) : mixed
Parameters
- $object : mixed = NULL