contenido\classes\widgets\class.widgets.buttons.php

Show:

inherited

Classes

Table of Contents

Project: Contenido Content Management System

Description: Button Widgets

Requirements:

Author: Bjoern Behrens
Con_php_req: 5.0
Copyright: four for business AG
License: http://www.contenido.org/license/LIZENZ.txt
Link: http://www.4fb.de
Link: {@internal created 2005-08-22 $Id: class.widgets.buttons.php,v 1.6 2005/08/22 12:20:23 timo.hummel Exp $ }}
Package: Contenido Backend classes
Version: 1.12

\cWidgetButton
jump to top

Package: Default

Regular push button with hover and push effect

Parent(s): \cHTMLSpan < \cHTML < \HTML_Common
Children: \cWidgetToggleButton; \cWidgetMultiToggleButton
Author: Timo A. Hummel

Properties

$_aEventDefinitions

inherited

Defines which JS events contain which scripts

Inherited from: \cHTML::$$_aEventDefinitions \cHTMLSpan::$$_aEventDefinitions

Details

Type: n/a
Inherited_from: \cHTML::$$_aEventDefinitions
Inherited_from: \cHTMLSpan::$$_aEventDefinitions

$_aStyleDefinitions

inherited

Style definitions

Inherited from: \cHTML::$$_aStyleDefinitions \cHTMLSpan::$$_aStyleDefinitions

Details

Type: n/a
Inherited_from: \cHTML::$$_aStyleDefinitions
Inherited_from: \cHTMLSpan::$$_aStyleDefinitions

$_content

inherited

The content itself

Inherited from: \cHTML::$$_content \cHTMLSpan::$$_content

Details

Type: n/a
Inherited_from: \cHTML::$$_content
Inherited_from: \cHTMLSpan::$$_content

boolean $_contentlessTag

inherited

Defines if the current tag is a contentless tag

Inherited from: \cHTML::$$_contentlessTag \cHTMLSpan::$$_contentlessTag

Details

Type: boolean
Access: private
Inherited_from: \cHTML::$$_contentlessTag
Inherited_from: \cHTMLSpan::$$_contentlessTag

object $_img

Storage of the image object

Details

Type: object
Access: private

object $_link

Storage of the link object

Details

Type: object
Access: private

array $_requiredScripts

inherited

Defines all scripts which are required by the current element

Inherited from: \cHTML::$$_requiredScripts \cHTMLSpan::$$_requiredScripts

Details

Type: array
Access: private
Inherited_from: \cHTML::$$_requiredScripts
Inherited_from: \cHTMLSpan::$$_requiredScripts

string $_skeleton_close

inherited

Storage of the close SGML tag

Inherited from: \cHTML::$$_skeleton_close \cHTMLSpan::$$_skeleton_close

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_skeleton_close
Inherited_from: \cHTMLSpan::$$_skeleton_close

string $_skeleton_open

inherited

Storage of the open SGML tag template

Inherited from: \cHTML::$$_skeleton_open \cHTMLSpan::$$_skeleton_open

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_skeleton_open
Inherited_from: \cHTMLSpan::$$_skeleton_open

string $_skeleton_single

inherited

Storage of a single SGML tag template

Inherited from: \cHTML::$$_skeleton_single \cHTMLSpan::$$_skeleton_single

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_skeleton_single
Inherited_from: \cHTMLSpan::$$_skeleton_single

string $_styledefs

inherited

Defines the style definitions

Inherited from: \cHTML::$$_styledefs \cHTMLSpan::$$_styledefs

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_styledefs
Inherited_from: \cHTMLSpan::$$_styledefs

string $_tag

inherited

Defines which tag to use

Inherited from: \cHTML::$$_tag \cHTMLSpan::$$_tag

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_tag
Inherited_from: \cHTMLSpan::$$_tag

Methods

__toString() : string

inherited

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

Inherited from: \cHTML::__toString()\cHTMLSpan::__toString()

Returns

Type	Description
string	Generated markup

_setContent( $content) : void

inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLSpan::_setContent()

Parameters

Name	Type	Description
$content		string/object String with the content or an object to render.

addRequiredScript( $script) : void

inherited

Inherited from: \cHTML::addRequiredScript()\cHTMLSpan::addRequiredScript()

Parameters

Name	Type	Description
$script

advanceID() : void

inherited

advances to the next ID available in the system.

