TDropDown
extends TElement
in package
TDropDown Widget
Tags
Table of Contents
Properties
- $children : mixed
- $elements : mixed
- $afterElement : mixed
- $button : 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 an action
- addActionGroup() : mixed
- Add an action group
- addHeader() : mixed
- Add a header
- addMany() : mixed
- Add many children
- addPostAction() : mixed
- Add an action
- addSeparator() : mixed
- Add a separator
- after() : mixed
- Insert element after
- clearChildren() : mixed
- Clear element children
- clearItems() : mixed
- Clear child elements
- close() : mixed
- BC only
- closeTag() : mixed
- Closes the tag
- del() : mixed
- Del an child element
- 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
- getButton() : mixed
- Returns the dropdown button
- getChildren() : mixed
- get children
- getContents() : mixed
- Returns the element content as a string
- getIsWrapped() : mixed
- Return if the element is wrapped inside another one
- getItems() : mixed
- Get dropdown items
- 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
- setButtonClass() : mixed
- Define the button class
- setButtonSize() : mixed
- Define the button size
- 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
- setPullSide() : mixed
- Define the pull side
- setUseLineBreaks() : mixed
- Set the use of linebreaks
- setUseSingleQuotes() : mixed
- Set the use of single quotes
- show() : mixed
- Shows the tag
- tag() : mixed
- Create an element
Properties
$children
protected
mixed
$children
$elements
protected
mixed
$elements
$afterElement
private
mixed
$afterElement
$button
private
mixed
$button
$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 $label[, mixed $icon = NULL ][, mixed $use_caret = FALSE ][, mixed $title = '' ][, mixed $height = null ]) : mixed
Parameters
- $label : mixed
- $icon : mixed = NULL
-
Dropdown icon
- $use_caret : mixed = FALSE
- $title : mixed = ''
-
Dropdown title
- $height : mixed = null
__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
public
addAction(mixed $title, mixed $action[, mixed $icon = NULL ][, mixed $popover = '' ][, mixed $add = true ]) : mixed
Parameters
- $title : mixed
-
Title
- $action : mixed
-
Action (TAction or string Javascript action)
- $icon : mixed = NULL
-
Icon
- $popover : mixed = ''
- $add : mixed = true
addActionGroup()
Add an action group
public
addActionGroup(mixed $title, mixed $actions, mixed $icon) : mixed
Parameters
- $title : mixed
- $actions : mixed
- $icon : mixed
addHeader()
Add a header
public
addHeader(mixed $header) : mixed
Parameters
- $header : mixed
-
Options Header
addMany()
Add many children
public
addMany(mixed $children) : mixed
Parameters
- $children : mixed
-
Array of child
addPostAction()
Add an action
public
addPostAction(mixed $title, mixed $action, mixed $form[, mixed $icon = NULL ][, mixed $popover = '' ][, mixed $add = true ]) : mixed
Parameters
- $title : mixed
-
Title
- $action : mixed
-
Action (TAction or string Javascript action)
- $form : mixed
- $icon : mixed = NULL
-
Icon
- $popover : mixed = ''
- $add : mixed = true
addSeparator()
Add a separator
public
addSeparator() : mixed
after()
Insert element after
public
after(mixed $element) : mixed
Parameters
- $element : mixed
clearChildren()
Clear element children
public
clearChildren() : mixed
clearItems()
Clear child elements
public
clearItems() : 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
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
getButton()
Returns the dropdown button
public
getButton() : 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
getItems()
Get dropdown items
public
getItems() : 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
setButtonClass()
Define the button class
public
setButtonClass(mixed $class) : mixed
Parameters
- $class : mixed
Tags
setButtonSize()
Define the button size
public
setButtonSize(mixed $size) : mixed
Parameters
- $size : mixed
Tags
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
setPullSide()
Define the pull side
public
setPullSide(mixed $side) : mixed
Parameters
- $side : mixed
Tags
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 tag
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