Inheritance diagram for HtmlDropdown:

Public Member Functions

__construct ($identifier, $value="", $items=array(), $associative=true)

getField ()

getDataField ()

addItem ($item, $value=NULL, $image=NULL, $description=NULL)

addIcon ($icon, $before=true, $labeled=false)

Adds an icon before or after.

addIcons ($icons)

insertItem ($item, $position=0)

Insert an item at a position.

fromDatabaseObject ($object, $function)

addInput ($name)

addSearchInputItem ($placeHolder=NULL, $icon=NULL)

Adds a search input item.

addDividerItem ()

Adds a divider item.

addHeaderItem ($caption=NULL, $icon=NULL)

Adds an header item.

addCircularLabelItem ($caption, $color)

Adds an item with a circular label.

addMiniAvatarImageItem ($caption, $image)

addItems ($items)

setPropertyValues ($property, $values)

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

each ($callBack)

getItem ($index)

count ()

asDropdown ($dropdown)

setVertical ()

setInline ()

setSimple ()

asButton ($floating=false)

asSelect ($name=NULL, $multiple=false, $selection=true)

asSearch ($name=NULL, $multiple=false, $selection=true)

setSelect ($name=NULL, $multiple=false)

asSubmenu ($pointing=NULL)

setPointing ($value=Direction::NONE)

setValue ($value)

setDefaultText ($text)

run (JsUtils $js)

{{

Parameters

JsUtils $js

Returns: SimpleExtComponent

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

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

}

See also: HtmlDoubleElement::run()

}

setCompact ()

setAction ($action)

setOn ($on)

setShowOnFocus ($value)

setAllowAdditions ($value)

setFullTextSearch ($value)

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

{{}

See also: BaseHtml::compile()

}

getInput ()

setIcon ($icon="dropdown")

jsAddItem ($caption, $value=null)

setClearable ($value)

setOnAdd ($jsCode)

Is called after a dropdown selection is added using a multiple select dropdown, only receives the added value Parameters addedValue, addedText, $addedChoice.

setOnRemove ($jsCode)

Is called after a dropdown selection is removed using a multiple select dropdown, only receives the removed value Parameters removedValue, removedText, $removedChoice.

Public Member Functions inherited from HtmlSemDoubleElement

setPopupAttributes ($variation=NULL, $popupEvent=NULL)

Defines the popup attributes.

addPopup ($title="", $content="", $variation=NULL, $params=array())

Adds a popup to the element.

addPopupHtml ($html="", $variation=NULL, $params=array())

Adds an html popup to the element.

addDimmer ($params=array(), $content=NULL)

Adds a Dimmer to the element.

addLabel ($label, $before=false, $icon=NULL)

Adds a label to the element.

attachLabel ($label, $side=Side::TOP, $direction=Direction::NONE, $icon=NULL)

Adds an attached label to the element.

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

Transforms the element into a link.

jsShowDimmer ($show=true)

Returns the script displaying the dimmer.

addList ($items, $ordered=false)

asToast ($params=NULL)

asSideBar ($classes='')

Public Member Functions inherited from HtmlDoubleElement

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

setContent ($content)

getContent ()

addContent ($content, $before=false)

wrapContent ($before, $after="")

wrapWith (HtmlDoubleElement $container)

Wraps the element with a container.

getContentInstances ($class)

getTextContent ()

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

Public Member Functions inherited from HtmlSingleElement

setClass ($classNames)

addClass ($classNames)

setRole ($value)

setTitle ($value)

setStyle ($value)

fromArray ($array)

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

setProperties ($properties)

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

Public Member Functions inherited from FieldTrait

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

addLabel ($caption, $style="label-default", $leftSeparator=" ")

addContent ($content, $before=false)

setFocus ()

addLoading ()

labeled ($label, $direction=Direction::LEFT, $icon=NULL)

labeledCheckbox ($direction=Direction::LEFT, $caption="", $value=NULL, $checkboxType=NULL)

labeledToCorner ($icon, $direction=Direction::LEFT)

addAction ($action, $direction=Direction::RIGHT, $icon=NULL, $labeled=false)

addDropdown ($label="", $items=array(), $direction=Direction::RIGHT)

setTransparent ()

setReadonly ()

setName ($name)

setFluid ()

setDisabled ($disable=true)

setJsContent ($content)

getJsContent ()

asFile ($caption='', $direction=Direction::RIGHT, $icon='cloud upload alternate', $labeled=false)

Public Member Functions inherited from LabeledIconTrait

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

addContent ($content, $before=false)

Data Fields
addIcon as	addIconP

Protected Member Functions
	removeArrow ()

	beforeAddItem ($item, $value=NULL, $image=NULL, $description=NULL)

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
	$mTagName = "div"

	$items = array()

	$_params

	$input

	$value

	$_associative

	$_multiple

Protected Attributes inherited from HtmlSemDoubleElement
	$_popup = NULL

	$_dimmer = NULL

	$_toast = NULL

	$_sidebar = NULL

	$_params = array()

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

Private Member Functions
	applyValue ()

Detailed Description