Inherited from: \cHTML::advanceID()\cHTMLSpan::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.

attachEventDefinition( $sName, $sEvent, $sCode) : void

inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()\cHTMLSpan::attachEventDefinition()

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

Parameters

Name	Type	Description
$sName		string defines the name of the event
$sEvent		string defines the event (e.g. onClick)
$sCode		string defines the code

attachStyleDefinition( $sName, $sDefinition) : string

inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLSpan::attachStyleDefinition()

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;"

Parameters

Name	Type	Description
$sName		string Name for a style definition
$sDefinition		string Definition for the given entity

Returns

Type	Description
string	filled SGML closing skeleton

cHTML() : void

inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLSpan::cHTML()

cHTMLSpan( $content = "") : void

inherited

Constructor.

Inherited from: \cHTMLSpan::cHTMLSpan()

Creates an HTML DIV element.

Parameters

Name	Type	Description
$content		mixed String or object with the contents

cWidgetButton( $img, $alt, $link) : void

Constructor Function

Parameters

Name	Type	Description
$img		string Image location
$alt		string Alternative text
$link		string Link

fillCloseSkeleton() : string

inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLSpan::fillCloseSkeleton()

Returns

Type	Description
string	filled SGML closer skeleton

fillSkeleton( $attributes) : string

inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()\cHTMLSpan::fillSkeleton()

fillSkeleton fills the SGML opener tag with the specified attributes. Attributes need to be passed in the stringyfied variant.

Parameters

Name	Type	Description
$attributes		string Attributes to set

Returns

Type	Description
string	filled SGML opener skeleton

getID() : string

inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLSpan::getID()

Returns

Type	Description
string	current ID

render() : string

Render method

Returns

Type	Description
string	Rendered HTML

setAlt( $alt) : void

inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLSpan::setAlt()

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.

Parameters

Name	Type	Description
$alt		string Text to set as the "alt" attribute

setAttribute( $sAttributeName, $sValue) : void

inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLSpan::setAttribute()

Parameters

Name	Type	Description
$sAttributeName		string Name of the attribute
$sValue		string Value of the attribute

setBorder( $border) : void

sets the border width

Parameters

Name	Type	Description
$border		integer border size

setClass( $class) : void

inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLSpan::setClass()

Parameters

Name	Type	Description
$class		string Text to set as the "alt" attribute

setContent( $content) : void

inherited

setContent: Sets the div's content

Inherited from: \cHTMLSpan::setContent()

Parameters

Name	Type	Description
$content		string/object String with the content or an object to render.

setContentlessTag( $contentlessTag = true) : void

inherited

Inherited from: \cHTML::setContentlessTag()\cHTMLSpan::setContentlessTag()

Parameters

Name	Type	Description
$contentlessTag

setEvent( $event, $action) : void

inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()\cHTMLSpan::setEvent()

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

Parameters

Name	Type	Description
$event		string Type of the event
$action		string Function or action to call (JavaScript Code)

setGenerateXHTML(bool $value) : void

staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLSpan::setGenerateXHTML()

Parameters

Name	Type	Description
$value	bool

setHover( $hover) : void

Sets wether the button should be hovered

Parameters

Name	Type	Description
$hover		boolean True if hovering should be used

setID( $id) : void

inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLSpan::setID()

Parameters

Name	Type	Description
$id

setIndent( $indent) : void

Sets wether the button should be indented when clicking

Parameters

Name	Type	Description
$indent		boolean True if indenting should be used

setStyle( $style) : void

inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLSpan::setStyle()

Parameters

Name	Type	Description
$style

setStyleDefinition( $entity, $definition) : string

inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()\cHTMLSpan::setStyleDefinition()

Parameters

Name	Type	Description
$entity		string Entity to define
$definition		string Definition for the given entity

Returns

Type	Description
string	filled SGML closing skeleton

toHTML() : string

inherited

Renders the SPAN element

Inherited from: \cHTMLSpan::toHTML()

Returns

Type	Description
string	Rendered HTML

unsetEvent( $event) : void

inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()\cHTMLSpan::unsetEvent()

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

Parameters

Name	Type	Description
$event		string Type of the event

\cWidgetMultiToggleButton
jump to top

Package: Default

Toggle buttons for creating a grouped set of buttons

Parent(s): \cWidgetButton < \cHTMLSpan < \cHTML < \HTML_Common
Author: Timo A. Hummel

