CONTENIDO_4.9.0 beta1 » \cWidgetMultiToggleButton

Toggle buttons for creating a grouped set of buttons

author	Timo A. Hummel
deprecated	2012-08-24 Use cHTMLButton instead
package	Core

Methods

Constructor.

__construct(mixed $content) : void

Inherited

Creates an HTML Span element.

inherited_from	\cHTMLSpan::__construct()
inherited_from	\cWidgetButton::__construct()

Parameters

$content

mixed

String or object with the contents

Direct call of object as string will return it's generated markup.

__toString() : string

Inherited

inherited_from	\cHTML::__toString()
inherited_from	\cHTMLSpan::__toString()
inherited_from	\cWidgetButton::__toString()

Returns

stringGenerated markup

links to another cWidgetMultiToggleButton (or any derived class) for automatically updating other buttons.

addLinkedItem($item)

deprecated	2012-08-24 Use cHTMLButton instead

Parameters

$item

mixed Either another cWidgetMultiToggleButton (or derivates) or the ID of the target button.

Adds a required script to the current element.

addRequiredScript(string $script) : \cHTML

Inherited

Anyway, scripts are not included twice.

inherited_from	\cHTML::addRequiredScript()
inherited_from	\cHTMLSpan::addRequiredScript()
inherited_from	\cWidgetButton::addRequiredScript()

Parameters

$script

string

the script to include

Returns

\cHTML$this

Advances to the next ID available in the system.

advanceID() : \cHTML

Inherited

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

Returns

\cHTML$this

Appends code / objects to the content.

appendContent(string | object | array $content) : \cHTMLDiv

Inherited

inherited_from	\cHTMLSpan::appendContent()
inherited_from	\cWidgetButton::appendContent()

Parameters

$content

stringobjectarray

String with the content or a cHTML object to render or an array of strings / objects.

Returns

\cHTMLDiv$this

Appends the given style definition to the HTML element.

appendStyleDefinition(string $property, string $value) : \cHTML

Inherited

Example usage: $element->appendStyleDefinition('margin', '5px');

inherited_from	\cHTML::appendStyleDefinition()
inherited_from	\cHTMLSpan::appendStyleDefinition()
inherited_from	\cWidgetButton::appendStyleDefinition()

Parameters

$property

string

the property name, e.g. 'margin'

$value

string

the value of the property, e.g. '5px'

Returns

\cHTML$this

Appends the given style definitions to the HTML element.

appendStyleDefinitions(array $styles) : \cHTML

Inherited

Example usage: $element->appendStyleDefinitions(array( 'margin' => '5px', 'padding' => '0' ));

inherited_from	\cHTML::appendStyleDefinitions()
inherited_from	\cHTMLSpan::appendStyleDefinitions()
inherited_from	\cWidgetButton::appendStyleDefinitions()

Parameters

$styles

string

the styles to append

Returns

\cHTML$this

Attaches the code for an event

attachEventDefinition(string $name, string $event, string $code) : \cHTML

Inherited

Example to attach an onClick handler: attachEventDefinition('foo', 'onClick', 'alert("foo");');

inherited_from	\cHTML::attachEventDefinition()
inherited_from	\cHTMLSpan::attachEventDefinition()
inherited_from	\cWidgetButton::attachEventDefinition()

Parameters

$name

string

Defines the name of the event

$event

string

Defines the event (e.g. onClick)

$code

string

Defines the code

Returns

\cHTML$this

Attaches a style definition.

attachStyleDefinition(string $name, string $definition) : \cHTML

Inherited

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

Parameters

$name

string

Name for a style definition

$definition

string

Definition for the given entity

Returns

\cHTML$this

cHTML()

cHTML()

Inherited

inherited_from	\cHTML::cHTML()
inherited_from	\cHTMLSpan::cHTML()
inherited_from	\cWidgetButton::cHTML()

cHTMLSpan()

cHTMLSpan($content)

Inherited

inherited_from	\cHTMLSpan::cHTMLSpan()
inherited_from	\cWidgetButton::cHTMLSpan()

Parameters

$content

Constructor Function

cWidgetButton($img, $alt, $link)

Inherited

inherited_from	\cWidgetButton::cWidgetButton()

Parameters

$img

string Image location

$alt

string Alternative text

$link

string Link

Constructor Function

cWidgetMultiToggleButton($img, $alt, $link)

