Twitter Bootstrap HTML Dropdown component. More...

Inheritance diagram for HtmlDropdown:

Public Member Functions

__construct ($identifier, $value="", $items=array(), $cssStyle=null, $onClick=null)

setMTagName ($value)

Define the tagName of the main element.

setStyle ($cssStyle)

define the button style avaible values : "btn-default","btn-primary","btn-success","btn-info","btn-warning","btn-danger"

setValue ($value)

Set the button value.

setSize ($size)

define the buttons size available values : "btn-group-lg","","btn-group-sm","btn-group-xs"

addItem ($caption, $href="#")

add an HtmlDropdownItem

addDivider ()

addHeader ($caption)

addItems ($items)

fromArray ($array)

setItems ($items)

getItem ($index)

Return the item at $index.

setBtnClass ($value)

setMClass ($value)

addBtnClass ($value)

addmClass ($value)

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

setTagName ($tagName)

Sets the tagName's dropdown.

__toString ()

setBtnCaption ($btnCaption)

getItemsCount ()

setAlignment ($alignment)

dropup ()

getItems ()

asButton ($cssStyle="btn-primary")

onShow ($jsCode)

This event fires immediately when the show instance method is called.

onShown ($jsCode)

This event is fired when a dropdown element has been made visible to the user (will wait for CSS transitions to complete).

onHide ($jsCode)

This event is fired immediately when the hide method has been called.

onHidden ($jsCode)

This event is fired when a dropdown element has been hidden from the user (will wait for CSS transitions to complete).

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

fromDatabaseObject ($object, $function)

Public Member Functions inherited from HtmlButton

__construct ($identifier, $value="", $cssStyle=null, $onClick=null)

Constructs an HTML Bootstrap button.

setActive ()

Sets the "active" css class to the button.

setDisabled ()

Disables the button.

setToggled ()

Public Member Functions inherited from HtmlBsDoubleElement

addBadge ($caption, $leftSeparator=" ")

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

addGlyph ($glyphicon, $before=true)

wrapContentWithGlyph ($glyphBefore, $glyphAfter="")

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)

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)

Public Member Functions inherited from BaseHtml

getTagName ()

fromDatabaseObjects ($objects, $function)

wrap ($before, $after="")

getElementById ($identifier, $elements)

getBsComponent ()

setBsComponent ($bsComponent)

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

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)

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

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)

Protected Attributes
	$btnCaption ="Dropdown button"

	$class ="dropdown-toggle"

	$mClass ="dropdown"

	$mTagName ="div"

	$items =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 ()

Additional Inherited Members
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)

Detailed Description

Twitter Bootstrap HTML Dropdown component.

Author: jc

Version: 1.001

Definition at line 16 of file HtmlDropdown.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$identifier,
		$value = `""`,
		$items = `array()`,
		$cssStyle = `null`,
		$onClick = `null`
	)

Parameters

string $identifier the id

Reimplemented in HtmlSplitbutton.

Definition at line 27 of file HtmlDropdown.php.

Member Function Documentation

◆ __toString()

__toString ( )

Reimplemented from BaseHtml.

Definition at line 194 of file HtmlDropdown.php.

◆ addBtnClass()

addBtnClass ( $value )

Definition at line 161 of file HtmlDropdown.php.

◆ addDivider()

addDivider ( )

Definition at line 102 of file HtmlDropdown.php.

◆ addHeader()

addHeader ( $caption )

Definition at line 106 of file HtmlDropdown.php.

◆ addItem()

addItem	(	$caption,
		$href = `"#"`
	)

add an HtmlDropdownItem

Parameters

string	$caption
string	$href

Returns: HtmlDropdownItem

Definition at line 90 of file HtmlDropdown.php.

◆ addItems()

addItems ( $items )

Definition at line 110 of file HtmlDropdown.php.

◆ addmClass()

addmClass ( $value )

Definition at line 165 of file HtmlDropdown.php.

◆ asButton()

asButton ( $cssStyle = "btn-primary" )

Definition at line 221 of file HtmlDropdown.php.

◆ dropup()

dropup ( )

Definition at line 213 of file HtmlDropdown.php.

◆ fromArray()

fromArray ( $array )

Reimplemented from HtmlButton.

Definition at line 132 of file HtmlDropdown.php.

◆ fromDatabaseObject()

fromDatabaseObject	(	$object,
		$function
	)

Reimplemented from BaseHtml.

Definition at line 276 of file HtmlDropdown.php.

◆ getItem()

getItem ( $index )

Return the item at $index.

Parameters

int $index

Returns: HtmlDropdownItem

Definition at line 149 of file HtmlDropdown.php.