Properties

$_aEventDefinitions

inherited

Defines which JS events contain which scripts

Inherited from: \cHTML::$$_aEventDefinitions \cHTMLSpan::$$_aEventDefinitions \cWidgetButton::$$_aEventDefinitions

Details

Type: n/a
Inherited_from: \cHTML::$$_aEventDefinitions
Inherited_from: \cHTMLSpan::$$_aEventDefinitions
Inherited_from: \cWidgetButton::$$_aEventDefinitions

$_aStyleDefinitions

inherited

Style definitions

Inherited from: \cHTML::$$_aStyleDefinitions \cHTMLSpan::$$_aStyleDefinitions \cWidgetButton::$$_aStyleDefinitions

Details

Type: n/a
Inherited_from: \cHTML::$$_aStyleDefinitions
Inherited_from: \cHTMLSpan::$$_aStyleDefinitions
Inherited_from: \cWidgetButton::$$_aStyleDefinitions

$_content

inherited

The content itself

Inherited from: \cHTML::$$_content \cHTMLSpan::$$_content \cWidgetButton::$$_content

Details

Type: n/a
Inherited_from: \cHTML::$$_content
Inherited_from: \cHTMLSpan::$$_content
Inherited_from: \cWidgetButton::$$_content

boolean $_contentlessTag

inherited

Defines if the current tag is a contentless tag

Inherited from: \cHTML::$$_contentlessTag \cHTMLSpan::$$_contentlessTag \cWidgetButton::$$_contentlessTag

Details

Type: boolean
Access: private
Inherited_from: \cHTML::$$_contentlessTag
Inherited_from: \cHTMLSpan::$$_contentlessTag
Inherited_from: \cWidgetButton::$$_contentlessTag

object $_img

inherited

Storage of the image object

Inherited from: \cWidgetButton::$$_img

Details

Type: object
Access: private
Inherited_from: \cWidgetButton::$$_img

object $_link

inherited

Storage of the link object

Inherited from: \cWidgetButton::$$_link

Details

Type: object
Access: private
Inherited_from: \cWidgetButton::$$_link

array $_requiredScripts

inherited

Defines all scripts which are required by the current element

Inherited from: \cHTML::$$_requiredScripts \cHTMLSpan::$$_requiredScripts \cWidgetButton::$$_requiredScripts

Details

Type: array
Access: private
Inherited_from: \cHTML::$$_requiredScripts
Inherited_from: \cHTMLSpan::$$_requiredScripts
Inherited_from: \cWidgetButton::$$_requiredScripts

string $_skeleton_close

inherited

Storage of the close SGML tag

Inherited from: \cHTML::$$_skeleton_close \cHTMLSpan::$$_skeleton_close \cWidgetButton::$$_skeleton_close

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_skeleton_close
Inherited_from: \cHTMLSpan::$$_skeleton_close
Inherited_from: \cWidgetButton::$$_skeleton_close

string $_skeleton_open

inherited

Storage of the open SGML tag template

Inherited from: \cHTML::$$_skeleton_open \cHTMLSpan::$$_skeleton_open \cWidgetButton::$$_skeleton_open

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_skeleton_open
Inherited_from: \cHTMLSpan::$$_skeleton_open
Inherited_from: \cWidgetButton::$$_skeleton_open

string $_skeleton_single

inherited

Storage of a single SGML tag template

Inherited from: \cHTML::$$_skeleton_single \cHTMLSpan::$$_skeleton_single \cWidgetButton::$$_skeleton_single

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_skeleton_single
Inherited_from: \cHTMLSpan::$$_skeleton_single
Inherited_from: \cWidgetButton::$$_skeleton_single

string $_styledefs

inherited

Defines the style definitions

Inherited from: \cHTML::$$_styledefs \cHTMLSpan::$$_styledefs \cWidgetButton::$$_styledefs

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_styledefs
Inherited_from: \cHTMLSpan::$$_styledefs
Inherited_from: \cWidgetButton::$$_styledefs

string $_tag

inherited

Defines which tag to use

Inherited from: \cHTML::$$_tag \cHTMLSpan::$$_tag \cWidgetButton::$$_tag

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_tag
Inherited_from: \cHTMLSpan::$$_tag
Inherited_from: \cWidgetButton::$$_tag

Methods

__toString() : string

inherited

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