deprecated	2012-08-24 Use cHTMLButton instead

Parameters

$img

string Image location

$alt

string Alternative text

$link

Outputs the generated markup

display()

Inherited

inherited_from	\cHTML::display()
inherited_from	\cHTMLSpan::display()
inherited_from	\cWidgetButton::display()

Fills the close skeleton

fillCloseSkeleton() : string

Inherited

inherited_from	\cHTML::fillCloseSkeleton()
inherited_from	\cHTMLSpan::fillCloseSkeleton()
inherited_from	\cWidgetButton::fillCloseSkeleton()

Returns

stringfilled SGML closer skeleton

Fills the open SGML tag skeleton

fillSkeleton(string $attributes) : string

Inherited

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

Parameters

$attributes

string

Attributes to set

Returns

stringfilled SGML opener skeleton

Returns the value of the given attribute.

getAttribute(string $attributeName) : string

Inherited

inherited_from	\cHTML::getAttribute()
inherited_from	\cHTMLSpan::getAttribute()
inherited_from	\cWidgetButton::getAttribute()

Parameters

$attributeName

string

Attribute name

Returns

stringnull value or null if the attribute does not exist

Returns the assoc array(default) or string of attributes

getAttributes(bool $returnAsString) : array

Inherited

inherited_from	\cHTML::getAttributes()
inherited_from	\cHTMLSpan::getAttributes()
inherited_from	\cWidgetButton::getAttributes()

Parameters

$returnAsString

bool

Whether to return the attributes as string

Returns

arraystring

Returns the current ID

getID() : string

Inherited

inherited_from	\cHTML::getID()
inherited_from	\cHTMLSpan::getID()
inherited_from	\cWidgetButton::getID()

Returns

stringcurrent ID

Removes an attribute

removeAttribute(string $attributeName) : \cHTML

Inherited

inherited_from	\cHTML::removeAttribute()
inherited_from	\cHTMLSpan::removeAttribute()
inherited_from	\cWidgetButton::removeAttribute()

Parameters

$attributeName

string

Attribute name

Returns

\cHTML$this

Render method

render() : string

deprecated	2012-08-24 Use cHTMLButton instead

Returns

stringGenerated markup

Sets the alt and title attributes

setAlt(string $alt) : \cHTML

Inherited

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

Parameters

$alt

string

Text to set as the "alt" and "title" attribute

Returns

\cHTML$this

Sets a specific attribute

setAttribute(string $attributeName, string $value) : \cHTML

Inherited

inherited_from	\cHTML::setAttribute()
inherited_from	\cHTMLSpan::setAttribute()
inherited_from	\cWidgetButton::setAttribute()

Parameters

$attributeName

string

Name of the attribute

$value

string

Value of the attribute

Returns

\cHTML$this

Sets the HTML attributes

setAttributes(array $attributes) : \cHTML

Inherited

inherited_from	\cHTML::setAttributes()
inherited_from	\cHTMLSpan::setAttributes()
inherited_from	\cWidgetButton::setAttributes()

Parameters

$attributes

array

Associative array with attributes

Returns

\cHTML$this

sets the border width

setBorder($border)

Inherited

inherited_from	\cWidgetButton::setBorder()

Parameters

$border

integer border size

Sets the CSS class

setClass(string $class) : \cHTML

Inherited

inherited_from	\cHTML::setClass()
inherited_from	\cHTMLSpan::setClass()
inherited_from	\cWidgetButton::setClass()

Parameters

$class

string

Text to set as the "class" attribute

Returns

\cHTML$this

Sets the div's content

setContent(string | object | array $content) : \cHTMLSpan

Inherited

inherited_from	\cHTMLSpan::setContent()
inherited_from	\cWidgetButton::setContent()

Parameters

$content

stringobjectarray

String with the content or a cHTML object to render or an array of strings / objects.

Returns

\cHTMLSpan$this

Contentless tag setter

setContentlessTag(bool $contentlessTag) : \cHTML

Inherited

inherited_from	\cHTML::setContentlessTag()
inherited_from	\cHTMLSpan::setContentlessTag()
inherited_from	\cWidgetButton::setContentlessTag()

Parameters

$contentlessTag

bool

Returns

\cHTML$this

Sets or deletes the default state for this button.

setDefault($default)

Warning: This method doesn't update other buttons.

