Ajax\semantic\html\base\traits Namespace Reference

Functions
	setAttachment (HtmlDoubleElement $toElement=NULL, $side=Side::BOTH)
	setPropertyCtrl ($name, $value, $typeCtrl)
	addToPropertyCtrl ($name, $value, $typeCtrl)
	addToPropertyCtrlCheck ($name, $value, $typeCtrl)
	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 More...
	setColor ($color)
	setFluid ()
	asHeader ()
	setActive ($value=true)
	show it is currently the active user selection More...
	setAttached ($value=true)
	setInverted ($recursive=true)
	can be formatted to appear on dark backgrounds More...
	setCircular ()
	setFloated ($direction="right")
	floatRight ()
	floatLeft ()
	getBaseClass ()
	addBehavior (&$array, $key, $value, $before="", $after="")
	getVariations ()
	getStates ()
	run (JsUtils $js)
	setTimeout ($_timeout)
	setCloseTransition ($_closeTransition)
	getIcon ()
	addIcon ($icon, $before=true, $labeled=false)
	Adds an icon before or after. More...
	setClass ($classNames)
	setContent ($content)
	asSearchInput ($placeholder=NULL, $icon=NULL)
	asDivider ()
	asHeader ($caption=NULL, $icon=NULL)
	setPosition ($direction)
	setPositive ()
	setNegative ()
	setWarning ()
	setError ()
	setTextAlignment ($value=TextAlignment::LEFT)
	textCenterAligned ()
	textJustified ()
	textRightAligned ()
	textLeftAligned ()

Variables
trait	AttachedTrait
trait	BaseTrait
	$_states =[ ]
	$_baseClass
trait	HasTimeoutTrait
	$_closeTransition ="{animation : 'scale',duration : '2s'}"
trait	IconTrait
trait	LabeledIconTrait
trait	MenuItemTrait
trait	TableElementTrait
trait	TextAlignmentTrait

Function Documentation

addBehavior()

Ajax\semantic\html\base\traits\addBehavior ( &  $array,   $key,   $value,   $before = "",   $after = ""  )

protected

Definition at line 202 of file BaseTrait.php.

addContent()

addContent (   $content,   $before = false  )

abstract

addIcon() [1/2]

Ajax\semantic\html\base\traits\addIcon	(		$icon,
			$before = true,
			$labeled = false
	)

Adds an icon before or after.

Parameters

string | HtmlIcon	$icon
boolean	$before
boolean	$labeled

Returns

Definition at line 25 of file LabeledIconTrait.php.

addIcon() [2/2]

addIcon (   $icon,   $before = true  )

abstract

Definition at line 92 of file BaseTrait.php.

addState()

Ajax\semantic\html\base\traits\addState

(

$state

)

Definition at line 40 of file BaseTrait.php.

addStates()

Ajax\semantic\html\base\traits\addStates

(

$states = array()

)

Definition at line 73 of file BaseTrait.php.

addSticky()

Ajax\semantic\html\base\traits\addSticky

(

$context = "body"

)

Definition at line 96 of file BaseTrait.php.

addToProperty()

Ajax\semantic\html\base\traits\addToProperty (   $name,   $value,   $separator = " "  )

abstract

Parameters

string	$name
mixed	$value
string	$separator

Returns

$this

Definition at line 46 of file BaseHtmlPropertiesTrait.php.

addToPropertyCtrl()

addToPropertyCtrl (   $name,   $value,   $typeCtrl  )

abstractprotected

Definition at line 87 of file BaseHtmlPropertiesTrait.php.

addToPropertyCtrlCheck()

Ajax\semantic\html\base\traits\addToPropertyCtrlCheck (   $name,   $value,   $typeCtrl  )

abstractprotected

Definition at line 91 of file BaseHtmlPropertiesTrait.php.

addVariation()

Ajax\semantic\html\base\traits\addVariation

(

$variation

)

Definition at line 36 of file BaseTrait.php.

addVariations()

Ajax\semantic\html\base\traits\addVariations

(

$variations = array()

)

Definition at line 64 of file BaseTrait.php.

asDivider()

Ajax\semantic\html\base\traits\asDivider

(

)

Returns

HtmlDropdownItem|HtmlMenuItem

Definition at line 55 of file MenuItemTrait.php.