Inherited from: \cHTML::__toString()\cHTMLSpan::__toString()\cWidgetButton::__toString()

Returns

Type	Description
string	Generated markup

_setContent( $content) : void

inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLSpan::_setContent()\cWidgetButton::_setContent()

Parameters

Name	Type	Description
$content		string/object String with the content or an object to render.

addLinkedItem( $item) : void

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

Parameters

Name	Type	Description
$item		mixed Either another cWidgetMultiToggleButton (or derivates) or the ID of the target button.

addRequiredScript( $script) : void

inherited

Inherited from: \cHTML::addRequiredScript()\cHTMLSpan::addRequiredScript()\cWidgetButton::addRequiredScript()

Parameters

Name	Type	Description
$script

advanceID() : void

inherited

advances to the next ID available in the system.

Inherited from: \cHTML::advanceID()\cHTMLSpan::advanceID()\cWidgetButton::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.

attachEventDefinition( $sName, $sEvent, $sCode) : void

inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()\cHTMLSpan::attachEventDefinition()\cWidgetButton::attachEventDefinition()

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

Parameters

Name	Type	Description
$sName		string defines the name of the event
$sEvent		string defines the event (e.g. onClick)
$sCode		string defines the code

attachStyleDefinition( $sName, $sDefinition) : string

inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLSpan::attachStyleDefinition()\cWidgetButton::attachStyleDefinition()

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;"

Parameters

Name	Type	Description
$sName		string Name for a style definition
$sDefinition		string Definition for the given entity

Returns

Type	Description
string	filled SGML closing skeleton

cHTML() : void

inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLSpan::cHTML()\cWidgetButton::cHTML()

cHTMLSpan( $content = "") : void

inherited

Constructor.

Inherited from: \cHTMLSpan::cHTMLSpan()\cWidgetButton::cHTMLSpan()

Creates an HTML DIV element.

Parameters

Name	Type	Description
$content		mixed String or object with the contents

cWidgetButton( $img, $alt, $link) : void

inherited

Constructor Function

Inherited from: \cWidgetButton::cWidgetButton()

Parameters

Name	Type	Description
$img		string Image location
$alt		string Alternative text
$link		string Link

cWidgetMultiToggleButton( $img, $alt, $link) : void

Constructor Function

Parameters

Name	Type	Description
$img		string Image location
$alt		string Alternative text
$link

fillCloseSkeleton() : string

inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLSpan::fillCloseSkeleton()\cWidgetButton::fillCloseSkeleton()

Returns

Type	Description
string	filled SGML closer skeleton

fillSkeleton( $attributes) : string

inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()\cHTMLSpan::fillSkeleton()\cWidgetButton::fillSkeleton()

fillSkeleton fills the SGML opener tag with the specified attributes. Attributes need to be passed in the stringyfied variant.

Parameters

Name	Type	Description
$attributes		string Attributes to set

Returns

Type	Description
string	filled SGML opener skeleton

getID() : string

inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLSpan::getID()\cWidgetButton::getID()

Returns

Type	Description
string	current ID

render() : string

Render method

Returns

Type	Description
string	Rendered HTML

setAlt( $alt) : void

inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLSpan::setAlt()\cWidgetButton::setAlt()

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.

Parameters

Name	Type	Description
$alt		string Text to set as the "alt" attribute

setAttribute( $sAttributeName, $sValue) : void

inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLSpan::setAttribute()\cWidgetButton::setAttribute()

Parameters

Name	Type	Description
$sAttributeName		string Name of the attribute
$sValue		string Value of the attribute

setBorder( $border) : void

inherited

sets the border width

Inherited from: \cWidgetButton::setBorder()

Parameters

Name	Type	Description
$border		integer border size

setClass( $class) : void

inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLSpan::setClass()\cWidgetButton::setClass()

Parameters

Name	Type	Description
$class		string Text to set as the "alt" attribute

setContent( $content) : void

inherited

setContent: Sets the div's content

Inherited from: \cHTMLSpan::setContent()\cWidgetButton::setContent()

Parameters

Name	Type	Description
$content		string/object String with the content or an object to render.

setContentlessTag( $contentlessTag = true) : void

inherited

Inherited from: \cHTML::setContentlessTag()\cHTMLSpan::setContentlessTag()\cWidgetButton::setContentlessTag()

Parameters

Name	Type	Description
$contentlessTag

setDefault( $default = true) : void

