Semantic Tab component. More...

Inheritance diagram for HtmlTab:

Public Member Functions

__construct ($identifier, $tabs=array())

getMenu ()

setTabContent ($index, $content)

Sets the content of the tab at position $index.

setTabsContent ($contents)

Sets all contents of tabs.

activate ($index)

Activates the tab element at $index.

addTab ($title, $content)

Adds a new tab.

forwardTab ($index, JsUtils $js, $title, $initialController, $controller, $action, $params=array())

Renders the content of.

renderViewTab ($index, JsUtils $js, $title, $initialController, $viewName, $params=array())

Renders the content of an existing view : $controller/$action and sets the response to the tab at $index position.

addAndForwardTab (JsUtils $js, $title, $initialController, $controller, $action, $params=array())

render the content of

addAndRenderViewTab (JsUtils $js, $title, $initialController, $viewName, $params=array())

render the content of an existing view : $controller/$action and set the response to a new tab

setPointing ($value=Direction::NONE)

setSecondary ()

getMenuTab ($index)

Returns the menu item at position $index.

getTab ($index)

Returns the tab at position $index.

setMenu ($menu)

Sets the menu of tabs.

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)

setInverted ($recursive=true)

can be formatted to appear on dark backgrounds

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)

setCircular ()

setFloated ($direction="right")

floatRight ()

floatLeft ()

getBaseClass ()

getVariations ()

getStates ()

Protected Member Functions

createItem ($value)

{The item factory.

Parameters

mixed $value

}

Protected Member Functions inherited from HtmlCollection

getItemToAdd ($item)

setItemIdentifier ($item, $classname, $index)

createCondition ($value)

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 = []

	$_activated = false

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
	createSegment ($count, $content, $datatab)

Detailed Description

Semantic Tab component.

See also: http://semantic-ui.com/collections/tab.html

Author: jc

Version: 1.0.2

Definition at line 19 of file HtmlTab.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$identifier,
		$tabs = `array()`
	)

Reimplemented from HtmlCollection.

Definition at line 25 of file HtmlTab.php.

Member Function Documentation

◆ activate()

activate ( $index )

Activates the tab element at $index.

Parameters

int $index

Returns: \Ajax\semantic\html\modules\HtmlTab

Definition at line 115 of file HtmlTab.php.

◆ addAndForwardTab()

addAndForwardTab	(	JsUtils	$js,
			$title,
			$initialController,
			$controller,
			$action,
			$params = `array()`
	)

render the content of

$controller::$action and set the response to a new tab

Parameters

JsUtils	$js
string	$title	The panel title
object	$initialController
string	$controller	a controller
string	$action	an action
array	$params

Returns: \Ajax\semantic\html\elements\HtmlSegment

Definition at line 199 of file HtmlTab.php.

◆ addAndRenderViewTab()

addAndRenderViewTab	(	JsUtils	$js,
			$title,
			$initialController,
			$viewName,
			$params = `array()`
	)

render the content of an existing view : $controller/$action and set the response to a new tab

Parameters

JsUtils	$js
string	$title	The panel title
object	$initialController
string	$viewName
array	$params	The parameters to pass to the view

Returns: \Ajax\semantic\html\elements\HtmlSegment

Definition at line 218 of file HtmlTab.php.

◆ addTab()

addTab	(	$title,
		$content
	)

Adds a new tab.

Parameters

string	$title
string	$content

Returns: \Ajax\semantic\html\elements\HtmlSegment

Definition at line 132 of file HtmlTab.php.

◆ compile()

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

Reimplemented from HtmlCollection.

Definition at line 290 of file HtmlTab.php.

◆ createItem()

createItem ( $value )

protected

{The item factory.

Parameters

mixed $value

}

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

Returns: HtmlSegment

Reimplemented from HtmlCollection.

Definition at line 43 of file HtmlTab.php.

◆ createSegment()

createSegment	(	$count,
		$content,
		$datatab
	)

private

Parameters

int	$count
string	$content
string	$datatab

Returns: \Ajax\semantic\html\elements\HtmlSegment

Definition at line 66 of file HtmlTab.php.

◆ forwardTab()

forwardTab	(		$index,
		JsUtils	$js,
			$title,
			$initialController,
			$controller,
			$action,
			$params = `array()`
	)

Renders the content of.

$controller::$action and sets the response to the tab at $index position

Parameters

int	$index
JsUtils	$js
string	$title	The panel title
object	$initialController
string	$controller	a controller
string	$action	an action
array	$params

Returns: \Ajax\semantic\html\elements\HtmlSegment

Definition at line 154 of file HtmlTab.php.

◆ getMenu()

getMenu ( )

Definition at line 33 of file HtmlTab.php.

◆ getMenuTab()

getMenuTab ( $index )

Returns the menu item at position $index.

Parameters

int $index

Returns: HtmlMenuItem

Definition at line 236 of file HtmlTab.php.

◆ getTab()

getTab ( $index )

Returns the tab at position $index.

Parameters

int $index

Returns: HtmlSegment

Definition at line 246 of file HtmlTab.php.

◆ renderViewTab()

renderViewTab	(		$index,
		JsUtils	$js,
			$title,
			$initialController,
			$viewName,
			$params = `array()`
	)

Renders the content of an existing view : $controller/$action and sets the response to the tab at $index position.

Parameters

	$index
JsUtils	$js
string	$title	The panel title
object	$initialController
string	$viewName
array	$params	The parameters to pass to the view

Returns: \Ajax\semantic\html\elements\HtmlSegment

Definition at line 177 of file HtmlTab.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 283 of file HtmlTab.php.

◆ setInverted()

setInverted ( $recursive = true )

can be formatted to appear on dark backgrounds

Reimplemented from BaseTrait.

Definition at line 296 of file HtmlTab.php.

◆ setMenu()

setMenu ( $menu )

Sets the menu of tabs.

Parameters

HtmlMenu $menu

Returns: \Ajax\semantic\html\modules\HtmlTab

Definition at line 256 of file HtmlTab.php.

◆ setPointing()

setPointing ( $value = Direction::NONE )

Definition at line 222 of file HtmlTab.php.

◆ setSecondary()

setSecondary ( )

Definition at line 226 of file HtmlTab.php.

◆ setTabContent()

setTabContent	(	$index,
		$content
	)

Sets the content of the tab at position $index.

Parameters

int	$index	index of the tab
String	$content	new content

Returns: \Ajax\semantic\html\modules\HtmlTab

Definition at line 83 of file HtmlTab.php.

◆ setTabsContent()

setTabsContent ( $contents )

Sets all contents of tabs.

Parameters

array $contents

Returns: \Ajax\semantic\html\modules\HtmlTab

Definition at line 101 of file HtmlTab.php.

Field Documentation

◆ $_activated

$_activated = false

protected

Definition at line 23 of file HtmlTab.php.

◆ $params

$params = []

protected

Definition at line 21 of file HtmlTab.php.

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

Ajax/semantic/html/modules/HtmlTab.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activate()

◆ addAndForwardTab()

◆ addAndRenderViewTab()

◆ addTab()

◆ compile()

◆ createItem()

◆ createSegment()

◆ forwardTab()

◆ getMenu()

◆ getMenuTab()

◆ getTab()

◆ renderViewTab()

◆ run()

◆ setInverted()

◆ setMenu()

◆ setPointing()

◆ setSecondary()

◆ setTabContent()

◆ setTabsContent()

Field Documentation

◆ $_activated

◆ $params