Toggle buttons for creating a grouped set of buttons
author | Timo A. Hummel |
---|
__toString() : string
inherited_from | \cHTML::__toString() |
---|---|
inherited_from | \cHTMLSpan::__toString() |
inherited_from | \cWidgetButton::__toString() |
string
Generated markup_setContent($content)
inherited_from | \cHTML::_setContent() |
---|---|
inherited_from | \cHTMLSpan::_setContent() |
inherited_from | \cWidgetButton::_setContent() |
string/object String with the content or an object to render.
addLinkedItem($item)
mixed Either another cWidgetMultiToggleButton (or derivates) or the ID of the target button.
addRequiredScript($script)
inherited_from | \cHTML::addRequiredScript() |
---|---|
inherited_from | \cHTMLSpan::addRequiredScript() |
inherited_from | \cWidgetButton::addRequiredScript() |
advanceID()
This function is useful if you need to use HTML elements in a loop, but don't want to re-create new objects each time.
inherited_from | \cHTML::advanceID() |
---|---|
inherited_from | \cHTMLSpan::advanceID() |
inherited_from | \cWidgetButton::advanceID() |
attachEventDefinition($sName, $sEvent, $sCode)
Example to attach an onClick handler: setEventDefinition("foo", "onClick", "alert('foo');");
inherited_from | \cHTML::attachEventDefinition() |
---|---|
inherited_from | \cHTMLSpan::attachEventDefinition() |
inherited_from | \cWidgetButton::attachEventDefinition() |
string defines the name of the event
string defines the event (e.g. onClick)
string defines the code
attachStyleDefinition($sName, $sDefinition) : string
This function is not restricted to a single style, e.g. you can set multiple style definitions as-is to the handler.
$example->attachStyle("myIdentifier", "border: 1px solid black; white-space: nowrap"); $example->attachStyle("myIdentifier2", "padding: 0px");
Results in:
style="border: 1px solid black; white-space: nowrap; padding: 0px;"
inherited_from | \cHTML::attachStyleDefinition() |
---|---|
inherited_from | \cHTMLSpan::attachStyleDefinition() |
inherited_from | \cWidgetButton::attachStyleDefinition() |
string Name for a style definition
string Definition for the given entity
string
filled SGML closing skeletoncHTML()
inherited_from | \cHTML::cHTML() |
---|---|
inherited_from | \cHTMLSpan::cHTML() |
inherited_from | \cWidgetButton::cHTML() |
cHTMLSpan($content)
Creates an HTML DIV element.
inherited_from | \cHTMLSpan::cHTMLSpan() |
---|---|
inherited_from | \cWidgetButton::cHTMLSpan() |
mixed String or object with the contents
cWidgetButton($img, $alt, $link)
inherited_from | \cWidgetButton::cWidgetButton() |
---|
string Image location
string Alternative text
string Link
cWidgetMultiToggleButton($img, $alt, $link)
string Image location
string Alternative text
fillCloseSkeleton() : string
inherited_from | \cHTML::fillCloseSkeleton() |
---|---|
inherited_from | \cHTMLSpan::fillCloseSkeleton() |
inherited_from | \cWidgetButton::fillCloseSkeleton() |
string
filled SGML closer skeletonfillSkeleton($attributes) : string
fillSkeleton fills the SGML opener tag with the specified attributes. Attributes need to be passed in the stringyfied variant.
inherited_from | \cHTML::fillSkeleton() |
---|---|
inherited_from | \cHTMLSpan::fillSkeleton() |
inherited_from | \cWidgetButton::fillSkeleton() |
string Attributes to set
string
filled SGML opener skeletongetID() : string
inherited_from | \cHTML::getID() |
---|---|
inherited_from | \cHTMLSpan::getID() |
inherited_from | \cWidgetButton::getID() |
string
current IDrender() : string
string
Rendered HTMLsetAlt($alt)
Sets the "alt" and "title" tags. Usually, "alt" is used for accessibility and "title" for mouse overs.
To set the text for all browsers for mouse over, set "alt" and "title". IE behaves incorrectly and shows "alt" on mouse over. Mozilla browsers only show "title" as mouse over.
inherited_from | \cHTML::setAlt() |
---|---|
inherited_from | \cHTMLSpan::setAlt() |
inherited_from | \cWidgetButton::setAlt() |
string Text to set as the "alt" attribute
setAttribute($sAttributeName, $sValue)
inherited_from | \cHTML::setAttribute() |
---|---|
inherited_from | \cHTMLSpan::setAttribute() |
inherited_from | \cWidgetButton::setAttribute() |
string Name of the attribute
string Value of the attribute
setBorder($border)
inherited_from | \cWidgetButton::setBorder() |
---|
integer border size
setClass($class)
inherited_from | \cHTML::setClass() |
---|---|
inherited_from | \cHTMLSpan::setClass() |
inherited_from | \cWidgetButton::setClass() |
string Text to set as the "alt" attribute
setContent($content)
inherited_from | \cHTMLSpan::setContent() |
---|---|
inherited_from | \cWidgetButton::setContent() |
string/object String with the content or an object to render.
setContentlessTag($contentlessTag)
inherited_from | \cHTML::setContentlessTag() |
---|---|
inherited_from | \cHTMLSpan::setContentlessTag() |
inherited_from | \cWidgetButton::setContentlessTag() |
setDefault($default)
Warning: This method doesn't update other buttons.
boolean If true, this button is a default (e.g. pushed) button.
setEvent($event, $action)
example: $item->setEvent("change","document.forms[0].submit");
inherited_from | \cHTML::setEvent() |
---|---|
inherited_from | \cHTMLSpan::setEvent() |
inherited_from | \cWidgetButton::setEvent() |
string Type of the event
string Function or action to call (JavaScript Code)
setGenerateXHTML(bool $value)
inherited_from | \cHTML::setGenerateXHTML() |
---|---|
inherited_from | \cHTMLSpan::setGenerateXHTML() |
inherited_from | \cWidgetButton::setGenerateXHTML() |
bool
setHint($object, $hint)
string ID of the object which receives the hint
string Text to display
setHover($hover)
inherited_from | \cWidgetButton::setHover() |
---|
boolean True if hovering should be used
setID($id)
inherited_from | \cHTML::setID() |
---|---|
inherited_from | \cHTMLSpan::setID() |
inherited_from | \cWidgetButton::setID() |
setIndent($indent)
inherited_from | \cWidgetButton::setIndent() |
---|
boolean True if indenting should be used
setStyle($style)
inherited_from | \cHTML::setStyle() |
---|---|
inherited_from | \cHTMLSpan::setStyle() |
inherited_from | \cWidgetButton::setStyle() |
setStyleDefinition($entity, $definition) : string
inherited_from | \cHTML::setStyleDefinition() |
---|---|
inherited_from | \cHTMLSpan::setStyleDefinition() |
inherited_from | \cWidgetButton::setStyleDefinition() |
string Entity to define
string Definition for the given entity
string
filled SGML closing skeletontoHTML() : string
inherited_from | \cHTMLSpan::toHTML() |
---|---|
inherited_from | \cWidgetButton::toHTML() |
string
Rendered HTMLunsetEvent($event)
example: $item->unsetEvent("change");
inherited_from | \cHTML::unsetEvent() |
---|---|
inherited_from | \cHTMLSpan::unsetEvent() |
inherited_from | \cWidgetButton::unsetEvent() |
string Type of the event
$_aEventDefinitions
inherited_from | \cHTML::$$_aEventDefinitions |
---|---|
inherited_from | \cHTMLSpan::$$_aEventDefinitions |
inherited_from | \cWidgetButton::$$_aEventDefinitions |
$_aStyleDefinitions
inherited_from | \cHTML::$$_aStyleDefinitions |
---|---|
inherited_from | \cHTMLSpan::$$_aStyleDefinitions |
inherited_from | \cWidgetButton::$$_aStyleDefinitions |
$_content
inherited_from | \cHTML::$$_content |
---|---|
inherited_from | \cHTMLSpan::$$_content |
inherited_from | \cWidgetButton::$$_content |
$_contentlessTag : boolean
access | private |
---|---|
inherited_from | \cHTML::$$_contentlessTag |
inherited_from | \cHTMLSpan::$$_contentlessTag |
inherited_from | \cWidgetButton::$$_contentlessTag |
$_img : object
access | private |
---|---|
inherited_from | \cWidgetButton::$$_img |
$_link : object
access | private |
---|---|
inherited_from | \cWidgetButton::$$_link |
$_requiredScripts : array
access | private |
---|---|
inherited_from | \cHTML::$$_requiredScripts |
inherited_from | \cHTMLSpan::$$_requiredScripts |
inherited_from | \cWidgetButton::$$_requiredScripts |
$_skeleton_close : string
access | private |
---|---|
inherited_from | \cHTML::$$_skeleton_close |
inherited_from | \cHTMLSpan::$$_skeleton_close |
inherited_from | \cWidgetButton::$$_skeleton_close |
$_skeleton_open : string
access | private |
---|---|
inherited_from | \cHTML::$$_skeleton_open |
inherited_from | \cHTMLSpan::$$_skeleton_open |
inherited_from | \cWidgetButton::$$_skeleton_open |
$_skeleton_single : string
access | private |
---|---|
inherited_from | \cHTML::$$_skeleton_single |
inherited_from | \cHTMLSpan::$$_skeleton_single |
inherited_from | \cWidgetButton::$$_skeleton_single |
$_styledefs : string
access | private |
---|---|
inherited_from | \cHTML::$$_styledefs |
inherited_from | \cHTMLSpan::$$_styledefs |
inherited_from | \cWidgetButton::$$_styledefs |
$_tag : string
access | private |
---|---|
inherited_from | \cHTML::$$_tag |
inherited_from | \cHTMLSpan::$$_tag |
inherited_from | \cWidgetButton::$$_tag |