Sets or deletes the default state for this button.

Warning: This method doesn't update other buttons.

Parameters

Name	Type	Description
$default		boolean If true, this button is a default (e.g. pushed) button.

setEvent( $event, $action) : void

inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()\cHTMLSpan::setEvent()\cWidgetButton::setEvent()

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

Parameters

Name	Type	Description
$event		string Type of the event
$action		string Function or action to call (JavaScript Code)

setGenerateXHTML(bool $value) : void

staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLSpan::setGenerateXHTML()\cWidgetButton::setGenerateXHTML()

Parameters

Name	Type	Description
$value	bool

setHint( $object, $hint) : void

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

Parameters

Name	Type	Description
$object		string ID of the object which receives the hint
$hint		string Text to display

setHover( $hover) : void

inherited

Sets wether the button should be hovered

Inherited from: \cWidgetButton::setHover()

Parameters

Name	Type	Description
$hover		boolean True if hovering should be used

setID( $id) : void

inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLSpan::setID()\cWidgetButton::setID()

Parameters

Name	Type	Description
$id

setIndent( $indent) : void

inherited

Sets wether the button should be indented when clicking

Inherited from: \cWidgetButton::setIndent()

Parameters

Name	Type	Description
$indent		boolean True if indenting should be used

setStyle( $style) : void

inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLSpan::setStyle()\cWidgetButton::setStyle()

Parameters

Name	Type	Description
$style

setStyleDefinition( $entity, $definition) : string

inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()\cHTMLSpan::setStyleDefinition()\cWidgetButton::setStyleDefinition()

Parameters

Name	Type	Description
$entity		string Entity to define
$definition		string Definition for the given entity

Returns

Type	Description
string	filled SGML closing skeleton

toHTML() : string

inherited

Renders the SPAN element

Inherited from: \cHTMLSpan::toHTML()\cWidgetButton::toHTML()

Returns

Type	Description
string	Rendered HTML

unsetEvent( $event) : void

inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()\cHTMLSpan::unsetEvent()\cWidgetButton::unsetEvent()

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

Parameters

Name	Type	Description
$event		string Type of the event

\cWidgetToggleButton
jump to top

Package: Default

Toggle button (on/off) with two different links

Parent(s): \cWidgetButton < \cHTMLSpan < \cHTML < \HTML_Common
Author: Timo A. Hummel

Properties

$_aEventDefinitions

inherited

Defines which JS events contain which scripts

Inherited from: \cHTML::$$_aEventDefinitions \cHTMLSpan::$$_aEventDefinitions \cWidgetButton::$$_aEventDefinitions

Details

Type: n/a
Inherited_from: \cHTML::$$_aEventDefinitions
Inherited_from: \cHTMLSpan::$$_aEventDefinitions
Inherited_from: \cWidgetButton::$$_aEventDefinitions

$_aStyleDefinitions

inherited

Style definitions

Inherited from: \cHTML::$$_aStyleDefinitions \cHTMLSpan::$$_aStyleDefinitions \cWidgetButton::$$_aStyleDefinitions

Details

Type: n/a
Inherited_from: \cHTML::$$_aStyleDefinitions
Inherited_from: \cHTMLSpan::$$_aStyleDefinitions
Inherited_from: \cWidgetButton::$$_aStyleDefinitions

$_content

inherited

The content itself

Inherited from: \cHTML::$$_content \cHTMLSpan::$$_content \cWidgetButton::$$_content

Details

Type: n/a
Inherited_from: \cHTML::$$_content
Inherited_from: \cHTMLSpan::$$_content
Inherited_from: \cWidgetButton::$$_content

boolean $_contentlessTag

inherited

Defines if the current tag is a contentless tag

Inherited from: \cHTML::$$_contentlessTag \cHTMLSpan::$$_contentlessTag \cWidgetButton::$$_contentlessTag

Details

Type: boolean
Access: private
Inherited_from: \cHTML::$$_contentlessTag
Inherited_from: \cHTMLSpan::$$_contentlessTag
Inherited_from: \cWidgetButton::$$_contentlessTag

object $_img

inherited

Storage of the image object

Inherited from: \cWidgetButton::$$_img

Details

Type: object
Access: private
Inherited_from: \cWidgetButton::$$_img

object $_link

inherited

Storage of the link object

Inherited from: \cWidgetButton::$$_link

Details