◆ getItems()

getItems ( )

Definition at line 217 of file HtmlDropdown.php.

◆ getItemsCount()

getItemsCount ( )

Definition at line 203 of file HtmlDropdown.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 267 of file HtmlDropdown.php.

◆ onHidden()

onHidden ( $jsCode )

This event is fired when a dropdown element has been hidden from the user (will wait for CSS transitions to complete).

Parameters

string $jsCode

Returns: $this

Definition at line 259 of file HtmlDropdown.php.

◆ onHide()

onHide ( $jsCode )

This event is fired immediately when the hide method has been called.

Parameters

string $jsCode

Returns: $this

Definition at line 250 of file HtmlDropdown.php.

◆ onShow()

onShow ( $jsCode )

This event fires immediately when the show instance method is called.

Parameters

string $jsCode

Returns: $this

Definition at line 232 of file HtmlDropdown.php.

◆ onShown()

onShown ( $jsCode )

This event is fired when a dropdown element has been made visible to the user (will wait for CSS transitions to complete).

Parameters

string $jsCode

Returns: $this

Definition at line 241 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: \Ajax\common\html\BaseHtmlrun()

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

Reimplemented from HtmlButton.

Reimplemented in HtmlSplitbutton.

Definition at line 173 of file HtmlDropdown.php.

◆ setAlignment()

setAlignment ( $alignment )

Definition at line 207 of file HtmlDropdown.php.

◆ setBtnCaption()

setBtnCaption ( $btnCaption )

Definition at line 198 of file HtmlDropdown.php.

◆ setBtnClass()

setBtnClass ( $value )

Definition at line 153 of file HtmlDropdown.php.

◆ setItems()

setItems ( $items )

Definition at line 139 of file HtmlDropdown.php.

◆ setMClass()

setMClass ( $value )

Definition at line 157 of file HtmlDropdown.php.

◆ setMTagName()

setMTagName ( $value )

Define the tagName of the main element.

Parameters

string $value default : div

Definition at line 42 of file HtmlDropdown.php.

◆ setSize()

setSize ( $size )

define the buttons size available values : "btn-group-lg","","btn-group-sm","btn-group-xs"

Parameters

string | int $size

Returns: HtmlDropdown default : ""

Reimplemented from HtmlButton.

Reimplemented in HtmlSplitbutton.

Definition at line 77 of file HtmlDropdown.php.

◆ setStyle()

setStyle ( $cssStyle )

define the button style avaible values : "btn-default","btn-primary","btn-success","btn-info","btn-warning","btn-danger"

Parameters

string | int $cssStyle

Returns: \Ajax\bootstrap\html\HtmlDropdown default : "btn-default"

Reimplemented from HtmlButton.

Definition at line 52 of file HtmlDropdown.php.

◆ setTagName()

setTagName ( $tagName )

Sets the tagName's dropdown.

See also: BaseHtml::setTagName()

Reimplemented from BaseHtml.

Definition at line 188 of file HtmlDropdown.php.

◆ setValue()

setValue ( $value )

Set the button value.

Parameters

string $value

Returns: \Ajax\bootstrap\html\HtmlButton

Reimplemented from HtmlButton.

Definition at line 66 of file HtmlDropdown.php.

Field Documentation

◆ $btnCaption

$btnCaption ="Dropdown button"

protected

Definition at line 17 of file HtmlDropdown.php.

◆ $class

$class ="dropdown-toggle"

protected

Definition at line 18 of file HtmlDropdown.php.

◆ $items

$items =array ()

protected

Definition at line 21 of file HtmlDropdown.php.

◆ $mClass

$mClass ="dropdown"

protected

Definition at line 19 of file HtmlDropdown.php.

◆ $mTagName

$mTagName ="div"

protected

Definition at line 20 of file HtmlDropdown.php.

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

Ajax/bootstrap/html/HtmlDropdown.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ addBtnClass()

◆ addDivider()

◆ addHeader()

◆ addItem()

◆ addItems()

◆ addmClass()

◆ asButton()

◆ dropup()

◆ fromArray()

◆ fromDatabaseObject()

◆ getItem()

◆ getItems()

◆ getItemsCount()

◆ on()

◆ onHidden()

◆ onHide()

◆ onShow()

◆ onShown()

◆ run()

◆ setAlignment()

◆ setBtnCaption()

◆ setBtnClass()

◆ setItems()

◆ setMClass()

◆ setMTagName()

◆ setSize()

◆ setStyle()

◆ setTagName()

◆ setValue()

Field Documentation

◆ $btnCaption

◆ $class

◆ $items

◆ $mClass

◆ $mTagName