Inheritance diagram for HtmlList:

Public Member Functions

__construct ($identifier, $items=array())

addHeader ($niveau, $content)

getItemPart ($index, $partName="header")

itemsAs ($tagName)

asLinks ($hrefs=[], $target=NUll)

addList ($items=array())

getItem ($index)

setCelled ()

setBulleted ()

setOrdered ()

run (JsUtils $js)

Parameters

JsUtils $js

Returns: SimpleExtComponent

See also: \Ajax\common\html\BaseHtmlrun()

See also: \Ajax\common\html\BaseHtmlrun()

See also: \Ajax\common\html\BaseHtmlrun()

onCkItemChange ($jsCode)

setFireOnInit ($fireOnInit)

setRelaxed ()

setSelection ()

setDivided ()

setHorizontal ()

compile (JsUtils $js=NULL, &$view=NULL)

{}

addCheckedList ($items=array(), $masterItem=NULL, $values=array(), $notAllChecked=false, $name=null)

Adds a grouped checked box to the list.

setIcons ($icons)

getMaxVisible ()

setMaxVisible ($_maxVisible)

Public Member Functions inherited from HtmlSemCollection

__construct ( $identifier, $tagName="div", $baseClass="")

Public Member Functions inherited from HtmlCollection

addItems ($items)

setItems ($items)

getItems ()

addItem ($item)

adds and returns an item

insertItem ($item, $position=0)

setItem ($index, $value)

removeItem ($index)

count ()

fromDatabaseObject ($object, $function)

apply ($callBack)

fromArray ($array)

setProperties ($properties)

setPropertyValues ($property, $values)

Sets the values of a property for each item in the collection.

addPropertyValues ($property, $values)

Adds the values of a property for each item in the collection.

getItemById ($identifier)

splice ($offset, $length=null)

Remove a portion of the items array and replace it with something else.

Public Member Functions inherited from HtmlDoubleElement

setContent ($content)

getContent ()

addContent ($content, $before=false)

setValue ($value)

wrapContent ($before, $after="")

wrapWith (HtmlDoubleElement $container)

Wraps the element with a container.

getContentInstances ($class)

asLink ($href=NULL, $target=NULL)

Transforms the element into a link.

getTextContent ()

asEditable (HtmlFormField $field, $asForm=false, $setValueProperty="val()")

Public Member Functions inherited from HtmlSingleElement

setClass ($classNames)

addClass ($classNames)

setRole ($value)

setTitle ($value)

setStyle ($value)

setSize ($size)

Public Member Functions inherited from BaseHtml

getTagName ()

setTagName ($tagName)

fromDatabaseObjects ($objects, $function)

wrap ($before, $after="")

getElementById ($identifier, $elements)

getBsComponent ()

setBsComponent ($bsComponent)

setDraggable ($attr="id", $dropZone=null, $parameters=[])

Sets the element draggable, and eventualy defines the dropzone (HTML5 drag and drop)

asDropZone ($jsCallback="", $jqueryDone="append", $parameters=[])

Declares the element as a drop zone (HTML5 drag and drop)

asFileDropZone ($responseElement=null, $url=null, $progress=null, $jsCallback="", $parameters=[])

Declares the element as a drop zone for file uploading (HTML5 drag and drop)

__toString ()

onPostCompile ($callback)

onPreCompile ($callback)

Public Member Functions inherited from BaseWidget

__construct ($identifier)

getIdentifier ()

setIdentifier ($identifier)

getLibraryId ()

setLibraryId ($_libraryId)

Public Member Functions inherited from BaseHtmlEventsTrait

addEvent ($event, $jsCode, $stopPropagation=false, $preventDefault=false)

trigger ($event, $params="[]")

jsTrigger ($event, $params="[this]")

_addEvent ($event, $jsCode)

on ($event, $jsCode, $stopPropagation=false, $preventDefault=false)

onClick ($jsCode, $stopPropagation=false, $preventDefault=true)

setClick ($jsCode)

onCreate ($jsCode)

addEventsOnRun (JsUtils $js=NULL)

_ajaxOn ($operation, $event, $url, $responseElement="", $parameters=array())

getOn ($event, $url, $responseElement="", $parameters=array())

Performs a get to $url on the event $event on $element and display it in $responseElement.

getOnClick ($url, $responseElement="", $parameters=array())

Performs a get to $url on the click event on $element and display it in $responseElement.

postOn ($event, $url, $params="{}", $responseElement="", $parameters=array())

Performs a post to $url on the event $event on $element and display it in $responseElement.

postOnClick ($url, $params="{}", $responseElement="", $parameters=array())

Performs a post to $url on the click event on $element and display it in $responseElement.

postFormOn ($event, $url, $form, $responseElement="", $parameters=array())

Performs a post form with ajax.

postFormOnClick ($url, $form, $responseElement="", $parameters=array())

Performs a post form with ajax on click.

jsDoJquery ($jqueryCall, $param="")

executeOnRun ($jsCode)

