Semantic Button component. More...

Inheritance diagram for HtmlButton:

Public Member Functions

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

Constructs an HTML Semantic button.

setValue ($value)

Set the button value.

setStyle ($cssStyle)

define the button style

setFocusable ($value=true)

setAnimated ($content, $animation="")

asIcon ($icon)

asSubmit ()

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

Add and return a button label.

fromArray ($array)

setPositive ()

hint towards a positive consequence

setColor ($color)

setNegative ()

hint towards a negative consequence

setToggle ($active="")

formatted to toggle on/off

setCircular ()

setBasic ()

button is less pronounced

setEmphasis ($value)

setLoading ()

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

{Transforms the element into a link.

Returns: HtmlSemDoubleElement

}

addPopupConfirmation ($message, $buttons=["Okay","Cancel"])

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.

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

Adds an attached label to the element.

jsShowDimmer ($show=true)

Returns the script displaying the dimmer.

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

{}

run (JsUtils $js)

{

Parameters

JsUtils $js

Returns: SimpleExtComponent

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

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

}

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)

setSize ($size)

Public Member Functions inherited from BaseHtml

getTagName ()

setTagName ($tagName)

fromDatabaseObjects ($objects, $function)

fromDatabaseObject ($object, $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

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

setFloated ($direction="right")

floatRight ()

floatLeft ()

getBaseClass ()

getVariations ()

getStates ()

Public Member Functions inherited from LabeledIconTrait

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

addContent ($content, $before=false)

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

Adds an icon before or after.

Static Public Member Functions
static	social ($identifier, $social, $value=NULL)
	Returns a new social Button.

static	labeled ($identifier, $value, $icon, $before=true)
	Returns a new labeled Button.

static	icon ($identifier, $icon)
	Returns a new icon Button.

static	dropdown ($identifier, $value, $items=[], $asCombo=false, $icon=null)
	Returns a button with a dropdown button.

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

Detailed Description

Semantic Button component.

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

Author: jc

Version: 1.001

Definition at line 18 of file HtmlButton.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructs an HTML Semantic 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

Reimplemented from HtmlSemDoubleElement.

Definition at line 32 of file HtmlButton.php.

Member Function Documentation

◆ addLabel()

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

Add and return a button label.

Parameters

string	$label
boolean	$before
string	$icon

Returns: HtmlLabel

Reimplemented from HtmlSemDoubleElement.

Definition at line 125 of file HtmlButton.php.

◆ addPopupConfirmation()

addPopupConfirmation	(	$message,
		$buttons = `["Okay","Cancel"]`
	)

Definition at line 293 of file HtmlButton.php.

◆ asIcon()

asIcon ( $icon )

Parameters

string | HtmlIcon $icon

Returns: HtmlButton

Definition at line 102 of file HtmlButton.php.

◆ asLink()

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

{Transforms the element into a link.

Returns: HtmlSemDoubleElement

}

See also: HtmlSemDoubleElement::asLink()

Reimplemented from HtmlSemDoubleElement.

Definition at line 268 of file HtmlButton.php.

◆ asSubmit()

asSubmit ( )

Definition at line 112 of file HtmlButton.php.

◆ dropdown()

static dropdown	(	$identifier,
		$value,
		$items = `[]`,
		$asCombo = `false`,
		$icon = `null`
	)

static

Returns a button with a dropdown button.

Parameters

string	$identifier
string	$value
array	$items
boolean	$asCombo
string	$icon

Returns: HtmlButtonGroups

Definition at line 283 of file HtmlButton.php.

◆ fromArray()

fromArray ( $array )

Reimplemented from HtmlSingleElement.

Definition at line 147 of file HtmlButton.php.

◆ icon()

static icon	(	$identifier,
		$icon
	)

static

Returns a new icon Button.

Parameters

string	$identifier
string	$icon

Returns: HtmlButton

Definition at line 257 of file HtmlButton.php.

◆ labeled()

static labeled	(	$identifier,
		$value,
		$icon,
		$before = `true`
	)

static

Returns a new labeled Button.

Parameters

string	$identifier
string	$value
string	$icon
boolean	$before

Returns: \Ajax\semantic\html\elements\HtmlButton

Definition at line 244 of file HtmlButton.php.

◆ setAnimated()

setAnimated	(	$content,
		$animation = `""`
	)

Definition at line 81 of file HtmlButton.php.

◆ setBasic()

setBasic ( )

button is less pronounced

Returns: HtmlButton

Definition at line 207 of file HtmlButton.php.

◆ setCircular()

setCircular ( )

Returns: HtmlButton

Reimplemented from BaseTrait.

Definition at line 198 of file HtmlButton.php.

◆ setColor()

setColor ( $color )

Parameters

string $color

Returns: HtmlSemDoubleElement

Reimplemented from BaseTrait.

Definition at line 164 of file HtmlButton.php.

◆ setEmphasis()

setEmphasis ( $value )

Definition at line 211 of file HtmlButton.php.

◆ setFocusable()

setFocusable ( $value = true )

Definition at line 72 of file HtmlButton.php.

◆ setLoading()

setLoading ( )

Definition at line 215 of file HtmlButton.php.

◆ setNegative()

setNegative ( )

hint towards a negative consequence

Returns: HtmlButton

Definition at line 180 of file HtmlButton.php.

◆ setPositive()

setPositive ( )

hint towards a positive consequence

Returns: HtmlButton

Definition at line 160 of file HtmlButton.php.

◆ setStyle()

setStyle ( $cssStyle )

define the button style

Parameters

string | int $cssStyle

Returns: HtmlButton default : ""

Reimplemented from HtmlSingleElement.

Definition at line 68 of file HtmlButton.php.

◆ setToggle()

setToggle ( $active = "" )

formatted to toggle on/off

Returns: HtmlButton

Definition at line 189 of file HtmlButton.php.

◆ setValue()

setValue ( $value )

Set the button value.

Parameters

string $value

Returns: HtmlButton

Reimplemented from HtmlDoubleElement.

Definition at line 49 of file HtmlButton.php.

◆ social()

static social	(	$identifier,
		$social,
		$value = `NULL`
	)

static

Returns a new social Button.

Parameters

string	$identifier
string	$social
string	$value

Returns: HtmlButton

Definition at line 227 of file HtmlButton.php.

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

Ajax/semantic/html/elements/HtmlButton.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addLabel()

◆ addPopupConfirmation()

◆ asIcon()

◆ asLink()

◆ asSubmit()

◆ dropdown()

◆ fromArray()

◆ icon()

◆ labeled()

◆ setAnimated()

◆ setBasic()

◆ setCircular()

◆ setColor()

◆ setEmphasis()

◆ setFocusable()

◆ setLoading()

◆ setNegative()

◆ setPositive()

◆ setStyle()

◆ setToggle()

◆ setValue()

◆ social()