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

Semantic Button component. More...

+ Inheritance diagram for HtmlButton:
+ Collaboration diagram for HtmlButton:

Public Member Functions

 __construct ($identifier, $value=null, $cssStyle=null, $onClick=null)
 Constructs an HTML Semantic button. More...
 
 setValue ($value)
 Set the button value. More...
 
 setStyle ($cssStyle)
 define the button style More...
 
 setFocusable ($value=true)
 
 setAnimated ($content, $animation="")
 
 asIcon ($icon)
 
 asSubmit ()
 
 addLabel ($label, $before=false, $icon=NULL)
 Add and return a button label. More...
 
 fromArray ($array)
 
 setPositive ()
 hint towards a positive consequence More...
 
 setColor ($color)
 
 setNegative ()
 hint towards a negative consequence More...
 
 setToggle ($active="")
 formatted to toggle on/off More...
 
 setCircular ()
 
 setBasic ()
 button is less pronounced More...
 
 setEmphasis ($value)
 
 setLoading ()
 
 asLink ($href=NULL, $target=NULL)
 {} More...
 
 addPopupConfirmation ($message, $buttons=["Okay","Cancel"])
 
- 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 social ($identifier, $social, $value=NULL)
 Returns a new social Button. More...
 
static labeled ($identifier, $value, $icon, $before=true)
 Returns a new labeled Button. More...
 
static icon ($identifier, $icon)
 Returns a new icon Button. More...
 
static dropdown ($identifier, $value, $items=[], $asCombo=false, $icon=null)
 Returns a button with a dropdown button. More...
 

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

Detailed Description

Semantic Button component.

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

Definition at line 18 of file HtmlButton.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $identifier,
  $value = null,
  $cssStyle = null,
  $onClick = null 
)

Constructs an HTML Semantic button.

Parameters
string$identifierHTML id
string$valuevalue of the Button
string$cssStylebtn-default, btn-primary...
string$onClickJS Code for click event

Definition at line 33 of file HtmlButton.php.

Member Function Documentation

◆ addLabel()

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

Add and return a button label.

Parameters
string$label
boolean$before
string$icon
Returns
HtmlLabel

Definition at line 126 of file HtmlButton.php.

◆ addPopupConfirmation()

addPopupConfirmation (   $message,
  $buttons = ["Okay",
"Cancel"]   
)

Definition at line 294 of file HtmlButton.php.

◆ asIcon()

asIcon (   $icon)
Parameters
string | HtmlIcon$icon
Returns
HtmlButton

Definition at line 103 of file HtmlButton.php.

◆ asLink()

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

{}

See also
HtmlSemDoubleElement::asLink()

Definition at line 269 of file HtmlButton.php.

◆ asSubmit()

asSubmit ( )

Definition at line 113 of file HtmlButton.php.

◆ dropdown()

static dropdown (   $identifier,
  $value,
  $items = [],
  $asCombo = false,
  $icon = null 
)
static

Returns a button with a dropdown button.

Parameters
string$identifier
string$value
array$items
boolean$asCombo
string$icon
Returns
HtmlButtonGroups

Definition at line 284 of file HtmlButton.php.

◆ fromArray()

fromArray (   $array)

Definition at line 148 of file HtmlButton.php.

◆ icon()

static icon (   $identifier,
  $icon 
)
static

Returns a new icon Button.

Parameters
string$identifier
string$icon
Returns
HtmlButton

Definition at line 258 of file HtmlButton.php.

◆ labeled()

static labeled (   $identifier,
  $value,
  $icon,
  $before = true 
)
static

Returns a new labeled Button.

Parameters
string$identifier
string$value
string$icon
boolean$before
Returns

Definition at line 245 of file HtmlButton.php.

◆ setAnimated()

setAnimated (   $content,
  $animation = "" 
)

Definition at line 82 of file HtmlButton.php.

◆ setBasic()

setBasic ( )

button is less pronounced

Returns
HtmlButton

Definition at line 208 of file HtmlButton.php.

◆ setCircular()

setCircular ( )
Returns
HtmlButton

Definition at line 199 of file HtmlButton.php.

◆ setColor()

setColor (   $color)

Definition at line 165 of file HtmlButton.php.

◆ setEmphasis()

setEmphasis (   $value)

Definition at line 212 of file HtmlButton.php.

◆ setFocusable()

setFocusable (   $value = true)

Definition at line 73 of file HtmlButton.php.

◆ setLoading()

setLoading ( )

Definition at line 216 of file HtmlButton.php.

◆ setNegative()

setNegative ( )

hint towards a negative consequence

Returns
HtmlButton

Definition at line 181 of file HtmlButton.php.

◆ setPositive()

setPositive ( )

hint towards a positive consequence

Returns
HtmlButton

Definition at line 161 of file HtmlButton.php.

◆ setStyle()

setStyle (   $cssStyle)

define the button style

Parameters
string | int$cssStyle
Returns
HtmlButton default : ""

Definition at line 69 of file HtmlButton.php.

◆ setToggle()

setToggle (   $active = "")

formatted to toggle on/off

Returns
HtmlButton

Definition at line 190 of file HtmlButton.php.

◆ setValue()

setValue (   $value)

Set the button value.

Parameters
string$value
Returns
HtmlButton

Definition at line 50 of file HtmlButton.php.

◆ social()

static social (   $identifier,
  $social,
  $value = NULL 
)
static

Returns a new social Button.

Parameters
string$identifier
string$social
string$value
Returns
HtmlButton

Definition at line 228 of file HtmlButton.php.


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