deprecated	2012-08-24 Use cHTMLButton instead

Parameters

$default

boolean If true, this button is a default (e.g. pushed) button.

Adds an "on???" javascript event handler

setEvent(string $event, string $action) : \cHTML

Inherited

example: $item->setEvent('change','document.forms[0].submit');

inherited_from	\cHTML::setEvent()
inherited_from	\cHTMLSpan::setEvent()
inherited_from	\cWidgetButton::setEvent()

Parameters

$event

string

Type of the event, e. g. "change" for "onchange"

$action

string

Function or action to call (JavaScript Code)

Returns

\cHTML$this

Setter for static $_generateXHTML property

setGenerateXHTML(bool $value)

InheritedStatic

inherited_from	\cHTML::setGenerateXHTML()
inherited_from	\cHTMLSpan::setGenerateXHTML()
inherited_from	\cWidgetButton::setGenerateXHTML()

Parameters

$value

bool

Sets that the specified object receives a hint whenever the button is hovered.

setHint($object, $hint)

deprecated	2012-08-24 Use cHTMLButton instead

Parameters

$object

string ID of the object which receives the hint

$hint

string Text to display

Sets wether the button should be hovered

setHover($hover)

Inherited

inherited_from	\cWidgetButton::setHover()

Parameters

$hover

boolean True if hovering should be used

Sets the ID class

setID(string $id) : \cHTML

Inherited

inherited_from	\cHTML::setID()
inherited_from	\cHTMLSpan::setID()
inherited_from	\cWidgetButton::setID()

Parameters

$id

string

Text to set as the "id"

Returns

\cHTML$this

Sets wether the button should be indented when clicking

setIndent($indent)

Inherited

inherited_from	\cWidgetButton::setIndent()

Parameters

$indent

boolean True if indenting should be used

Sets the CSS style

setStyle(string $style) : \cHTML

Inherited

inherited_from	\cHTML::setStyle()
inherited_from	\cHTMLSpan::setStyle()
inherited_from	\cWidgetButton::setStyle()

Parameters

$style

string

Text to set as the "style" attribute

Returns

\cHTML$this

setStyleDefinition()

setStyleDefinition(string $entity, string $definition) : \cHTML

Inherited

inherited_from	\cHTML::setStyleDefinition()
inherited_from	\cHTMLSpan::setStyleDefinition()
inherited_from	\cWidgetButton::setStyleDefinition()

Parameters

$entity

string

Entity to define

$definition

string

Definition for the given entity

Returns

\cHTML$this

Sets the HTML tag to $tag

setTag(string $tag) : \cHTML

Inherited

inherited_from	\cHTML::setTag()
inherited_from	\cHTMLSpan::setTag()
inherited_from	\cWidgetButton::setTag()

Parameters

$tag

string

The new tag

Returns

\cHTML$this

Generates the markup of the element

toHTML() : string

Inherited

inherited_from	\cHTML::toHTML()
inherited_from	\cHTMLSpan::toHTML()
inherited_from	\cWidgetButton::toHTML()

Returns

stringGenerated markup

Removes an event handler

unsetEvent(string $event) : \cHTML

Inherited

example: $item->unsetEvent('change');

inherited_from	\cHTML::unsetEvent()
inherited_from	\cHTMLSpan::unsetEvent()
inherited_from	\cWidgetButton::unsetEvent()

Parameters

$event

string

Type of the event

Returns

\cHTML$this

Updates the passed attribute without changing the other existing attributes

updateAttribute(string $name, string $value) : \cHTML

Inherited

inherited_from	\cHTML::updateAttribute()
inherited_from	\cHTMLSpan::updateAttribute()
inherited_from	\cWidgetButton::updateAttribute()

Parameters

$name

string

the name of the attribute

$value

string

the value of the attribute with the given name

Returns

\cHTML$this

Updates the passed attributes without changing the other existing attributes

updateAttributes(array $attributes) : \cHTML

Inherited

inherited_from	\cHTML::updateAttributes()
inherited_from	\cHTMLSpan::updateAttributes()
inherited_from	\cWidgetButton::updateAttributes()

Parameters

$attributes

array

Associative array with attributes

Returns

\cHTML$this

Adds the given content to the already existing content of this object.

_appendContent(string | object | array $content) : \cHTML

Inherited