asHeader() [1/2]

Ajax\semantic\html\base\traits\asHeader	(		$caption = NULL,
			$icon = NULL
	)

Parameters

string	$caption
string	$icon

Returns

HtmlDropdownItem|HtmlMenuItem

Definition at line 67 of file MenuItemTrait.php.

asHeader() [2/2]

Ajax\semantic\html\base\traits\asHeader

(

)

Returns

HtmlSemDoubleElement

Definition at line 143 of file BaseTrait.php.

asSearchInput()

Ajax\semantic\html\base\traits\asSearchInput	(		$placeholder = NULL,
			$icon = NULL
	)

Parameters

string	$placeholder
string	$icon

Returns

HtmlDropdownItem|HtmlMenuItem

Definition at line 41 of file MenuItemTrait.php.

floatLeft()

Ajax\semantic\html\base\traits\floatLeft

(

)

Definition at line 194 of file BaseTrait.php.

floatRight()

Ajax\semantic\html\base\traits\floatRight

(

)

Definition at line 190 of file BaseTrait.php.

getBaseClass()

Ajax\semantic\html\base\traits\getBaseClass

(

)

Definition at line 198 of file BaseTrait.php.

getIcon()

Ajax\semantic\html\base\traits\getIcon

(

)

Definition at line 37 of file IconTrait.php.

getStates()

Ajax\semantic\html\base\traits\getStates

(

)

Definition at line 219 of file BaseTrait.php.

getVariations()

Ajax\semantic\html\base\traits\getVariations

(

)

Definition at line 215 of file BaseTrait.php.

onCreate()

Ajax\semantic\html\base\traits\onCreate (   $jsCode )

abstract

Definition at line 82 of file BaseHtmlEventsTrait.php.

run()

Ajax\semantic\html\base\traits\run

(

JsUtils

$js

)

See also

run()

Definition at line 20 of file HasTimeoutTrait.php.

setActive()

Ajax\semantic\html\base\traits\setActive

(

$value = true

)

show it is currently the active user selection

Returns

HtmlSemDoubleElement

Definition at line 151 of file BaseTrait.php.

setAttached()

Ajax\semantic\html\base\traits\setAttached

(

$value = true

)

Definition at line 157 of file BaseTrait.php.

setAttachment()

Ajax\semantic\html\base\traits\setAttachment	(	HtmlDoubleElement	$toElement = NULL,
			$side = Side::BOTH
	)

Parameters

HtmlSemDoubleElement	$toElement
string	$side

Returns

HtmlSemDoubleElement

Definition at line 16 of file AttachedTrait.php.

setCircular()

Ajax\semantic\html\base\traits\setCircular

(

)

Definition at line 182 of file BaseTrait.php.

setClass()

Ajax\semantic\html\base\traits\setClass (   $classNames )

abstract

setCloseTransition()

Ajax\semantic\html\base\traits\setCloseTransition

(

$_closeTransition

)

Definition at line 34 of file HasTimeoutTrait.php.

setColor()

Ajax\semantic\html\base\traits\setColor

(

$color

)

Parameters

string

$color

Returns

HtmlSemDoubleElement

Definition at line 127 of file BaseTrait.php.

setContent()

Ajax\semantic\html\base\traits\setContent

(

$content

)

Definition at line 22 of file MenuItemTrait.php.

setDisabled()

setDisabled

(

$disable = true

)

show it is currently unable to be interacted with

Parameters

boolean

$disable

Returns

HtmlSemDoubleElement

Definition at line 116 of file BaseTrait.php.

setError()

Ajax\semantic\html\base\traits\setError

(

)

Definition at line 23 of file TableElementTrait.php.

setFloated()

Ajax\semantic\html\base\traits\setFloated

(

$direction = "right"

)

Definition at line 186 of file BaseTrait.php.

setFluid()

Ajax\semantic\html\base\traits\setFluid

(

)

Returns

HtmlSemDoubleElement

Definition at line 135 of file BaseTrait.php.

setInverted()

Ajax\semantic\html\base\traits\setInverted

(

$recursive = true

)

can be formatted to appear on dark backgrounds

Definition at line 166 of file BaseTrait.php.

setNegative()

Ajax\semantic\html\base\traits\setNegative

(

)

