Semantic UI Buttongroups component. More...

Inheritance diagram for HtmlButtonGroups:

Public Member Functions

__construct ($identifier, $elements=array(), $asIcons=false)

addDropdown ($items, $asCombo=false)

addElement ($element, $asIcon=false)

addElements ($elements, $asIcons=false)

insertOr ($aferIndex=0, $or="or")

fromArray ($array)

asIcons ()

addIcons ($icons)

Adds an icon on each button.

setVertical ()

setLabeled ()

getElement ($index)

Return the element at index.

getItem ($index)

setElement ($index, $button)

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

getElements ()

addClasses ($classes=array())

fromDatabaseObject ($object, $function)

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()

getDropdown ()

Public Member Functions inherited from HtmlCollection

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

addItems ($items)

setItems ($items)

getItems ()

addItem ($item)

adds and returns an item

insertItem ($item, $position=0)

setItem ($index, $value)

removeItem ($index)

count ()

apply ($callBack)

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.

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

getItemById ($identifier)

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

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)

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.

Protected Member Functions inherited from HtmlCollection
	getItemToAdd ($item)

	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
	$_dropdown

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

Semantic UI Buttongroups component.

See also: http://phpmv-ui.kobject.net/index/direct/main/50; http://semantic-ui.com/elements/button.html

Author: jc

Version: 1.002

Definition at line 17 of file HtmlButtonGroups.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$identifier,
		$elements = `array()`,
		$asIcons = `false`
	)

Reimplemented from HtmlSemCollection.

Definition at line 19 of file HtmlButtonGroups.php.

Member Function Documentation

◆ addClasses()

addClasses ( $classes = array() )

Definition at line 145 of file HtmlButtonGroups.php.

◆ addDropdown()

addDropdown	(	$items,
		$asCombo = `false`
	)

Parameters

array	$items
boolean	$asCombo

Returns: HtmlDropdown|HtmlButton

Definition at line 34 of file HtmlButtonGroups.php.

◆ addElement()

addElement	(	$element,
		$asIcon = `false`
	)

Parameters

mixed	$element
boolean	$asIcon

Returns: HtmlButton|HtmlDropdown

Definition at line 51 of file HtmlButtonGroups.php.

◆ addElements()

addElements	(	$elements,
		$asIcons = `false`
	)

Definition at line 58 of file HtmlButtonGroups.php.

◆ addIcons()

addIcons ( $icons )

Adds an icon on each button.

Parameters

array $icons

Returns: HtmlButtonGroups

Definition at line 93 of file HtmlButtonGroups.php.

◆ asIcons()

asIcons ( )

Definition at line 80 of file HtmlButtonGroups.php.

◆ createItem()

createItem ( $value )

protected

The item factory.

Parameters

mixed $value

Reimplemented from HtmlCollection.

Definition at line 25 of file HtmlButtonGroups.php.

◆ fromArray()

fromArray ( $array )

Reimplemented from HtmlCollection.

Definition at line 76 of file HtmlButtonGroups.php.

◆ fromDatabaseObject()

fromDatabaseObject	(	$object,
		$function
	)

Reimplemented from HtmlCollection.

Definition at line 160 of file HtmlButtonGroups.php.

◆ getDropdown()

getDropdown ( )

Definition at line 169 of file HtmlButtonGroups.php.

◆ getElement()

getElement ( $index )

Return the element at index.

Parameters

int $index

Returns: HtmlButton

Definition at line 114 of file HtmlButtonGroups.php.

◆ getElements()

getElements ( )

Definition at line 141 of file HtmlButtonGroups.php.

◆ getItem()

getItem ( $index )

Returns: HtmlButton

Reimplemented from HtmlCollection.

Definition at line 121 of file HtmlButtonGroups.php.

◆ insertOr()

insertOr	(	$aferIndex = `0`,
		$or = `"or"`
	)

Definition at line 65 of file HtmlButtonGroups.php.

◆ on()

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

Parameters

string	$event
string	$jsCode
boolean	$stopPropagation
boolean	$preventDefault

Returns: BaseHtml

Reimplemented from BaseHtmlEventsTrait.

Definition at line 134 of file HtmlButtonGroups.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 164 of file HtmlButtonGroups.php.

◆ setElement()

setElement	(	$index,
		$button
	)

Definition at line 125 of file HtmlButtonGroups.php.

◆ setLabeled()

setLabeled ( )

Definition at line 105 of file HtmlButtonGroups.php.

◆ setVertical()

setVertical ( )

Definition at line 101 of file HtmlButtonGroups.php.

Field Documentation

◆ $_dropdown

$_dropdown

protected

Definition at line 18 of file HtmlButtonGroups.php.

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

Ajax/semantic/html/elements/HtmlButtonGroups.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addClasses()

◆ addDropdown()

◆ addElement()

◆ addElements()

◆ addIcons()

◆ asIcons()

◆ createItem()

◆ fromArray()

◆ fromDatabaseObject()

◆ getDropdown()

◆ getElement()

◆ getElements()

◆ getItem()

◆ insertOr()

◆ on()

◆ run()

◆ setElement()

◆ setLabeled()

◆ setVertical()

Field Documentation

◆ $_dropdown