jsHtml ($content="")

jsShow ()

jsHide ()

jsToggle ($value)

getEvents ()

Public Member Functions inherited from BaseHtmlPropertiesTrait

getProperties ()

setProperty ($name, $value)

getProperty ($name)

addToProperty ($name, $value, $separator=" ")

addProperties ($properties)

removePropertyValue ($name, $value)

addToPropertyCtrl ($name, $value, $typeCtrl)

addToPropertyCtrlCheck ($name, $value, $typeCtrl)

removeProperty ($name)

propertyContains ($propertyName, $value)

Public Member Functions inherited from BaseTrait

addToProperty ($name, $value, $separator=" ")

setProperty ($name, $value)

addContent ($content, $before=false)

onCreate ($jsCode)

addVariation ($variation)

addState ($state)

setVariation ($variation)

setVariations ($variations)

setState ($state)

addVariations ($variations=array())

addStates ($states=array())

setStates ($states)

addIcon ($icon, $before=true)

addSticky ($context="body")

setSize ($size)

setDisabled ($disable=true)

show it is currently unable to be interacted with

setColor ($color)

setFluid ()

asHeader ()

setActive ($value=true)

show it is currently the active user selection

setAttached ($value=true)

setInverted ($recursive=true)

can be formatted to appear on dark backgrounds

setCircular ()

setFloated ($direction="right")

floatRight ()

floatLeft ()

getBaseClass ()

getVariations ()

getStates ()

Protected Member Functions
	createItem ($value)
	The item factory.

	getItemToAdd ($item)

	addFollowPoints ()

Protected Member Functions inherited from HtmlCollection
	setItemIdentifier ($item, $classname, $index)

	createCondition ($value)

	contentAs ($tagName)

Protected Member Functions inherited from HtmlDoubleElement
	_getContentInstances ($class, $content)

	compile_once (\Ajax\JsUtils $js=NULL, &$view=NULL)
	{}

Protected Member Functions inherited from BaseHtml
	getTemplate (JsUtils $js=NULL, $view=null)

	ctrl ($name, $value, $typeCtrl)

	setMemberCtrl (&$name, $value, $typeCtrl)

	addToMemberUnique (&$name, $value, $typeCtrl, $separator=" ")

	addToMemberCtrl (&$name, $value, $typeCtrl, $separator=" ")

	addToMember (&$name, $value, $separator=' ')

	removeOldValues (&$oldValue, $allValues)

	_getElementBy ($callback, $elements)

	setWrapBefore ($wrapBefore)

	setWrapAfter ($wrapAfter)

	compile_once (JsUtils $js=NULL, &$view=NULL)

Protected Member Functions inherited from BaseWidget
	cleanIdentifier ($id)

Protected Member Functions inherited from BaseHtmlEventsTrait
	_eventsOnCreate (JsUtils $js=NULL)

Protected Member Functions inherited from BaseHtmlPropertiesTrait
	removePropertyValues ($name, $values)

	addToPropertyUnique ($name, $value, $typeCtrl)

	setPropertyCtrl ($name, $value, $typeCtrl)

	getElementByPropertyValue ($propertyName, $value, $elements)

Protected Member Functions inherited from BaseTrait
	setPropertyCtrl ($name, $value, $typeCtrl)

	addToPropertyCtrl ($name, $value, $typeCtrl)

	addToPropertyCtrlCheck ($name, $value, $typeCtrl)

	addBehavior (&$array, $key, $value, $before="", $after="")

Protected Attributes
	$_hasCheckedList

	$_fireOnInit = false

	$_ckItemChange = ""

	$_maxVisible

	$_dataList

	$_visibility

Protected Attributes inherited from HtmlDoubleElement
	$content

	$wrapContentBefore = ""

	$wrapContentAfter = ""

	$_editableContent

Protected Attributes inherited from BaseHtml
	$_template

	$tagName

	$_wrapBefore = array()

	$_wrapAfter = array()

	$_bsComponent

	$_compiled = false

	$_runned = false

	$_postCompile

	$_preCompile

Protected Attributes inherited from BaseWidget
	$identifier

	$_identifier

	$_libraryId

	$_self

Protected Attributes inherited from BaseHtmlEventsTrait
	$_events =array ()

Protected Attributes inherited from BaseHtmlPropertiesTrait
	$properties =array ()

Protected Attributes inherited from BaseTrait
	$_variations =[ ]

	$_states =[ ]

	$_baseClass

Detailed Description

Definition at line 12 of file HtmlList.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$identifier,
		$items = `array()`
	)

Reimplemented from HtmlCollection.

Definition at line 26 of file HtmlList.php.

Member Function Documentation

◆ addCheckedList()

addCheckedList	(	$items = `array()`,
		$masterItem = `NULL`,
		$values = `array()`,
		$notAllChecked = `false`,
		$name = `null`
	)

Adds a grouped checked box to the list.

Parameters

array	$items
string \| array \| null	$masterItem
array	$values
string	$notAllChecked

