HtmlSticky Class Reference

Inheritance diagram for HtmlSticky:

Public Member Functions
	__construct ($identifier, $context=NULL, $content=NULL)
	setContext ($context)
	setFixed ($value=NULL)
	setBound ($value=NULL)
	run (JsUtils $js)
	{ Parameters JsUtils $js Returns SimpleExtComponent See also \Ajax\common\html\BaseHtmlrun() See also \Ajax\common\html\BaseHtmlrun() } See also HtmlDoubleElement::run()
	setOffset ($offset=0)
	setDebug ($verbose=NULL)
Public Member Functions inherited from HtmlSemDoubleElement
	__construct ($identifier, $tagName="p", $baseClass="ui", $content=NULL)
	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.
	addLabel ($label, $before=false, $icon=NULL)
	Adds a label to the element.
	attachLabel ($label, $side=Side::TOP, $direction=Direction::NONE, $icon=NULL)
	Adds an attached label to the element.
	asLink ($href=NULL, $target=NULL)
	Transforms the element into a link.
	jsShowDimmer ($show=true)
	Returns the script displaying the dimmer.
	compile (JsUtils $js=NULL, &$view=NULL)
	{}
	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)
	setValue ($value)
	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)
	setStyle ($value)
	fromArray ($array)
	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
	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 ()

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

Definition at line 8 of file HtmlSticky.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$identifier,
			$context = NULL,
			$content = NULL
	)

Definition at line 10 of file HtmlSticky.php.

Member Function Documentation

run()

run

(

JsUtils

$js

)

{

Parameters

JsUtils

$js

Returns

SimpleExtComponent

See also

\Ajax\common\html\BaseHtmlrun()

See also

\Ajax\common\html\BaseHtmlrun()

}

See also

HtmlDoubleElement::run()

See also

\Ajax\semantic\html\base\HtmlSemDoubleElement::run()

Reimplemented from HtmlSemDoubleElement.

Definition at line 39 of file HtmlSticky.php.

setBound()

setBound

(

$value = NULL

)

Definition at line 28 of file HtmlSticky.php.

setContext()

setContext

(

$context

)

Definition at line 16 of file HtmlSticky.php.

setDebug()

setDebug

(

$verbose = NULL

)

Definition at line 51 of file HtmlSticky.php.

setFixed()

setFixed

(

$value = NULL

)

Definition at line 21 of file HtmlSticky.php.

setOffset()

setOffset

(

$offset = 0

)

Definition at line 44 of file HtmlSticky.php.

---

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

• Ajax/semantic/html/modules/HtmlSticky.php