TIconView
extends TElement
in package
TIconView Widget
Tags
Table of Contents
Properties
- $children : mixed
- $doubleClickEnabled : mixed
- $dragSelector : mixed
- $dropSelector : mixed
- $enableMoving : mixed
- $iconField : mixed
- $infoFields : mixed
- $itemProperties : mixed
- $items : mixed
- $itemTemplate : mixed
- $labelField : mixed
- $moveAction : mixed
- $options : mixed
- $popovers : mixed
- $templateAttribute : 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
- Constructor Method
- __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
- addContextMenuOption() : mixed
- Add a context menu option
- addItem() : mixed
- Add object item with data
- addMany() : mixed
- Add many children
- after() : mixed
- Insert element after
- clearChildren() : mixed
- Clear element children
- close() : mixed
- BC only
- closeTag() : mixed
- Closes the tag
- del() : mixed
- Del an child element
- enableDoubleClick() : mixed
- Enable double click
- enableMoveAction() : mixed
- Enable move action
- enablePopover() : mixed
- Enable popover
- 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
- getProperties() : mixed
- Return element properties
- getProperty() : mixed
- Return a property
- hide() : mixed
- hide object
- insert() : mixed
- Insert an child element
- open() : mixed
- BC only
- openTag() : mixed
- Opens the tag
- setIconAttribute() : mixed
- Define the field that will identify the icon
- setInfoAttributes() : mixed
- Set info fields
- setIsWrapped() : mixed
- Define if the element is wrapped inside another one
- setItemTemplate() : mixed
- Set item template for rendering
- setLabelAttribute() : mixed
- Define the field that will identify the label
- setName() : mixed
- Change the element name
- setProperties() : mixed
- Set element properties
- setProperty() : mixed
- Set tag property
- setTemplateAttribute() : mixed
- Set template atribute for rendering
- setUseLineBreaks() : mixed
- Set the use of linebreaks
- setUseSingleQuotes() : mixed
- Set the use of single quotes
- show() : mixed
- Show iconview items
- tag() : mixed
- Create an element
- processPopovers() : mixed
- Run popover according to their conditions
Properties
$children
protected
mixed
$children
$doubleClickEnabled
protected
mixed
$doubleClickEnabled
$dragSelector
protected
mixed
$dragSelector
$dropSelector
protected
mixed
$dropSelector
$enableMoving
protected
mixed
$enableMoving
$iconField
protected
mixed
$iconField
$infoFields
protected
mixed
$infoFields
$itemProperties
protected
mixed
$itemProperties
$items
protected
mixed
$items
$itemTemplate
protected
mixed
$itemTemplate
$labelField
protected
mixed
$labelField
$moveAction
protected
mixed
$moveAction
$options
protected
mixed
$options
$popovers
protected
mixed
$popovers
$templateAttribute
protected
mixed
$templateAttribute
$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()
Constructor Method
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
addContextMenuOption()
Add a context menu option
public
addContextMenuOption(mixed $label[, mixed $action = null ][, mixed $icon = null ][, mixed $displayCondition = null ]) : mixed
Parameters
- $label : mixed
- $action : mixed = null
- $icon : mixed = null
- $displayCondition : mixed = null
addItem()
Add object item with data
public
addItem(mixed $object) : mixed
Parameters
- $object : mixed
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
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
enableDoubleClick()
Enable double click
public
enableDoubleClick() : mixed
enableMoveAction()
Enable move action
public
enableMoveAction(mixed $moveAction, mixed $source_selector, mixed $target_selector) : mixed
Parameters
- $moveAction : mixed
- $source_selector : mixed
-
Source item selector
- $target_selector : mixed
-
Target item selector
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
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
getProperties()
Return element properties
public
getProperties() : mixed
getProperty()
Return a property
public
getProperty(mixed $name) : mixed
Parameters
- $name : mixed
-
property name
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
setIconAttribute()
Define the field that will identify the icon
public
setIconAttribute(mixed $iconField) : mixed
Parameters
- $iconField : mixed
setInfoAttributes()
Set info fields
public
setInfoAttributes(mixed $fields) : mixed
Parameters
- $fields : mixed
setIsWrapped()
Define if the element is wrapped inside another one
public
setIsWrapped(mixed $bool) : mixed
Parameters
- $bool : mixed
setItemTemplate()
Set item template for rendering
public
setItemTemplate(mixed $template) : mixed
Parameters
- $template : mixed
-
Template content
setLabelAttribute()
Define the field that will identify the label
public
setLabelAttribute(mixed $labelField) : mixed
Parameters
- $labelField : 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
setTemplateAttribute()
Set template atribute for rendering
public
setTemplateAttribute(mixed $attribute) : mixed
Parameters
- $attribute : mixed
-
Template attribute
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 iconview items
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
processPopovers()
Run popover according to their conditions
private
processPopovers(mixed $li, mixed $object) : mixed
Parameters
- $li : mixed
- $object : mixed