Returns: HtmlList

Definition at line 176 of file HtmlList.php.

◆ addFollowPoints()

addFollowPoints ( )

protected

Definition at line 108 of file HtmlList.php.

◆ addHeader()

addHeader	(	$niveau,
		$content
	)

Definition at line 38 of file HtmlList.php.

◆ addList()

addList ( $items = array() )

Definition at line 59 of file HtmlList.php.

◆ asLinks()

asLinks	(	$hrefs = `[]`,
		$target = `NUll`
	)

Parameters

array	$hrefs
string	$target

Returns: HtmlCollection

Reimplemented from HtmlCollection.

Definition at line 52 of file HtmlList.php.

◆ compile()

compile	(	JsUtils	$js = `NULL`,
		&	$view = `NULL`
	)

{}

See also: \Ajax\common\html\HtmlCollection::compile()

Reimplemented from HtmlCollection.

Definition at line 153 of file HtmlList.php.

◆ createItem()

createItem ( $value )

protected

The item factory.

Parameters

mixed $value

Reimplemented from HtmlCollection.

Definition at line 32 of file HtmlList.php.

◆ getItem()

getItem ( $index )

Returns: HtmlListItem

Reimplemented from HtmlCollection.

Definition at line 69 of file HtmlList.php.

◆ getItemPart()

getItemPart	(	$index,
		$partName = `"header"`
	)

Definition at line 44 of file HtmlList.php.

◆ getItemToAdd()

getItemToAdd ( $item )

protected

Reimplemented from HtmlCollection.

Definition at line 73 of file HtmlList.php.

◆ getMaxVisible()

getMaxVisible ( )

Returns: mixed

Definition at line 238 of file HtmlList.php.

◆ itemsAs()

itemsAs ( $tagName )

Definition at line 48 of file HtmlList.php.

◆ onCkItemChange()

onCkItemChange ( $jsCode )

Definition at line 120 of file HtmlList.php.

◆ run()

run ( JsUtils $js )

Parameters

JsUtils $js

Returns: SimpleExtComponent

See also: \Ajax\common\html\BaseHtmlrun()

See also: \Ajax\common\html\BaseHtmlrun()

See also: \Ajax\common\html\BaseHtmlrun()

See also: \Ajax\common\html\BaseHtml::run()

Reimplemented from HtmlSemCollection.

Definition at line 92 of file HtmlList.php.

◆ setBulleted()

setBulleted ( )

Definition at line 84 of file HtmlList.php.

◆ setCelled()

setCelled ( )

Definition at line 80 of file HtmlList.php.

◆ setDivided()

setDivided ( )

Definition at line 140 of file HtmlList.php.

◆ setFireOnInit()

setFireOnInit ( $fireOnInit )

Parameters

boolean $fireOnInit

Definition at line 128 of file HtmlList.php.

◆ setHorizontal()

setHorizontal ( )

Definition at line 144 of file HtmlList.php.

◆ setIcons()

setIcons ( $icons )

Definition at line 223 of file HtmlList.php.

◆ setMaxVisible()

setMaxVisible ( $_maxVisible )

Parameters

mixed $_maxVisible

Definition at line 246 of file HtmlList.php.

◆ setOrdered()

setOrdered ( )

Definition at line 88 of file HtmlList.php.

◆ setRelaxed()

setRelaxed ( )

Definition at line 132 of file HtmlList.php.

◆ setSelection()

setSelection ( )

Definition at line 136 of file HtmlList.php.

Field Documentation

◆ $_ckItemChange

$_ckItemChange = ""

protected

Definition at line 18 of file HtmlList.php.

◆ $_dataList

$_dataList

protected

Definition at line 22 of file HtmlList.php.

◆ $_fireOnInit

$_fireOnInit = false

protected

Definition at line 16 of file HtmlList.php.

◆ $_hasCheckedList

$_hasCheckedList

protected

Definition at line 14 of file HtmlList.php.

◆ $_maxVisible

$_maxVisible

protected

Definition at line 20 of file HtmlList.php.

◆ $_visibility

$_visibility

protected

Definition at line 24 of file HtmlList.php.

The documentation for this class was generated from the following file:

Ajax/semantic/html/elements/HtmlList.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCheckedList()

◆ addFollowPoints()

◆ addHeader()

◆ addList()

◆ asLinks()

◆ compile()

◆ createItem()

◆ getItem()

◆ getItemPart()

◆ getItemToAdd()

◆ getMaxVisible()

◆ itemsAs()

◆ onCkItemChange()

◆ run()

◆ setBulleted()

◆ setCelled()

◆ setDivided()

◆ setFireOnInit()

◆ setHorizontal()

◆ setIcons()

◆ setMaxVisible()

◆ setOrdered()

◆ setRelaxed()

◆ setSelection()

Field Documentation

◆ $_ckItemChange

◆ $_dataList

◆ $_fireOnInit

◆ $_hasCheckedList

◆ $_maxVisible

◆ $_visibility