Definition at line 15 of file HtmlDropdown.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$identifier,
		$value = `""`,
		$items = `array()`,
		$associative = `true`
	)

Reimplemented from HtmlSemDoubleElement.

Definition at line 39 of file HtmlDropdown.php.

Member Function Documentation

◆ addCircularLabelItem()

addCircularLabelItem	(	$caption,
		$color
	)

Adds an item with a circular label.

Parameters

string	$caption
string	$color

Returns: HtmlDropdownItem

Definition at line 190 of file HtmlDropdown.php.

◆ addDividerItem()

addDividerItem ( )

Adds a divider item.

Returns: HtmlDropdownItem

Definition at line 168 of file HtmlDropdown.php.

◆ addHeaderItem()

addHeaderItem	(	$caption = `NULL`,
		$icon = `NULL`
	)

Adds an header item.

Parameters

string	$caption
string	$icon

Returns: HtmlDropdownItem

Definition at line 179 of file HtmlDropdown.php.

◆ addIcon()

addIcon	(	$icon,
		$before = `true`,
		$labeled = `false`
	)

Adds an icon before or after.

Parameters

string \| HtmlIcon	$icon
boolean	$before
boolean	$labeled

Returns: \Ajax\semantic\html\elements\HtmlIcon

Reimplemented from LabeledIconTrait.

Definition at line 79 of file HtmlDropdown.php.

◆ addIcons()

addIcons ( $icons )

Definition at line 89 of file HtmlDropdown.php.

◆ addInput()

addInput ( $name )

Definition at line 143 of file HtmlDropdown.php.

◆ addItem()

addItem	(	$item,
		$value = `NULL`,
		$image = `NULL`,
		$description = `NULL`
	)

Definition at line 73 of file HtmlDropdown.php.

◆ addItems()

addItems ( $items )

Definition at line 204 of file HtmlDropdown.php.

◆ addMiniAvatarImageItem()

addMiniAvatarImageItem	(	$caption,
		$image
	)

Parameters

string	$caption
string	$image

Returns: \Ajax\semantic\html\content\HtmlDropdownItem

Definition at line 200 of file HtmlDropdown.php.

◆ addSearchInputItem()

addSearchInputItem	(	$placeHolder = `NULL`,
		$icon = `NULL`
	)

Adds a search input item.

Parameters

string	$placeHolder
string	$icon

Returns: HtmlDropdownItem

Definition at line 159 of file HtmlDropdown.php.

◆ applyValue()

applyValue ( )

private

Definition at line 364 of file HtmlDropdown.php.

◆ asButton()

asButton ( $floating = false )

Definition at line 294 of file HtmlDropdown.php.

◆ asDropdown()

asDropdown ( $dropdown )

Parameters

boolean $dropdown

Definition at line 262 of file HtmlDropdown.php.

◆ asSearch()

asSearch	(	$name = `NULL`,
		$multiple = `false`,
		$selection = `true`
	)

Definition at line 318 of file HtmlDropdown.php.

◆ asSelect()

asSelect	(	$name = `NULL`,
		$multiple = `false`,
		$selection = `true`
	)

Definition at line 302 of file HtmlDropdown.php.

◆ asSubmenu()

asSubmenu ( $pointing = NULL )

Definition at line 342 of file HtmlDropdown.php.

◆ beforeAddItem()

beforeAddItem	(	$item,
		$value = `NULL`,
		$image = `NULL`,
		$description = `NULL`
	)

protected

Definition at line 119 of file HtmlDropdown.php.

◆ compile()

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

{{}

See also: BaseHtml::compile()

}

See also: BaseHtml::compile()

Reimplemented from HtmlSemDoubleElement.

Definition at line 423 of file HtmlDropdown.php.

◆ count()

count ( )

Returns: int

Definition at line 254 of file HtmlDropdown.php.

◆ each()

each ( $callBack )

Definition at line 239 of file HtmlDropdown.php.

◆ fromDatabaseObject()

fromDatabaseObject	(	$object,
		$function
	)

Reimplemented from BaseHtml.

Definition at line 139 of file HtmlDropdown.php.

◆ getDataField()

getDataField ( )

Reimplemented from FieldTrait.

Definition at line 69 of file HtmlDropdown.php.

◆ getField()

getField ( )

Reimplemented from FieldTrait.

Definition at line 65 of file HtmlDropdown.php.

◆ getInput()

getInput ( )

Definition at line 428 of file HtmlDropdown.php.

◆ getItem()

getItem ( $index )

Definition at line 246 of file HtmlDropdown.php.

◆ insertItem()

insertItem	(	$item,
		$position = `0`
	)

Insert an item at a position.

Parameters

mixed	$item
int	$position

Returns: HtmlDropdownItem

Definition at line 103 of file HtmlDropdown.php.

◆ jsAddItem()

jsAddItem	(	$caption,
		$value = `null`
	)

Definition at line 437 of file HtmlDropdown.php.

◆ removeArrow()

removeArrow ( )

protected

Definition at line 112 of file HtmlDropdown.php.

◆ run()