Type: object
Access: private
Inherited_from: \cWidgetButton::$$_link

array $_requiredScripts

inherited

Defines all scripts which are required by the current element

Inherited from: \cHTML::$$_requiredScripts \cHTMLSpan::$$_requiredScripts \cWidgetButton::$$_requiredScripts

Details

Type: array
Access: private
Inherited_from: \cHTML::$$_requiredScripts
Inherited_from: \cHTMLSpan::$$_requiredScripts
Inherited_from: \cWidgetButton::$$_requiredScripts

string $_skeleton_close

inherited

Storage of the close SGML tag

Inherited from: \cHTML::$$_skeleton_close \cHTMLSpan::$$_skeleton_close \cWidgetButton::$$_skeleton_close

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_skeleton_close
Inherited_from: \cHTMLSpan::$$_skeleton_close
Inherited_from: \cWidgetButton::$$_skeleton_close

string $_skeleton_open

inherited

Storage of the open SGML tag template

Inherited from: \cHTML::$$_skeleton_open \cHTMLSpan::$$_skeleton_open \cWidgetButton::$$_skeleton_open

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_skeleton_open
Inherited_from: \cHTMLSpan::$$_skeleton_open
Inherited_from: \cWidgetButton::$$_skeleton_open

string $_skeleton_single

inherited

Storage of a single SGML tag template

Inherited from: \cHTML::$$_skeleton_single \cHTMLSpan::$$_skeleton_single \cWidgetButton::$$_skeleton_single

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_skeleton_single
Inherited_from: \cHTMLSpan::$$_skeleton_single
Inherited_from: \cWidgetButton::$$_skeleton_single

string $_styledefs

inherited

Defines the style definitions

Inherited from: \cHTML::$$_styledefs \cHTMLSpan::$$_styledefs \cWidgetButton::$$_styledefs

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_styledefs
Inherited_from: \cHTMLSpan::$$_styledefs
Inherited_from: \cWidgetButton::$$_styledefs

string $_tag

inherited

Defines which tag to use

Inherited from: \cHTML::$$_tag \cHTMLSpan::$$_tag \cWidgetButton::$$_tag

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_tag
Inherited_from: \cHTMLSpan::$$_tag
Inherited_from: \cWidgetButton::$$_tag

Methods

__toString() : string

inherited

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

Inherited from: \cHTML::__toString()\cHTMLSpan::__toString()\cWidgetButton::__toString()

Returns

Type	Description
string	Generated markup

_setContent( $content) : void

inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLSpan::_setContent()\cWidgetButton::_setContent()

Parameters

Name	Type	Description
$content		string/object String with the content or an object to render.

addRequiredScript( $script) : void

inherited

Inherited from: \cHTML::addRequiredScript()\cHTMLSpan::addRequiredScript()\cWidgetButton::addRequiredScript()

Parameters

Name	Type	Description
$script

advanceID() : void

inherited

advances to the next ID available in the system.

Inherited from: \cHTML::advanceID()\cHTMLSpan::advanceID()\cWidgetButton::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.

attachEventDefinition( $sName, $sEvent, $sCode) : void

inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()\cHTMLSpan::attachEventDefinition()\cWidgetButton::attachEventDefinition()

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

Parameters

Name	Type	Description
$sName		string defines the name of the event
$sEvent		string defines the event (e.g. onClick)
$sCode		string defines the code

attachStyleDefinition( $sName, $sDefinition) : string

inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLSpan::attachStyleDefinition()\cWidgetButton::attachStyleDefinition()

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;"

Parameters

Name	Type	Description
$sName		string Name for a style definition
$sDefinition		string Definition for the given entity

Returns

Type	Description
string	filled SGML closing skeleton

cHTML() : void

inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLSpan::cHTML()\cWidgetButton::cHTML()

cHTMLSpan( $content = "") : void

inherited

Constructor.

Inherited from: \cHTMLSpan::cHTMLSpan()\cWidgetButton::cHTMLSpan()

Creates an HTML DIV element.

Parameters

Name	Type	Description
$content		mixed String or object with the contents

cWidgetButton( $img, $alt, $link) : void

inherited

Constructor Function

Inherited from: \cWidgetButton::cWidgetButton()

Parameters

Name	Type	Description
$img		string Image location
$alt		string Alternative text
$link		string Link

cWidgetToggleButton( $img, $alt, $uplink, $downlink) : void

Constructor Function

