phpMv  -UI toolkit 2.4.12
jQuery, jQuery UI, Twitter Bootstrap and Semantic-UI library for php & php MVC Frameworks
HtmlIcon Class Reference

Semantic Icon component. More...

+ Inheritance diagram for HtmlIcon:
+ Collaboration diagram for HtmlIcon:

Public Member Functions

 __construct ($identifier, $icon)
 
 getIcon ()
 
 setIcon ($icon)
 sets the icon More...
 
 addToIcon ($icon)
 adds an icon in icon element More...
 
 asLoader ()
 Icon used as a simple loader. More...
 
 setFitted ()
 An icon can be fitted, without any space to the left or right of it. More...
 
 setFlipped ($sens="horizontally")
 
 setRotated ($sens="clockwise")
 
 asLink ($href=NULL, $target=NULL)
 icon formatted as a link More...
 
 setOutline ()
 
 setBordered ($inverted=false)
 
 toCorner ()
 
 addLabel ($label, $before=false, $icon=NULL)
 
- Public Member Functions inherited from HtmlSemDoubleElement
 __construct ($identifier, $tagName="p", $baseClass="ui", $content=NULL)
 
 setPopupAttributes ($variation=NULL, $popupEvent=NULL)
 Defines the popup attributes. More...
 
 addPopup ($title="", $content="", $variation=NULL, $params=array())
 Adds a popup to the element. More...
 
 addPopupHtml ($html="", $variation=NULL, $params=array())
 Adds an html popup to the element. More...
 
 addDimmer ($params=array(), $content=NULL)
 Adds a Dimmer to the element. More...
 
 addLabel ($label, $before=false, $icon=NULL)
 Adds a label to the element. More...
 
 attachLabel ($label, $side=Side::TOP, $direction=Direction::NONE, $icon=NULL)
 Adds an attached label to the element. More...
 
 asLink ($href=NULL, $target=NULL)
 Transforms the element into a link. More...
 
 jsShowDimmer ($show=true)
 Returns the script displaying the dimmer. More...
 
 compile (JsUtils $js=NULL, &$view=NULL)
 {} More...
 
 run (JsUtils $js)
 {} More...
 
 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)
 
 run (JsUtils $js)
 
 setValue ($value)
 
 wrapContent ($before, $after="")
 
 wrapWith (HtmlDoubleElement $container)
 Wraps the element with a container. More...
 
 getContentInstances ($class)
 
 asLink ($href=NULL, $target=NULL)
 Transforms the element into a link. More...
 
 getTextContent ()
 
 asEditable (HtmlFormField $field, $asForm=false, $setValueProperty="val()")
 
- Public Member Functions inherited from HtmlSingleElement
 __construct ($identifier, $tagName="br")
 
 setClass ($classNames)
 
 addClass ($classNames)
 
 setRole ($value)
 
 setTitle ($value)
 
 setStyle ($value)
 
 run (JsUtils $js)
 
 fromArray ($array)
 
 setSize ($size)
 
- Public Member Functions inherited from BaseHtml
 run (JsUtils $js)
 
 getTagName ()
 
 setTagName ($tagName)
 
 fromArray ($array)
 
 fromDatabaseObjects ($objects, $function)
 
 fromDatabaseObject ($object, $function)
 
 wrap ($before, $after="")
 
 getElementById ($identifier, $elements)
 
 getBsComponent ()
 
 setBsComponent ($bsComponent)
 
 compile (JsUtils $js=NULL, &$view=NULL)
 
 setDraggable ($attr="id", $dropZone=null, $parameters=[])
 Sets the element draggable, and eventualy defines the dropzone (HTML5 drag and drop) More...
 
 asDropZone ($jsCallback="", $jqueryDone="append", $parameters=[])
 Declares the element as a drop zone (HTML5 drag and drop) More...
 
 asFileDropZone ($responseElement=null, $url=null, $progress=null, $jsCallback="", $parameters=[])
 Declares the element as a drop zone for file uploading (HTML5 drag and drop) More...
 
 __toString ()
 
 onPostCompile ($callback)
 
 onPreCompile ($callback)
 
- Public Member Functions inherited from BaseWidget
 __construct ($identifier)
 
 getIdentifier ()
 
 setIdentifier ($identifier)
 
 getLibraryId ()
 
 setLibraryId ($_libraryId)
 

Static Public Member Functions

static label ($identifier, $icon, $label)
 

Protected Attributes

 $_icon
 
- 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
 

Additional Inherited Members

- Protected Member Functions inherited from HtmlDoubleElement
 _getContentInstances ($class, $content)
 
 compile_once (\Ajax\JsUtils $js=NULL, &$view=NULL)
 {} More...
 
- 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)
 

Detailed Description

Semantic Icon component.

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

Definition at line 14 of file HtmlIcon.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $identifier,
  $icon 
)

Definition at line 17 of file HtmlIcon.php.

Member Function Documentation

◆ addLabel()

addLabel (   $label,
  $before = false,
  $icon = NULL 
)

Definition at line 124 of file HtmlIcon.php.

◆ addToIcon()

addToIcon (   $icon)

adds an icon in icon element

Parameters
string$icon
Returns
HtmlIcon

Definition at line 45 of file HtmlIcon.php.

◆ asLink()

asLink (   $href = NULL,
  $target = NULL 
)

icon formatted as a link

Parameters
string$href
string$target
Returns
HtmlIcon

Definition at line 90 of file HtmlIcon.php.

◆ asLoader()

asLoader ( )

Icon used as a simple loader.

Returns
HtmlIcon

Definition at line 54 of file HtmlIcon.php.

◆ getIcon()

getIcon ( )

Definition at line 22 of file HtmlIcon.php.

◆ label()

static label (   $identifier,
  $icon,
  $label 
)
static

Definition at line 134 of file HtmlIcon.php.

◆ setBordered()

setBordered (   $inverted = false)
Parameters
string$inverted
Returns
HtmlIcon

Definition at line 109 of file HtmlIcon.php.

◆ setFitted()

setFitted ( )

An icon can be fitted, without any space to the left or right of it.

Returns
HtmlIcon

Definition at line 62 of file HtmlIcon.php.

◆ setFlipped()

setFlipped (   $sens = "horizontally")
Parameters
string$senshorizontally or vertically
Returns
HtmlIcon

Definition at line 71 of file HtmlIcon.php.

◆ setIcon()

setIcon (   $icon)

sets the icon

Parameters
string$icon
Returns
HtmlIcon

Definition at line 31 of file HtmlIcon.php.

◆ setOutline()

setOutline ( )

Definition at line 100 of file HtmlIcon.php.

◆ setRotated()

setRotated (   $sens = "clockwise")
Parameters
string$sensclockwise or counterclockwise
Returns
HtmlIcon

Definition at line 80 of file HtmlIcon.php.

◆ toCorner()

toCorner ( )
Returns
HtmlIcon

Definition at line 120 of file HtmlIcon.php.

Field Documentation

◆ $_icon

$_icon
protected

Definition at line 15 of file HtmlIcon.php.


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