run ( JsUtils $js )

{{

Parameters

JsUtils $js

Returns: SimpleExtComponent

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

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

}

See also: HtmlDoubleElement::run()

}

See also: HtmlDoubleElement::run()

Reimplemented from HtmlSemDoubleElement.

Definition at line 381 of file HtmlDropdown.php.

◆ setAction()

setAction ( $action )

Definition at line 398 of file HtmlDropdown.php.

◆ setAllowAdditions()

setAllowAdditions ( $value )

Definition at line 413 of file HtmlDropdown.php.

◆ setClearable()

setClearable ( $value )

Definition at line 443 of file HtmlDropdown.php.

◆ setCompact()

setCompact ( )

Definition at line 392 of file HtmlDropdown.php.

◆ setDefaultText()

setDefaultText ( $text )

Definition at line 359 of file HtmlDropdown.php.

◆ setFullTextSearch()

setFullTextSearch ( $value )

Definition at line 418 of file HtmlDropdown.php.

◆ setIcon()

setIcon ( $icon = "dropdown" )

Definition at line 432 of file HtmlDropdown.php.

◆ setInline()

setInline ( )

Definition at line 282 of file HtmlDropdown.php.

◆ setOn()

setOn ( $on )

Definition at line 403 of file HtmlDropdown.php.

◆ setOnAdd()

setOnAdd ( $jsCode )

Is called after a dropdown selection is added using a multiple select dropdown, only receives the added value Parameters addedValue, addedText, $addedChoice.

Definition at line 452 of file HtmlDropdown.php.

◆ setOnRemove()

setOnRemove ( $jsCode )

Is called after a dropdown selection is removed using a multiple select dropdown, only receives the removed value Parameters removedValue, removedText, $removedChoice.

Definition at line 461 of file HtmlDropdown.php.

◆ setPointing()

setPointing ( $value = Direction::NONE )

Definition at line 350 of file HtmlDropdown.php.

◆ setPropertyValues()

setPropertyValues	(	$property,
		$values
	)

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

Parameters

string	$property
array \| mixed	$values

Returns: $this

Definition at line 223 of file HtmlDropdown.php.

◆ setSelect()

setSelect	(	$name = `NULL`,
		$multiple = `false`
	)

Definition at line 323 of file HtmlDropdown.php.

◆ setShowOnFocus()

setShowOnFocus ( $value )

Definition at line 408 of file HtmlDropdown.php.

◆ setSimple()

setSimple ( )

Definition at line 288 of file HtmlDropdown.php.

◆ setValue()

setValue ( $value )

Reimplemented from HtmlDoubleElement.

Definition at line 354 of file HtmlDropdown.php.

◆ setVertical()

setVertical ( )

Definition at line 276 of file HtmlDropdown.php.

Field Documentation

◆ $_associative

$_associative

protected

Definition at line 35 of file HtmlDropdown.php.

◆ $_multiple

$_multiple

protected

Definition at line 37 of file HtmlDropdown.php.

◆ $_params

$_params

protected

Initial value:

= array(
        "action" => "nothing",
        "on" => "hover",
        "showOnFocus" => true
    )

Definition at line 25 of file HtmlDropdown.php.

◆ $input

$input

protected

Definition at line 31 of file HtmlDropdown.php.

◆ $items

$items = array()

protected

Definition at line 23 of file HtmlDropdown.php.

◆ $mTagName

$mTagName = "div"

protected

Definition at line 21 of file HtmlDropdown.php.

◆ $value

$value

protected

Definition at line 33 of file HtmlDropdown.php.

◆ addIconP

addIcon as addIconP

Initial value:

{
    }
 
    protected $mClass = "menu"

Definition at line 16 of file HtmlDropdown.php.

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

Ajax/semantic/html/modules/HtmlDropdown.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCircularLabelItem()

◆ addDividerItem()

◆ addHeaderItem()

◆ addIcon()

◆ addIcons()

◆ addInput()

◆ addItem()

◆ addItems()

◆ addMiniAvatarImageItem()

◆ addSearchInputItem()

◆ applyValue()

◆ asButton()

◆ asDropdown()

◆ asSearch()

◆ asSelect()

◆ asSubmenu()

◆ beforeAddItem()

◆ compile()

◆ count()

◆ each()

◆ fromDatabaseObject()

◆ getDataField()

◆ getField()

◆ getInput()

◆ getItem()

◆ insertItem()

◆ jsAddItem()

◆ removeArrow()

◆ run()

◆ setAction()

◆ setAllowAdditions()

◆ setClearable()

◆ setCompact()

◆ setDefaultText()

◆ setFullTextSearch()

◆ setIcon()

◆ setInline()

◆ setOn()

◆ setOnAdd()

◆ setOnRemove()

◆ setPointing()

◆ setPropertyValues()

◆ setSelect()

◆ setShowOnFocus()

◆ setSimple()

◆ setValue()

◆ setVertical()

Field Documentation

◆ $_associative

◆ $_multiple

◆ $_params

◆ $input

◆ $items

◆ $mTagName

◆ $value

◆ addIconP