Inheritance diagram for HtmlShape:

Public Member Functions

__construct ( $identifier, $sides)

getSide ($index)

getSideContent ($index)

jsDo ($action)

jsFlipLeft ()

jsFlipRight ()

jsFlipUp ()

jsFlipDown ()

jsFlipOver ()

jsFlipBack ()

flipLeftOn ($element, $event)

flipRightOn ($element, $event)

flipUpOn ($element, $event)

flipDownOn ($element, $event)

flipBackOn ($element, $event)

flipOverOn ($element, $event)

setActiveSide ($index)

asCube ()

asText ()

setWidth ($width="initial")

onChange ($jsCode)

beforeChange ($jsCode)

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

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

Public Member Functions inherited from HtmlSemCollection

__construct ( $identifier, $tagName="div", $baseClass="")

Public Member Functions inherited from HtmlCollection

addItems ($items)

setItems ($items)

getItems ()

addItem ($item)

adds and returns an item

insertItem ($item, $position=0)

getItem ($index)

Return the item at index.

setItem ($index, $value)

removeItem ($index)

count ()

fromDatabaseObject ($object, $function)

apply ($callBack)

fromArray ($array)

setProperties ($properties)

setPropertyValues ($property, $values)

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

addPropertyValues ($property, $values)

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

getItemById ($identifier)

asLinks ($hrefs=[], $target=NUll)

splice ($offset, $length=null)

Remove a portion of the items array and replace it with something else.

Public Member Functions inherited from HtmlDoubleElement

setContent ($content)

getContent ()

addContent ($content, $before=false)

setValue ($value)

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)

setStyle ($value)

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

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

Protected Member Functions

createItem ($value)

The item factory.

Parameters

mixed $value

createCondition ($value)

Protected Member Functions inherited from HtmlCollection

getItemToAdd ($item)

setItemIdentifier ($item, $classname, $index)

contentAs ($tagName)

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

	$_autoActive =true

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
	doActionOn ($element, $event, $what)

Detailed Description

Definition at line 11 of file HtmlShape.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$identifier,
		$sides
	)

Reimplemented from HtmlCollection.

Definition at line 16 of file HtmlShape.php.

Member Function Documentation

◆ asCube()

asCube ( )

Definition at line 126 of file HtmlShape.php.

◆ asText()

asText ( )

Definition at line 130 of file HtmlShape.php.

◆ beforeChange()

beforeChange ( $jsCode )

Definition at line 141 of file HtmlShape.php.

◆ compile()

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

Reimplemented from HtmlCollection.

Definition at line 156 of file HtmlShape.php.

◆ createCondition()

createCondition ( $value )

protected

See also: \Ajax\common\html\HtmlCollection::createCondition()

Reimplemented from HtmlCollection.

Definition at line 37 of file HtmlShape.php.

◆ createItem()

createItem ( $value )

protected

The item factory.

Parameters

mixed $value

See also: \Ajax\common\html\HtmlCollection::createItem()

Reimplemented from HtmlCollection.

Definition at line 26 of file HtmlShape.php.

◆ doActionOn()

doActionOn	(	$element,
		$event,
		$what
	)

private

Definition at line 88 of file HtmlShape.php.

◆ flipBackOn()

flipBackOn	(	$element,
		$event
	)

Definition at line 110 of file HtmlShape.php.

◆ flipDownOn()

flipDownOn	(	$element,
		$event
	)

Definition at line 106 of file HtmlShape.php.

◆ flipLeftOn()

flipLeftOn	(	$element,
		$event
	)

Definition at line 94 of file HtmlShape.php.

◆ flipOverOn()

flipOverOn	(	$element,
		$event
	)

Definition at line 114 of file HtmlShape.php.

◆ flipRightOn()

flipRightOn	(	$element,
		$event
	)

Definition at line 98 of file HtmlShape.php.

◆ flipUpOn()

flipUpOn	(	$element,
		$event
	)

Definition at line 102 of file HtmlShape.php.

◆ getSide()

getSide ( $index )

Parameters

int $index

Returns: \Ajax\semantic\html\content\HtmlShapeItem

Definition at line 45 of file HtmlShape.php.

◆ getSideContent()

getSideContent ( $index )

Parameters

int $index

Returns: mixed|NULL

Definition at line 53 of file HtmlShape.php.

◆ jsDo()

jsDo ( $action )

Definition at line 60 of file HtmlShape.php.

◆ jsFlipBack()

jsFlipBack ( )

Definition at line 84 of file HtmlShape.php.

◆ jsFlipDown()

jsFlipDown ( )

Definition at line 76 of file HtmlShape.php.

◆ jsFlipLeft()

jsFlipLeft ( )

Definition at line 64 of file HtmlShape.php.

◆ jsFlipOver()

jsFlipOver ( )

Definition at line 80 of file HtmlShape.php.

◆ jsFlipRight()

jsFlipRight ( )

Definition at line 68 of file HtmlShape.php.

◆ jsFlipUp()

jsFlipUp ( )

Definition at line 72 of file HtmlShape.php.

◆ onChange()

onChange ( $jsCode )

Definition at line 137 of file HtmlShape.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 HtmlSemCollection.

Definition at line 149 of file HtmlShape.php.

◆ setActiveSide()

setActiveSide ( $index )

Definition at line 118 of file HtmlShape.php.

◆ setWidth()

setWidth ( $width = "initial" )

Definition at line 134 of file HtmlShape.php.

Field Documentation

◆ $_autoActive

$_autoActive =true

protected

Definition at line 14 of file HtmlShape.php.

◆ $_params

$_params =array()

protected

Definition at line 13 of file HtmlShape.php.

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

Ajax/semantic/html/modules/HtmlShape.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ asCube()

◆ asText()

◆ beforeChange()

◆ compile()

◆ createCondition()

◆ createItem()

◆ doActionOn()

◆ flipBackOn()

◆ flipDownOn()

◆ flipLeftOn()

◆ flipOverOn()

◆ flipRightOn()

◆ flipUpOn()

◆ getSide()

◆ getSideContent()

◆ jsDo()

◆ jsFlipBack()

◆ jsFlipDown()

◆ jsFlipLeft()

◆ jsFlipOver()

◆ jsFlipRight()

◆ jsFlipUp()

◆ onChange()

◆ run()

◆ setActiveSide()

◆ setWidth()

Field Documentation

◆ $_autoActive

◆ $_params