HtmlButton Class Reference

Twitter Bootstrap Button component. More...

Inheritance diagram for HtmlButton:

Public Member Functions
	__construct ($identifier, $value="", $cssStyle=null, $onClick=null)
	Constructs an HTML Bootstrap button.
	setValue ($value)
	Set the button value.
	setStyle ($cssStyle)
	define the button style avaible values : "btn-default","btn-primary","btn-success","btn-info","btn-warning","btn-danger"
	setSize ($size)
	define the button size available values : "btn-lg","","btn-sm","btn-xs"
	setActive ()
	Sets the "active" css class to the button.
	setDisabled ()
	Disables the button.
	setToggled ()
	run (JsUtils $js)
	Parameters JsUtils $js Returns SimpleExtComponent See also \Ajax\common\html\BaseHtmlrun() See also \Ajax\common\html\BaseHtmlrun()
	fromArray ($array)
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 ()
	setTagName ($tagName)
	fromDatabaseObjects ($objects, $function)
	fromDatabaseObject ($object, $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)
	__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)

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

Detailed Description

Twitter Bootstrap Button component.

See also

http://getbootstrap.com/css/#buttons

Author

jc

Version

1.001

Definition at line 15 of file HtmlButton.php.

Constructor & Destructor Documentation

__construct()

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

Constructs an HTML Bootstrap button.

Parameters

string	$identifier	HTML id
string	$value	value of the Button
string	$cssStyle	btn-default, btn-primary...
string	$onClick	JS Code for click event

Definition at line 24 of file HtmlButton.php.

Member Function Documentation

fromArray()

fromArray

(

$array

)

Reimplemented from HtmlSingleElement.

Reimplemented in HtmlDropdown.

Definition at line 113 of file HtmlButton.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\BaseHtml::run()

Reimplemented from HtmlDoubleElement.

Reimplemented in HtmlDropdown, and HtmlSplitbutton.

Definition at line 98 of file HtmlButton.php.

setActive()

setActive

(

)

Sets the "active" css class to the button.

Returns

\Ajax\bootstrap\html\HtmlButton

Definition at line 74 of file HtmlButton.php.

setDisabled()

setDisabled

(

)

Disables the button.

Returns

\Ajax\bootstrap\html\HtmlButton

Definition at line 84 of file HtmlButton.php.

setSize()

setSize

(

$size

)

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

Parameters

string | int

$size

Returns

\Ajax\bootstrap\html\HtmlButton default : ""

Reimplemented from HtmlSingleElement.

Reimplemented in HtmlDropdown, and HtmlSplitbutton.

Definition at line 63 of file HtmlButton.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\HtmlButton default : "btn-default"

Reimplemented from HtmlSingleElement.

Reimplemented in HtmlDropdown.

Definition at line 53 of file HtmlButton.php.

setToggled()

setToggled

(

)

Definition at line 90 of file HtmlButton.php.

setValue()

setValue

(

$value

)

Set the button value.

Parameters

string

$value

Returns

\Ajax\bootstrap\html\HtmlButton

Reimplemented from HtmlDoubleElement.

Reimplemented in HtmlDropdown.

Definition at line 42 of file HtmlButton.php.

---

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

• Ajax/bootstrap/html/HtmlButton.php