inherited_from	\cHTML::_appendContent()
inherited_from	\cHTMLSpan::_appendContent()
inherited_from	\cWidgetButton::_appendContent()

Parameters

$content

stringobjectarray

String with the content or an object to render or an array of strings/objects.

Returns

\cHTML$this

Returns an HTML formatted attribute string

_getAttrString(array $attributes) : string

Inherited

inherited_from	\cHTML::_getAttrString()
inherited_from	\cHTMLSpan::_getAttrString()
inherited_from	\cWidgetButton::_getAttrString()

Parameters

$attributes

array

Associative array with attributes

Returns

stringAttribute string in HTML format

Returns a valid atrributes array.

_parseAttributes(array $attributes) : array

Inherited

inherited_from	\cHTML::_parseAttributes()
inherited_from	\cHTMLSpan::_parseAttributes()
inherited_from	\cWidgetButton::_parseAttributes()

Parameters

$attributes

array

Associative array with attributes

Returns

arraythe parsed attributes

Sets the content of the object

_setContent(string | object | array $content) : \cHTML

Inherited

inherited_from	\cHTML::_setContent()
inherited_from	\cHTMLSpan::_setContent()
inherited_from	\cWidgetButton::_setContent()

Parameters

$content

stringobjectarray

String with the content or a cHTML object to render or an array of strings / objects.

Returns

\cHTML$this

Properties

$_img : object

Inherited

access	private
inherited_from	\cWidgetButton::$$_img

$_link : object

Inherited

access	private
inherited_from	\cWidgetButton::$$_link

$_attributes : array

Inherited

inherited_from	\cHTML::$$_attributes
inherited_from	\cHTMLSpan::$$_attributes
inherited_from	\cWidgetButton::$$_attributes

$_content : string

Inherited

inherited_from	\cHTML::$$_content
inherited_from	\cHTMLSpan::$$_content
inherited_from	\cWidgetButton::$$_content

$_contentlessTag : bool

Inherited

inherited_from	\cHTML::$$_contentlessTag
inherited_from	\cHTMLSpan::$$_contentlessTag
inherited_from	\cWidgetButton::$$_contentlessTag

$_eventDefinitions : array

Inherited

inherited_from	\cHTML::$$_eventDefinitions
inherited_from	\cHTMLSpan::$$_eventDefinitions
inherited_from	\cWidgetButton::$$_eventDefinitions

$_generateXHTML : bool

Inherited

inherited_from	\cHTML::$$_generateXHTML
inherited_from	\cHTMLSpan::$$_generateXHTML
inherited_from	\cWidgetButton::$$_generateXHTML

$_idCounter : int

Inherited

inherited_from	\cHTML::$$_idCounter
inherited_from	\cHTMLSpan::$$_idCounter
inherited_from	\cWidgetButton::$$_idCounter

$_requiredScripts : array

Inherited

inherited_from	\cHTML::$$_requiredScripts
inherited_from	\cHTMLSpan::$$_requiredScripts
inherited_from	\cWidgetButton::$$_requiredScripts

$_skeletonClose : string

Inherited

inherited_from	\cHTML::$$_skeletonClose
inherited_from	\cHTMLSpan::$$_skeletonClose
inherited_from	\cWidgetButton::$$_skeletonClose

$_skeletonOpen : string

Inherited

inherited_from	\cHTML::$$_skeletonOpen
inherited_from	\cHTMLSpan::$$_skeletonOpen
inherited_from	\cWidgetButton::$$_skeletonOpen

$_skeletonSingle : string

Inherited

inherited_from	\cHTML::$$_skeletonSingle
inherited_from	\cHTMLSpan::$$_skeletonSingle
inherited_from	\cWidgetButton::$$_skeletonSingle

$_styleDefinitions : array

Inherited

inherited_from	\cHTML::$$_styleDefinitions
inherited_from	\cHTMLSpan::$$_styleDefinitions
inherited_from	\cWidgetButton::$$_styleDefinitions

$_styleDefs : array

Inherited

inherited_from	\cHTML::$$_styleDefs
inherited_from	\cHTMLSpan::$$_styleDefs
inherited_from	\cWidgetButton::$$_styleDefs

$_tag : string

Inherited

inherited_from	\cHTML::$$_tag
inherited_from	\cHTMLSpan::$$_tag
inherited_from	\cWidgetButton::$$_tag