phpMv -UI toolkit 2.4.12
jQuery, jQuery UI, Twitter Bootstrap and Semantic-UI library for php & php MVC Frameworks
Loading...
Searching...
No Matches
HtmlIconGroups Class Reference

Semantic Icons group component. More...

+ Inheritance diagram for HtmlIconGroups:

Public Member Functions

 __construct ($identifier, $icons=array(), $size="")
 
 getItem ($index)
 
 getIcon ($index)
 
 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()

 
 toCorner ($index=1)
 
- Public Member Functions inherited from HtmlCollection
 __construct ($identifier, $tagName="div")
 
 addItems ($items)
 
 setItems ($items)
 
 getItems ()
 
 addItem ($item)
 adds and returns an item
 
 insertItem ($item, $position=0)
 
 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.
 
 compile (JsUtils $js=NULL, &$view=NULL)
 
 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 ()
 

Static Public Member Functions

static corner ($mainIcon, $cornerIcon, $size="huge")
 

Protected Member Functions

 createItem ($value)
 The item factory.
 
 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="")
 

Additional Inherited Members

- 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 Icons group component.

See also
http://phpmv-ui.kobject.net/index/direct/main/72
http://semantic-ui.com/elements/icon.html#/definition
Author
jc
Version
1.001

Definition at line 16 of file HtmlIconGroups.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $identifier,
  $icons = array(),
  $size = "" 
)

Reimplemented from HtmlSemCollection.

Definition at line 18 of file HtmlIconGroups.php.

Member Function Documentation

◆ corner()

static corner (   $mainIcon,
  $cornerIcon,
  $size = "huge" 
)
static

Definition at line 62 of file HtmlIconGroups.php.

◆ createCondition()

createCondition (   $value)
protected

Reimplemented from HtmlCollection.

Definition at line 44 of file HtmlIconGroups.php.

◆ createItem()

createItem (   $value)
protected

The item factory.

Parameters
mixed$value

Reimplemented from HtmlCollection.

Definition at line 31 of file HtmlIconGroups.php.

◆ getIcon()

getIcon (   $index)

Definition at line 48 of file HtmlIconGroups.php.

◆ getItem()

getItem (   $index)
Returns
HtmlIcon

Reimplemented from HtmlCollection.

Definition at line 27 of file HtmlIconGroups.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 52 of file HtmlIconGroups.php.

◆ toCorner()

toCorner (   $index = 1)

Definition at line 57 of file HtmlIconGroups.php.


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