Parameters

Name	Type	Description
$img		string Image location
$alt		string Alternative text
$uplink		string Link when the button is turned off (=up)
$downlink		string Link when the button is turned on (=down)

fillCloseSkeleton() : string

inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLSpan::fillCloseSkeleton()\cWidgetButton::fillCloseSkeleton()

Returns

Type	Description
string	filled SGML closer skeleton

fillSkeleton( $attributes) : string

inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()\cHTMLSpan::fillSkeleton()\cWidgetButton::fillSkeleton()

fillSkeleton fills the SGML opener tag with the specified attributes. Attributes need to be passed in the stringyfied variant.

Parameters

Name	Type	Description
$attributes		string Attributes to set

Returns

Type	Description
string	filled SGML opener skeleton

getID() : string

inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLSpan::getID()\cWidgetButton::getID()

Returns

Type	Description
string	current ID

render() : string

Render method

Returns

Type	Description
string	Rendered HTML

setAlt( $alt) : void

inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLSpan::setAlt()\cWidgetButton::setAlt()

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.

Parameters

Name	Type	Description
$alt		string Text to set as the "alt" attribute

setAttribute( $sAttributeName, $sValue) : void

inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLSpan::setAttribute()\cWidgetButton::setAttribute()

Parameters

Name	Type	Description
$sAttributeName		string Name of the attribute
$sValue		string Value of the attribute

setBorder( $border) : void

inherited

sets the border width

Inherited from: \cWidgetButton::setBorder()

Parameters

Name	Type	Description
$border		integer border size

setClass( $class) : void

inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLSpan::setClass()\cWidgetButton::setClass()

Parameters

Name	Type	Description
$class		string Text to set as the "alt" attribute

setContent( $content) : void

inherited

setContent: Sets the div's content

Inherited from: \cHTMLSpan::setContent()\cWidgetButton::setContent()

Parameters

Name	Type	Description
$content		string/object String with the content or an object to render.

setContentlessTag( $contentlessTag = true) : void

inherited

Inherited from: \cHTML::setContentlessTag()\cHTMLSpan::setContentlessTag()\cWidgetButton::setContentlessTag()

Parameters

Name	Type	Description
$contentlessTag

setEvent( $event, $action) : void

inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()\cHTMLSpan::setEvent()\cWidgetButton::setEvent()

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

Parameters

Name	Type	Description
$event		string Type of the event
$action		string Function or action to call (JavaScript Code)

setGenerateXHTML(bool $value) : void

staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLSpan::setGenerateXHTML()\cWidgetButton::setGenerateXHTML()

Parameters

Name	Type	Description
$value	bool

setHover( $hover) : void

inherited

Sets wether the button should be hovered

Inherited from: \cWidgetButton::setHover()

Parameters

Name	Type	Description
$hover		boolean True if hovering should be used

setID( $id) : void

inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLSpan::setID()\cWidgetButton::setID()

Parameters

Name	Type	Description
$id

setIndent( $indent) : void

inherited

Sets wether the button should be indented when clicking

Inherited from: \cWidgetButton::setIndent()

Parameters

Name	Type	Description
$indent		boolean True if indenting should be used

setStyle( $style) : void

inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLSpan::setStyle()\cWidgetButton::setStyle()

Parameters

Name	Type	Description
$style

setStyleDefinition( $entity, $definition) : string

inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()\cHTMLSpan::setStyleDefinition()\cWidgetButton::setStyleDefinition()

Parameters

Name	Type	Description
$entity		string Entity to define
$definition		string Definition for the given entity

Returns

Type	Description
string	filled SGML closing skeleton

toHTML() : string

inherited

Renders the SPAN element

Inherited from: \cHTMLSpan::toHTML()\cWidgetButton::toHTML()

Returns

Type	Description
string	Rendered HTML

unsetEvent( $event) : void

inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()\cHTMLSpan::unsetEvent()\cWidgetButton::unsetEvent()

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

Parameters

Name	Type	Description
$event		string Type of the event

contenido\classes\widgets\class.widgets.buttons.php

\cWidgetButtonjump to top

Properties

Methods

\cWidgetMultiToggleButtonjump to top

Properties

Methods

\cWidgetToggleButtonjump to top

Properties

Methods

\cWidgetButton
jump to top

\cWidgetMultiToggleButton
jump to top

\cWidgetToggleButton
jump to top