Definition at line 15 of file TableElementTrait.php.

setPosition()

Ajax\semantic\html\base\traits\setPosition

(

$direction

)

Definition at line 76 of file MenuItemTrait.php.

setPositive()

Ajax\semantic\html\base\traits\setPositive

(

)

Definition at line 11 of file TableElementTrait.php.

setProperty()

Ajax\semantic\html\base\traits\setProperty (   $name,   $value  )

abstract

Definition at line 30 of file BaseHtmlPropertiesTrait.php.

setPropertyCtrl()

Ajax\semantic\html\base\traits\setPropertyCtrl (   $name,   $value,   $typeCtrl  )

abstractprotected

Definition at line 112 of file BaseHtmlPropertiesTrait.php.

setSize()

Ajax\semantic\html\base\traits\setSize

(

$size

)

See also

setSize()

Definition at line 107 of file BaseTrait.php.

setState()

Ajax\semantic\html\base\traits\setState

(

$state

)

Definition at line 59 of file BaseTrait.php.

setStates()

Ajax\semantic\html\base\traits\setStates

(

$states

)

Definition at line 82 of file BaseTrait.php.

setTextAlignment()

Ajax\semantic\html\base\traits\setTextAlignment

(

$value = TextAlignment::LEFT

)

Parameters

string

$value

Returns

Definition at line 15 of file TextAlignmentTrait.php.

setTimeout()

Ajax\semantic\html\base\traits\setTimeout

(

$_timeout

)

Definition at line 29 of file HasTimeoutTrait.php.

setVariation()

Ajax\semantic\html\base\traits\setVariation

(

$variation

)

Definition at line 44 of file BaseTrait.php.

setVariations()

Ajax\semantic\html\base\traits\setVariations

(

$variations

)

Definition at line 49 of file BaseTrait.php.

setWarning()

Ajax\semantic\html\base\traits\setWarning

(

)

Definition at line 19 of file TableElementTrait.php.

textCenterAligned()

Ajax\semantic\html\base\traits\textCenterAligned

(

)

Definition at line 19 of file TextAlignmentTrait.php.

textJustified()

Ajax\semantic\html\base\traits\textJustified

(

)

Definition at line 23 of file TextAlignmentTrait.php.

textLeftAligned()

Ajax\semantic\html\base\traits\textLeftAligned

(

)

Definition at line 31 of file TextAlignmentTrait.php.

textRightAligned()

Ajax\semantic\html\base\traits\textRightAligned

(

)

Definition at line 27 of file TextAlignmentTrait.php.

Variable Documentation

$_baseClass

$_baseClass

protected

Definition at line 20 of file BaseTrait.php.

$_closeTransition

$_closeTransition ="{animation : 'scale',duration : '2s'}"

protected

Definition at line 14 of file HasTimeoutTrait.php.

$_states

$_states =[ ]

protected

Definition at line 19 of file BaseTrait.php.

AttachedTrait

trait AttachedTrait

Initial value:

{
    abstract public function addToPropertyCtrl($name, $value, $typeCtrl)

Definition at line 9 of file AttachedTrait.php.

BaseTrait

trait BaseTrait

Initial value:

{
    protected $_variations=[ ]

Definition at line 17 of file BaseTrait.php.

HasTimeoutTrait

trait HasTimeoutTrait

Initial value:

{
    protected $_timeout

Definition at line 12 of file HasTimeoutTrait.php.

IconTrait

trait IconTrait

Initial value:

{
    private $_hasIcon=false

Definition at line 14 of file IconTrait.php.

LabeledIconTrait

trait LabeledIconTrait

Initial value:

{

    abstract public function addToProperty($name, $value, $separator=" ")

Definition at line 13 of file LabeledIconTrait.php.

MenuItemTrait

trait MenuItemTrait

Initial value:

{
    abstract public function addToProperty($name, $value, $separator=" ")

Definition at line 17 of file MenuItemTrait.php.

TableElementTrait

trait TableElementTrait

Initial value:

{

    abstract public function addState($state)

Definition at line 7 of file TableElementTrait.php.

TextAlignmentTrait

trait TextAlignmentTrait

Initial value:

{

    abstract public function addToPropertyCtrl($name, $value, $typeCtrl)

Definition at line 7 of file TextAlignmentTrait.php.