contenido\classes\class.htmlelements.php

Show: PublicProtectedPrivateinherited
Table of Contents
Project: Contenido Content Management System

Description: HTML elements

Requirements:

Author
Timo A. Hummel  
Con_php_req
5.0  
Copyright
four for business AG  
License
http://www.contenido.org/license/LIZENZ.txt  
Link
http://www.4fb.de  
Link
http://www.contenido.org  
Package
Contenido Backend classes  
Since
file available since contenido release <= 4.6 {@internal created 2003-08-21 modified 2008-07-02, Frederic Schneider, add security fix $Id: class.htmlelements.php 469 2008-07-02 09:44:45Z frederic.schneider $: }}  
Version
1.6.2  

\cHTML

Package: Default
Base class for all Contenido HTML classes
Parent(s)
\HTML_Common
Children
\cHTMLFormElement
\cHTMLLabel
\cHTMLLink
\cHTMLDiv
\cHTMLSpan
\cHTMLImage
\cHTMLTable
\cHTMLTableBody
\cHTMLTableRow
\cHTMLTableData
\cHTMLTableHead
\cHTMLTableHeader
\cHTMLIFrame
\cHTMLForm
\cHTMLScript
\cFoldingRow
\cPage
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
Defines which JS events contain which scripts
Details
Type
n/a
>VPropertypublic$_aStyleDefinitions
Style definitions
Details
Type
n/a
>VPropertypublic$_content
The content itself
Details
Type
n/a
>VPropertypublicboolean $_contentlessTag
Defines if the current tag is a contentless tag
Details
Type
boolean
Access
private  
>VPropertypublicarray $_requiredScripts
Defines all scripts which are required by the current element
Details
Type
array
Access
private  
>VPropertypublicstring $_skeleton_close
Storage of the close SGML tag
Details
Type
string
Access
private  
>VPropertypublicstring $_skeleton_open
Storage of the open SGML tag template
Details
Type
string
Access
private  
>VPropertypublicstring $_skeleton_single
Storage of a single SGML tag template
Details
Type
string
Access
private  
>VPropertypublicstring $_styledefs
Defines the style definitions
Details
Type
string
Access
private  
>VPropertypublicstring $_tag
Defines which tag to use
Details
Type
string
Access
private  

Methods

methodpublic__toString() : string

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

Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void

_setContent: Sets the content of the object

Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void

Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void

advances to the next ID available in the system.

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.

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

attachEventDefinition: Attaches the code for an event

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string

attachStyleDefinition: Attaches a style definition.

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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void

Constructor Function Initializes the SGML open/close tags

methodpublicfillCloseSkeleton() : string

fillCloseSkeleton: Fills the close skeleton

Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string

fillSkeleton: Fills the open SGML tag skeleton

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string

getID: returns the current ID

Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string

render(): Alias for toHtml

Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void

setAlt: sets the alt and title attributes

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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void

setAttribte: Sets a specific attribute

Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void

sets the CSS class

Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContentlessTag( $contentlessTag = true) : void

Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEvent( $event,  $action) : void

adds an "onXXX" javascript event handler

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
static

Setter for static $_generateXHTML property

Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void

sets the ID class

Parameters
NameTypeDescription
$id
methodpublicsetStyle( $style) : void

sets the CSS style

Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string

addStyleDefinition

Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
Details
Deprecated
name change, use attachStyleDefinition  
methodpublictoHTML() : void

Renders the output If the tag

methodpublicunsetEvent( $event) : void

removes an event handler

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLAlignmentTable

Package: Default
Table Element
Parent(s)
\cHTMLTable < \cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions\cHTMLTable::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
Inherited_from
\cHTMLTable::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions\cHTMLTable::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
Inherited_from
\cHTMLTable::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content\cHTMLTable::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
Inherited_from
\cHTMLTable::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag\cHTMLTable::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cHTMLTable::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cHTMLTable::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cHTMLTable::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close\cHTMLTable::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cHTMLTable::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open\cHTMLTable::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cHTMLTable::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single\cHTMLTable::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cHTMLTable::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs\cHTMLTable::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cHTMLTable::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag\cHTMLTable::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cHTMLTable::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()\cHTMLTable::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLTable::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

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

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

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

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLTable::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLTable::cHTML()
methodpubliccHTMLAlignmentTable() : void

methodpubliccHTMLTable() : void
inherited

Inherited from: \cHTMLTable::cHTMLTable()
methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLTable::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

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

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLTable::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string

render(): Alias for toHtml

Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLTable::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLTable::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetBorder(\border $border) : void
inherited

setBorder: Sets the table's border

Inherited from: \cHTMLTable::setBorder()
Parameters
NameTypeDescription
$border\border

Border size

methodpublicsetCellPadding( $cellpadding) : void
inherited

setCellPadding: Sets the padding between cells

Inherited from: \cHTMLTable::setCellPadding()
Parameters
NameTypeDescription
$cellpadding

Padding

methodpublicsetCellSpacing( $cellspacing) : void
inherited

setCellSpacing: Sets the spacing between cells

Inherited from: \cHTMLTable::setCellSpacing()
Parameters
NameTypeDescription
$cellspacing

Spacing

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLTable::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContent( $content) : void
inherited

setContent: Sets the table's content

Inherited from: \cHTMLTable::setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicsetContentlessTag( $contentlessTag = true) : void
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLTable::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLTable::setID()
Parameters
NameTypeDescription
$id
methodpublicsetPadding( $cellpadding) : void
inherited

Inherited from: \cHTMLTable::setPadding()
Parameters
NameTypeDescription
$cellpadding
methodpublicsetSpacing( $cellspacing) : void
inherited

Inherited from: \cHTMLTable::setSpacing()
Parameters
NameTypeDescription
$cellspacing
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLTable::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()\cHTMLTable::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetWidth( $width) : void
inherited

setWidth: Sets the table width

Inherited from: \cHTMLTable::setWidth()
Parameters
NameTypeDescription
$width

Width

methodpublictoHTML() : string
inherited

Renders the Table element

Inherited from: \cHTMLTable::toHTML()
Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLButton

Package: Default
HTML Button class
Parent(s)
\cHTMLFormElement < \cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions\cHTMLFormElement::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
Inherited_from
\cHTMLFormElement::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
Inherited_from
\cHTMLFormElement::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content\cHTMLFormElement::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
Inherited_from
\cHTMLFormElement::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag\cHTMLFormElement::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cHTMLFormElement::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cHTMLFormElement::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cHTMLFormElement::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close\cHTMLFormElement::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cHTMLFormElement::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open\cHTMLFormElement::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cHTMLFormElement::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single\cHTMLFormElement::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cHTMLFormElement::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs\cHTMLFormElement::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cHTMLFormElement::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag\cHTMLFormElement::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cHTMLFormElement::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()\cHTMLFormElement::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLFormElement::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

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

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

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

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLFormElement::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLFormElement::cHTML()
methodpubliccHTMLButton( $name,  $title = "",  $id = "",  $disabled = false,  $tabindex = null,  $accesskey = "",  $mode = "submit") : \none

Constructor.

Creates an HTML button.

Creates a submit button by default, can be changed using setMode.

Parameters
NameTypeDescription
$name

string Name of the element

$title

string Title of the button

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

$mode
Returns
TypeDescription
\none
methodpubliccHTMLFormElement( $name = "",  $id = "",  $disabled = "",  $tabindex = "",  $accesskey = "") : \none
inherited

Constructor.

Inherited from: \cHTMLFormElement::cHTMLFormElement()

This is a generic form element, where specific elements should be inherited from this class.

Parameters
NameTypeDescription
$name

string Name of the element

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLFormElement::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

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

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLFormElement::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()\cHTMLFormElement::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAccessKey( $accesskey) : \none
inherited

sets the access key for this element.

Inherited from: \cHTMLFormElement::setAccessKey()
Parameters
NameTypeDescription
$accesskey

string The length of the access key. May be A-Z and 0-9.

Returns
TypeDescription
\none
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLFormElement::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLFormElement::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLFormElement::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContentlessTag( $contentlessTag = true) : void
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetDisabled( $disabled) : \none
inherited

Sets the "disabled" attribute of an element.

Inherited from: \cHTMLFormElement::setDisabled()

User Agents usually are showing the element as "greyed-out".

Example: $obj->setDisabled("disabled"); $obj->setDisabled("");

The first example sets the disabled flag, the second one removes the disabled flag.

Parameters
NameTypeDescription
$disabled

string Sets the disabled-flag if non-empty

Returns
TypeDescription
\none
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLFormElement::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLFormElement::setID()
Parameters
NameTypeDescription
$id
methodpublicsetImageSource( $src) : void

Set the image src if mode type is "image"

Parameters
NameTypeDescription
$src
methodpublicsetMode( $mode) : boolean

Sets the mode (submit or reset) for the button

Parameters
NameTypeDescription
$mode

string Either "submit", "reset" or "image".

Returns
TypeDescription
booleanReturns false if failed to set the mode
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLFormElement::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetTabindex( $tabindex) : \none
inherited

sets the tab index for this element.

Inherited from: \cHTMLFormElement::setTabindex()

The tab index needs to be numeric, bigger than 0 and smaller than 32767.

Parameters
NameTypeDescription
$tabindex

int desired tab index

Returns
TypeDescription
\none
methodpublicsetTitle( $title) : \none

Sets the title (caption) for the button

Parameters
NameTypeDescription
$title

string The title to set

Returns
TypeDescription
\none
methodpublictoHTML() : void
inherited

Renders the output If the tag

Inherited from: \cHTML::toHTML()\cHTMLFormElement::toHTML()
methodpublictoHtml() : string

Renders the button

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLCheckbox

Package: Default
HTML Checkbox
Parent(s)
\cHTMLFormElement < \cHTML < \HTML_Common
Children
\cDataCheckboxWidget
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions\cHTMLFormElement::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
Inherited_from
\cHTMLFormElement::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
Inherited_from
\cHTMLFormElement::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content\cHTMLFormElement::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
Inherited_from
\cHTMLFormElement::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag\cHTMLFormElement::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cHTMLFormElement::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cHTMLFormElement::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cHTMLFormElement::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close\cHTMLFormElement::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cHTMLFormElement::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open\cHTMLFormElement::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cHTMLFormElement::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single\cHTMLFormElement::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cHTMLFormElement::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs\cHTMLFormElement::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cHTMLFormElement::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag\cHTMLFormElement::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cHTMLFormElement::$$_tag  
>VPropertypublic$_value
Details
Type
n/a

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()\cHTMLFormElement::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLFormElement::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

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

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

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

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLFormElement::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLFormElement::cHTML()
methodpubliccHTMLCheckbox( $name,  $value,  $id = "",  $checked = false,  $disabled = false,  $tabindex = null,  $accesskey = "") : \none

Constructor.

Creates an HTML checkbox element.

Parameters
NameTypeDescription
$name

string Name of the element

$value

string Value of the radio button

$id

string ID of the element

$checked

boolean Is element checked?

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpubliccHTMLFormElement( $name = "",  $id = "",  $disabled = "",  $tabindex = "",  $accesskey = "") : \none
inherited

Constructor.

Inherited from: \cHTMLFormElement::cHTMLFormElement()

This is a generic form element, where specific elements should be inherited from this class.

Parameters
NameTypeDescription
$name

string Name of the element

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLFormElement::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

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

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLFormElement::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()\cHTMLFormElement::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAccessKey( $accesskey) : \none
inherited

sets the access key for this element.

Inherited from: \cHTMLFormElement::setAccessKey()
Parameters
NameTypeDescription
$accesskey

string The length of the access key. May be A-Z and 0-9.

Returns
TypeDescription
\none
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLFormElement::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLFormElement::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetChecked( $checked) : \none

Sets the checked flag.

Parameters
NameTypeDescription
$checked

boolean If true, the "checked" attribute will be assigned.

Returns
TypeDescription
\none
methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLFormElement::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContentlessTag( $contentlessTag = true) : void
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetDisabled( $disabled) : \none
inherited

Sets the "disabled" attribute of an element.

Inherited from: \cHTMLFormElement::setDisabled()

User Agents usually are showing the element as "greyed-out".

Example: $obj->setDisabled("disabled"); $obj->setDisabled("");

The first example sets the disabled flag, the second one removes the disabled flag.

Parameters
NameTypeDescription
$disabled

string Sets the disabled-flag if non-empty

Returns
TypeDescription
\none
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLFormElement::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLFormElement::setID()
Parameters
NameTypeDescription
$id
methodpublicsetLabelText( $text) : \none

Sets a custom label text

Parameters
NameTypeDescription
$text

string Text to display

Returns
TypeDescription
\none
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLFormElement::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetTabindex( $tabindex) : \none
inherited

sets the tab index for this element.

Inherited from: \cHTMLFormElement::setTabindex()

The tab index needs to be numeric, bigger than 0 and smaller than 32767.

Parameters
NameTypeDescription
$tabindex

int desired tab index

Returns
TypeDescription
\none
methodpublictoHTML() : void
inherited

Renders the output If the tag

Inherited from: \cHTML::toHTML()\cHTMLFormElement::toHTML()
methodpublictoHtml( $renderlabel = true) : string

Renders the checkbox element.

Note:

If this element has an ID, the value (which equals the text displayed) will be rendered as seperate HTML label, if not, it will be displayed as regular text. Displaying the value can be turned off via the parameter.

Parameters
NameTypeDescription
$renderlabel

boolean If true, renders a label

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLDiv

Package: Default
Div Element
Parent(s)
\cHTML < \HTML_Common
Children
\NoteList
\NoteListItem
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
inherited

Inherited from: \cHTML::addRequiredScript()
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::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.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()
methodpubliccHTMLDiv( $content = "") : void

Constructor.

Creates an HTML DIV element.

Parameters
NameTypeDescription
$content

mixed String or object with the contents

methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContent( $content) : void

setContent: Sets the div's content

Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicsetContentlessTag( $contentlessTag = true) : void
inherited

Inherited from: \cHTML::setContentlessTag()
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()
Parameters
NameTypeDescription
$id
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublictoHTML() : string

Renders the DIV element

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLForm

Package: Default
Base class for all Contenido HTML classes
Parent(s)
\cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
inherited

Inherited from: \cHTML::addRequiredScript()
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::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.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()
methodpubliccHTMLForm() : void

methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContent( $content) : void

setContent: Sets the form's content

Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicsetContentlessTag( $contentlessTag = true) : void
inherited

Inherited from: \cHTML::setContentlessTag()
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()
Parameters
NameTypeDescription
$id
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetVar( $var,  $value) : void

Parameters
NameTypeDescription
$var
$value
methodpublictoHTML() : string

Renders the form element

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLFormElement

Package: Default
HTML Form element class
Parent(s)
\cHTML < \HTML_Common
Children
\cHTMLHiddenField
\cHTMLButton
\cHTMLTextbox
\cHTMLPasswordbox
\cHTMLTextarea
\cHTMLSelectElement
\cHTMLOptionElement
\cHTMLRadiobutton
\cHTMLCheckbox
\cHTMLUpload
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
inherited

Inherited from: \cHTML::addRequiredScript()
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::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.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()
methodpubliccHTMLFormElement( $name = "",  $id = "",  $disabled = "",  $tabindex = "",  $accesskey = "") : \none

Constructor.

This is a generic form element, where specific elements should be inherited from this class.

Parameters
NameTypeDescription
$name

string Name of the element

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAccessKey( $accesskey) : \none

sets the access key for this element.

Parameters
NameTypeDescription
$accesskey

string The length of the access key. May be A-Z and 0-9.

Returns
TypeDescription
\none
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContentlessTag( $contentlessTag = true) : void
inherited

Inherited from: \cHTML::setContentlessTag()
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetDisabled( $disabled) : \none

Sets the "disabled" attribute of an element.

User Agents usually are showing the element as "greyed-out".

Example: $obj->setDisabled("disabled"); $obj->setDisabled("");

The first example sets the disabled flag, the second one removes the disabled flag.

Parameters
NameTypeDescription
$disabled

string Sets the disabled-flag if non-empty

Returns
TypeDescription
\none
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()
Parameters
NameTypeDescription
$id
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetTabindex( $tabindex) : \none

sets the tab index for this element.

The tab index needs to be numeric, bigger than 0 and smaller than 32767.

Parameters
NameTypeDescription
$tabindex

int desired tab index

Returns
TypeDescription
\none
methodpublictoHTML() : void
inherited

Renders the output If the tag

Inherited from: \cHTML::toHTML()
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLHiddenField

Package: Default
HTML Hidden Field
Parent(s)
\cHTMLFormElement < \cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions\cHTMLFormElement::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
Inherited_from
\cHTMLFormElement::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
Inherited_from
\cHTMLFormElement::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content\cHTMLFormElement::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
Inherited_from
\cHTMLFormElement::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag\cHTMLFormElement::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cHTMLFormElement::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cHTMLFormElement::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cHTMLFormElement::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close\cHTMLFormElement::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cHTMLFormElement::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open\cHTMLFormElement::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cHTMLFormElement::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single\cHTMLFormElement::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cHTMLFormElement::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs\cHTMLFormElement::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cHTMLFormElement::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag\cHTMLFormElement::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cHTMLFormElement::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()\cHTMLFormElement::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLFormElement::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

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

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

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

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLFormElement::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLFormElement::cHTML()
methodpubliccHTMLFormElement( $name = "",  $id = "",  $disabled = "",  $tabindex = "",  $accesskey = "") : \none
inherited

Constructor.

Inherited from: \cHTMLFormElement::cHTMLFormElement()

This is a generic form element, where specific elements should be inherited from this class.

Parameters
NameTypeDescription
$name

string Name of the element

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpubliccHTMLHiddenField( $name,  $value = "",  $id = "") : \none

Constructor.

Creates an HTML hidden field.

Parameters
NameTypeDescription
$name

string Name of the element

$value

string Title of the button

$id

string ID of the element

Returns
TypeDescription
\none
methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLFormElement::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

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

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLFormElement::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()\cHTMLFormElement::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAccessKey( $accesskey) : \none
inherited

sets the access key for this element.

Inherited from: \cHTMLFormElement::setAccessKey()
Parameters
NameTypeDescription
$accesskey

string The length of the access key. May be A-Z and 0-9.

Returns
TypeDescription
\none
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLFormElement::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLFormElement::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLFormElement::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContentlessTag( $contentlessTag = true) : void
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetDisabled( $disabled) : \none
inherited

Sets the "disabled" attribute of an element.

Inherited from: \cHTMLFormElement::setDisabled()

User Agents usually are showing the element as "greyed-out".

Example: $obj->setDisabled("disabled"); $obj->setDisabled("");

The first example sets the disabled flag, the second one removes the disabled flag.

Parameters
NameTypeDescription
$disabled

string Sets the disabled-flag if non-empty

Returns
TypeDescription
\none
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLFormElement::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLFormElement::setID()
Parameters
NameTypeDescription
$id
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLFormElement::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetTabindex( $tabindex) : \none
inherited

sets the tab index for this element.

Inherited from: \cHTMLFormElement::setTabindex()

The tab index needs to be numeric, bigger than 0 and smaller than 32767.

Parameters
NameTypeDescription
$tabindex

int desired tab index

Returns
TypeDescription
\none
methodpublicsetValue( $value) : \none

Sets the value for the field

Parameters
NameTypeDescription
$value

string Value of the field

Returns
TypeDescription
\none
methodpublictoHTML() : void
inherited

Renders the output If the tag

Inherited from: \cHTML::toHTML()\cHTMLFormElement::toHTML()
methodpublictoHtml() : string

Renders the hidden field

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLIFrame

Package: Default
IFrame element
Parent(s)
\cHTML < \HTML_Common
Children
\NoteView
\cViewItems
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
inherited

Inherited from: \cHTML::addRequiredScript()
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::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.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()
methodpubliccHTMLIFrame() : void

methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetBorder( $border) : void

setBorder: Sets wether this iframe should have a border or not

Parameters
NameTypeDescription
$border

If 1 or true, this frame will have a border

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContentlessTag( $contentlessTag = true) : void
inherited

Inherited from: \cHTML::setContentlessTag()
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetHeight( $height) : void

setHeight: Sets this frame's height

Parameters
NameTypeDescription
$height

Height of the item

methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()
Parameters
NameTypeDescription
$id
methodpublicsetSrc( $src) : void

setSrc: Sets this frame's source

Parameters
NameTypeDescription
$src
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetWidth( $width) : void

setWidth: Sets this frame's width

Parameters
NameTypeDescription
$width

Width of the item

methodpublictoHTML() : string

Renders the table head element

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLImage

Package: Default
Image Element
Parent(s)
\cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
>VPropertypublicint $_height
Image height
Details
Type
int
Access
private  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
>VPropertypublicstring $_src
Image source
Details
Type
string
Access
private  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
>VPropertypublicint $_width
Image width
Details
Type
int
Access
private  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
inherited

Inherited from: \cHTML::addRequiredScript()
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::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.

methodpublicapplyDimensions() : void

applyDimensions: Apply dimensions from the source image

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()
methodpubliccHTMLImage( $src = NULL) : void

Constructor.

Creates an HTML IMG element.

Parameters
NameTypeDescription
$src
methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlignment( $alignment) : void

Parameters
NameTypeDescription
$alignment
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetBorder( $border) : void

setBorder: Sets the border size

Parameters
NameTypeDescription
$border

int Border size

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContentlessTag( $contentlessTag = true) : void
inherited

Inherited from: \cHTML::setContentlessTag()
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetHeight( $height) : void

setHeight: Sets the image's height

Parameters
NameTypeDescription
$height

int Image height

methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()
Parameters
NameTypeDescription
$id
methodpublicsetSrc( $src) : void

setSrc: Sets the image's source file

Parameters
NameTypeDescription
$src

string source location

methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetWidth( $width) : void

setWidth: Sets the image's width

Parameters
NameTypeDescription
$width

int Image width

methodpublictoHTML() : string

Renders the IMG element

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLLabel

Package: Default
HTML Label for form elements
Parent(s)
\cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
>VPropertypublicstring $text
The text to display on the label
Details
Type
string

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
inherited

Inherited from: \cHTML::addRequiredScript()
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::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.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()
methodpubliccHTMLLabel( $text,  $for) : \none

Constructor.

Creates an HTML label which can be linked to any form element (specified by their ID).

A label can be used to link to elements. This is very useful since if a user clicks a label, the linked form element receives the focus (if supported by the user agent).

Parameters
NameTypeDescription
$text

string Name of the element

$for

string ID of the form element to link to.

Returns
TypeDescription
\none
methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContentlessTag( $contentlessTag = true) : void
inherited

Inherited from: \cHTML::setContentlessTag()
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()
Parameters
NameTypeDescription
$id
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublictoHTML() : void
inherited

Renders the output If the tag

Inherited from: \cHTML::toHTML()
methodpublictoHtml() : string

Renders the label

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLLink

Package: Default
HTML Link
Parent(s)
\cHTML < \HTML_Common
Children
\NoteLink
\TODOLink
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
>VPropertypublic$_anchor
Details
Type
n/a
>VPropertypublic$_content
The content itself
Details
Type
n/a
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
>VPropertypublic$_custom
Details
Type
n/a
>VPropertypublic$_link
Details
Type
n/a
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
inherited

Inherited from: \cHTML::addRequiredScript()
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::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.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()
methodpubliccHTMLLink( $href = "") : void

Constructor.

Creates an HTML link.

Parameters
NameTypeDescription
$href

String with the location to link to

methodpublicdisableAutomaticParameterAppend() : void

methodpublicenableAutomaticParameterAppend() : void

methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetHref() : void

methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAnchor( $anchor) : void

setAnchor: Sets an anchor

Only works for the link types Link and cLink.

Parameters
NameTypeDescription
$anchor
methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetCLink( $targetarea,  $targetframe,  $targetaction = "") : void

setLink: Sets a Contenido link (area, frame, action)

Parameters
NameTypeDescription
$targetarea

string Target backend area

$targetframe

string Target frame (1-4)

$targetaction

string Target action

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContent( $content) : void

setContent: Sets the link's content

Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicsetContentlessTag( $contentlessTag = true) : void
inherited

Inherited from: \cHTML::setContentlessTag()
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetCustom( $key,  $value) : void

setCustom: Sets a custom attribute to be appended to the link

Parameters
NameTypeDescription
$key

string Parameter name

$value

string Parameter value

methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()
Parameters
NameTypeDescription
$id
methodpublicsetLink( $href) : void

setLink: Sets the link to a specific location

Parameters
NameTypeDescription
$href

String with the location to link to

methodpublicsetMultiLink( $righttoparea,  $righttopaction,  $rightbottomarea,  $rightbottomaction) : void

setMultiLink: Sets a multilink

Parameters
NameTypeDescription
$righttoparea

string Area (right top)

$righttopaction

string Action (right top)

$rightbottomarea

string Area (right bottom)

$rightbottomaction

string Action (right bottom)

methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetTargetFrame( $target) : void

setTargetFrame: Sets the target frame

Parameters
NameTypeDescription
$target

string Target frame identifier

methodpublictoHTML() : string

Renders the link

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLOptionElement

Package: Default
HTML Select Option Element
Parent(s)
\cHTMLFormElement < \cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions\cHTMLFormElement::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
Inherited_from
\cHTMLFormElement::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
Inherited_from
\cHTMLFormElement::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content\cHTMLFormElement::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
Inherited_from
\cHTMLFormElement::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag\cHTMLFormElement::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cHTMLFormElement::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cHTMLFormElement::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cHTMLFormElement::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close\cHTMLFormElement::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cHTMLFormElement::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open\cHTMLFormElement::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cHTMLFormElement::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single\cHTMLFormElement::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cHTMLFormElement::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs\cHTMLFormElement::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cHTMLFormElement::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag\cHTMLFormElement::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cHTMLFormElement::$$_tag  
>VPropertypublicstring $_title
Title to display
Details
Type
string
Access
private  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()\cHTMLFormElement::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLFormElement::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

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

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

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

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLFormElement::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLFormElement::cHTML()
methodpubliccHTMLFormElement( $name = "",  $id = "",  $disabled = "",  $tabindex = "",  $accesskey = "") : \none
inherited

Constructor.

Inherited from: \cHTMLFormElement::cHTMLFormElement()

This is a generic form element, where specific elements should be inherited from this class.

Parameters
NameTypeDescription
$name

string Name of the element

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpubliccHTMLOptionElement( $title,  $value,  $selected = false,  $disabled = false) : \none

Constructor.

Creates an HTML option element.

Parameters
NameTypeDescription
$title

string Displayed title of the element

$value

string Value of the option

$selected

boolean If true, element is selected

$disabled

boolean If true, element is disabled

Returns
TypeDescription
\none
methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLFormElement::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

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

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLFormElement::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicisSelected() : \none

sets the selected flag

Returns
TypeDescription
\none
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()\cHTMLFormElement::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAccessKey( $accesskey) : \none
inherited

sets the access key for this element.

Inherited from: \cHTMLFormElement::setAccessKey()
Parameters
NameTypeDescription
$accesskey

string The length of the access key. May be A-Z and 0-9.

Returns
TypeDescription
\none
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLFormElement::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLFormElement::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLFormElement::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContentlessTag( $contentlessTag = true) : void
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetDisabled( $disabled) : \none

sets the disabled flag

User Agents usually are showing the element as "greyed-out".

Example: $obj->setDisabled("disabled"); $obj->setDisabled("");

The first example sets the disabled flag, the second one removes the disabled flag.

Parameters
NameTypeDescription
$disabled

boolean If true, adds the "disabled" attribute

Returns
TypeDescription
\none
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLFormElement::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLFormElement::setID()
Parameters
NameTypeDescription
$id
methodpublicsetSelected( $selected) : \none

sets the selected flag

Parameters
NameTypeDescription
$selected

boolean If true, adds the "selected" attribute

Returns
TypeDescription
\none
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLFormElement::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetTabindex( $tabindex) : \none
inherited

sets the tab index for this element.

Inherited from: \cHTMLFormElement::setTabindex()

The tab index needs to be numeric, bigger than 0 and smaller than 32767.

Parameters
NameTypeDescription
$tabindex

int desired tab index

Returns
TypeDescription
\none
methodpublictoHTML() : void
inherited

Renders the output If the tag

Inherited from: \cHTML::toHTML()\cHTMLFormElement::toHTML()
methodpublictoHtml() : string

Renders the option element.

Note: the cHTMLSelectElement renders the options by itself.

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLPasswordbox

Package: Default
HTML Password Box
Parent(s)
\cHTMLFormElement < \cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions\cHTMLFormElement::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
Inherited_from
\cHTMLFormElement::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
Inherited_from
\cHTMLFormElement::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content\cHTMLFormElement::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
Inherited_from
\cHTMLFormElement::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag\cHTMLFormElement::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cHTMLFormElement::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cHTMLFormElement::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cHTMLFormElement::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close\cHTMLFormElement::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cHTMLFormElement::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open\cHTMLFormElement::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cHTMLFormElement::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single\cHTMLFormElement::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cHTMLFormElement::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs\cHTMLFormElement::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cHTMLFormElement::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag\cHTMLFormElement::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cHTMLFormElement::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()\cHTMLFormElement::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLFormElement::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

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

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

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

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLFormElement::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLFormElement::cHTML()
methodpubliccHTMLFormElement( $name = "",  $id = "",  $disabled = "",  $tabindex = "",  $accesskey = "") : \none
inherited

Constructor.

Inherited from: \cHTMLFormElement::cHTMLFormElement()

This is a generic form element, where specific elements should be inherited from this class.

Parameters
NameTypeDescription
$name

string Name of the element

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpubliccHTMLPasswordbox( $name,  $initvalue = "",  $width = "",  $maxlength = "",  $id = "",  $disabled = false,  $tabindex = null,  $accesskey = "") : \none

Constructor.

Creates an HTML password box.

If no additional parameters are specified, the default width is 20 units.

Parameters
NameTypeDescription
$name

string Name of the element

$initvalue

string Initial value of the box

$width

int width of the text box

$maxlength

int maximum input length of the box

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLFormElement::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

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

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLFormElement::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()\cHTMLFormElement::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAccessKey( $accesskey) : \none
inherited

sets the access key for this element.

Inherited from: \cHTMLFormElement::setAccessKey()
Parameters
NameTypeDescription
$accesskey

string The length of the access key. May be A-Z and 0-9.

Returns
TypeDescription
\none
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLFormElement::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLFormElement::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLFormElement::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContentlessTag( $contentlessTag = true) : void
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetDisabled( $disabled) : \none
inherited

Sets the "disabled" attribute of an element.

Inherited from: \cHTMLFormElement::setDisabled()

User Agents usually are showing the element as "greyed-out".

Example: $obj->setDisabled("disabled"); $obj->setDisabled("");

The first example sets the disabled flag, the second one removes the disabled flag.

Parameters
NameTypeDescription
$disabled

string Sets the disabled-flag if non-empty

Returns
TypeDescription
\none
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLFormElement::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLFormElement::setID()
Parameters
NameTypeDescription
$id
methodpublicsetMaxLength( $maxlen) : \none

sets the maximum input length of the text box.

Parameters
NameTypeDescription
$maxlen

int maximum input length

Returns
TypeDescription
\none
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLFormElement::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetTabindex( $tabindex) : \none
inherited

sets the tab index for this element.

Inherited from: \cHTMLFormElement::setTabindex()

The tab index needs to be numeric, bigger than 0 and smaller than 32767.

Parameters
NameTypeDescription
$tabindex

int desired tab index

Returns
TypeDescription
\none
methodpublicsetValue( $value) : \none

sets the initial value of the text box.

Parameters
NameTypeDescription
$value

string Initial value

Returns
TypeDescription
\none
methodpublicsetWidth( $width) : \none

sets the width of the text box.

Parameters
NameTypeDescription
$width

int width of the text box

Returns
TypeDescription
\none
methodpublictoHTML() : void
inherited

Renders the output If the tag

Inherited from: \cHTML::toHTML()\cHTMLFormElement::toHTML()
methodpublictoHtml() : string

Renders the textbox

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLRadiobutton

Package: Default
HTML Radio Button
Parent(s)
\cHTMLFormElement < \cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions\cHTMLFormElement::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
Inherited_from
\cHTMLFormElement::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
Inherited_from
\cHTMLFormElement::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content\cHTMLFormElement::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
Inherited_from
\cHTMLFormElement::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag\cHTMLFormElement::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cHTMLFormElement::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cHTMLFormElement::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cHTMLFormElement::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close\cHTMLFormElement::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cHTMLFormElement::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open\cHTMLFormElement::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cHTMLFormElement::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single\cHTMLFormElement::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cHTMLFormElement::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs\cHTMLFormElement::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cHTMLFormElement::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag\cHTMLFormElement::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cHTMLFormElement::$$_tag  
>VPropertypublicstring $_value
Values for the check box
Details
Type
string
Access
private  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()\cHTMLFormElement::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLFormElement::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

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

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

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

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLFormElement::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLFormElement::cHTML()
methodpubliccHTMLFormElement( $name = "",  $id = "",  $disabled = "",  $tabindex = "",  $accesskey = "") : \none
inherited

Constructor.

Inherited from: \cHTMLFormElement::cHTMLFormElement()

This is a generic form element, where specific elements should be inherited from this class.

Parameters
NameTypeDescription
$name

string Name of the element

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpubliccHTMLRadiobutton( $name,  $value,  $id = "",  $checked = false,  $disabled = false,  $tabindex = null,  $accesskey = "") : \none

Constructor.

Creates an HTML radio button element.

Parameters
NameTypeDescription
$name

string Name of the element

$value

string Value of the radio button

$id

string ID of the element

$checked

boolean Is element checked?

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLFormElement::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

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

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLFormElement::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()\cHTMLFormElement::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAccessKey( $accesskey) : \none
inherited

sets the access key for this element.

Inherited from: \cHTMLFormElement::setAccessKey()
Parameters
NameTypeDescription
$accesskey

string The length of the access key. May be A-Z and 0-9.

Returns
TypeDescription
\none
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLFormElement::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLFormElement::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetChecked( $checked) : \none

Sets the checked flag.

Parameters
NameTypeDescription
$checked

boolean If true, the "checked" attribute will be assigned.

Returns
TypeDescription
\none
methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLFormElement::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContentlessTag( $contentlessTag = true) : void
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetDisabled( $disabled) : \none
inherited

Sets the "disabled" attribute of an element.

Inherited from: \cHTMLFormElement::setDisabled()

User Agents usually are showing the element as "greyed-out".

Example: $obj->setDisabled("disabled"); $obj->setDisabled("");

The first example sets the disabled flag, the second one removes the disabled flag.

Parameters
NameTypeDescription
$disabled

string Sets the disabled-flag if non-empty

Returns
TypeDescription
\none
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLFormElement::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLFormElement::setID()
Parameters
NameTypeDescription
$id
methodpublicsetLabelText( $text) : \none

Sets a custom label text

Parameters
NameTypeDescription
$text

string Text to display

Returns
TypeDescription
\none
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLFormElement::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetTabindex( $tabindex) : \none
inherited

sets the tab index for this element.

Inherited from: \cHTMLFormElement::setTabindex()

The tab index needs to be numeric, bigger than 0 and smaller than 32767.

Parameters
NameTypeDescription
$tabindex

int desired tab index

Returns
TypeDescription
\none
methodpublictoHTML() : void
inherited

Renders the output If the tag

Inherited from: \cHTML::toHTML()\cHTMLFormElement::toHTML()
methodpublictoHtml( $renderLabel = true) : string

Renders the option element.

Note:

If this element has an ID, the value (which equals the text displayed) will be rendered as seperate HTML label, if not, it will be displayed as regular text. Displaying the value can be turned off via the parameter.

Parameters
NameTypeDescription
$renderLabel
Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLScript

Package: Default
Table Head Element
Parent(s)
\cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
inherited

Inherited from: \cHTML::addRequiredScript()
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::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.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()
methodpubliccHTMLScript() : void

methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContent( $content) : void

setContent: Sets the table head's content

Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicsetContentlessTag( $contentlessTag = true) : void
inherited

Inherited from: \cHTML::setContentlessTag()
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()
Parameters
NameTypeDescription
$id
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublictoHTML() : string

Renders the table head element

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLSelectElement

Package: Default
HTML Select Element
Parent(s)
\cHTMLFormElement < \cHTML < \HTML_Common
Children
\cHTMLInputSelectElement
\cDataDropdownWidget
\cDataForeignTableDropdownWidget
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions\cHTMLFormElement::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
Inherited_from
\cHTMLFormElement::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
Inherited_from
\cHTMLFormElement::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content\cHTMLFormElement::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
Inherited_from
\cHTMLFormElement::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag\cHTMLFormElement::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cHTMLFormElement::$$_contentlessTag  
>VPropertypublicarray $_options
All cHTMLOptionElements
Details
Type
array
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cHTMLFormElement::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cHTMLFormElement::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close\cHTMLFormElement::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cHTMLFormElement::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open\cHTMLFormElement::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cHTMLFormElement::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single\cHTMLFormElement::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cHTMLFormElement::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs\cHTMLFormElement::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cHTMLFormElement::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag\cHTMLFormElement::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cHTMLFormElement::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()\cHTMLFormElement::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLFormElement::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddOptionElement( $index,  $element) : \none

Adds an cHTMLOptionElement to the number of choices.

Parameters
NameTypeDescription
$index

string Index of the element

$element

object Filled cHTMLOptionElement to add

Returns
TypeDescription
\none
methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

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

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

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

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLFormElement::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicautoFill( $stuff) : \none

Automatically creates and fills cHTMLOptionElements

Array format: $stuff = array( array("value","title"), array("value","title"));

or regular key => value arrays.

Parameters
NameTypeDescription
$stuff

array Array with all items

Returns
TypeDescription
\none
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLFormElement::cHTML()
methodpubliccHTMLFormElement( $name = "",  $id = "",  $disabled = "",  $tabindex = "",  $accesskey = "") : \none
inherited

Constructor.

Inherited from: \cHTMLFormElement::cHTMLFormElement()

This is a generic form element, where specific elements should be inherited from this class.

Parameters
NameTypeDescription
$name

string Name of the element

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpubliccHTMLSelectElement( $name,  $width = "",  $id = "",  $disabled = false,  $tabindex = null,  $accesskey = "") : \none

Constructor.

Creates an HTML select field (aka "DropDown").

Parameters
NameTypeDescription
$name

string Name of the element

$width

int width of the select element

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLFormElement::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

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

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetDefault() : \Selected

Search for the selected elements

Returns
TypeDescription
\Selected"lvalue"
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLFormElement::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()\cHTMLFormElement::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAccessKey( $accesskey) : \none
inherited

sets the access key for this element.

Inherited from: \cHTMLFormElement::setAccessKey()
Parameters
NameTypeDescription
$accesskey

string The length of the access key. May be A-Z and 0-9.

Returns
TypeDescription
\none
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLFormElement::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLFormElement::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLFormElement::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContentlessTag( $contentlessTag = true) : void
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetDefault( $lvalue) : \none

Sets a specific cHTMLOptionElement to the selected state.

Parameters
NameTypeDescription
$lvalue

string Specifies the "value" of the cHTMLOptionElement to set

Returns
TypeDescription
\none
methodpublicsetDisabled( $disabled) : \none
inherited

Sets the "disabled" attribute of an element.

Inherited from: \cHTMLFormElement::setDisabled()

User Agents usually are showing the element as "greyed-out".

Example: $obj->setDisabled("disabled"); $obj->setDisabled("");

The first example sets the disabled flag, the second one removes the disabled flag.

Parameters
NameTypeDescription
$disabled

string Sets the disabled-flag if non-empty

Returns
TypeDescription
\none
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLFormElement::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLFormElement::setID()
Parameters
NameTypeDescription
$id
methodpublicsetMultiselect() : void

methodpublicsetSelected(array $aElements) : \none

Sets specified elements as selected (and all others as unselected)

Parameters
NameTypeDescription
$aElementsarray

Array with "values" of the cHTMLOptionElement to set

Returns
TypeDescription
\none
methodpublicsetSize( $size) : void

Parameters
NameTypeDescription
$size
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLFormElement::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetTabindex( $tabindex) : \none
inherited

sets the tab index for this element.

Inherited from: \cHTMLFormElement::setTabindex()

The tab index needs to be numeric, bigger than 0 and smaller than 32767.

Parameters
NameTypeDescription
$tabindex

int desired tab index

Returns
TypeDescription
\none
methodpublictoHTML() : void
inherited

Renders the output If the tag

Inherited from: \cHTML::toHTML()\cHTMLFormElement::toHTML()
methodpublictoHtml() : string

Renders the select box

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLSpan

Package: Default
SPAN Element
Parent(s)
\cHTML < \HTML_Common
Children
\cWidgetButton
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
inherited

Inherited from: \cHTML::addRequiredScript()
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::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.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()
methodpubliccHTMLSpan( $content = "") : void

Constructor.

Creates an HTML DIV element.

Parameters
NameTypeDescription
$content

mixed String or object with the contents

methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContent( $content) : void

setContent: Sets the div's content

Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicsetContentlessTag( $contentlessTag = true) : void
inherited

Inherited from: \cHTML::setContentlessTag()
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()
Parameters
NameTypeDescription
$id
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublictoHTML() : string

Renders the SPAN element

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLTable

Package: Default
Table Element
Parent(s)
\cHTML < \HTML_Common
Children
\cHTMLAlignmentTable
\cCalendarControl
\cDataMultiTextboxWidget
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
inherited

Inherited from: \cHTML::addRequiredScript()
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::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.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()
methodpubliccHTMLTable() : void

methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetBorder(\border $border) : void

setBorder: Sets the table's border

Parameters
NameTypeDescription
$border\border

Border size

methodpublicsetCellPadding( $cellpadding) : void

setCellPadding: Sets the padding between cells

Parameters
NameTypeDescription
$cellpadding

Padding

methodpublicsetCellSpacing( $cellspacing) : void

setCellSpacing: Sets the spacing between cells

Parameters
NameTypeDescription
$cellspacing

Spacing

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContent( $content) : void

setContent: Sets the table's content

Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicsetContentlessTag( $contentlessTag = true) : void
inherited

Inherited from: \cHTML::setContentlessTag()
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()
Parameters
NameTypeDescription
$id
methodpublicsetPadding( $cellpadding) : void

Parameters
NameTypeDescription
$cellpadding
methodpublicsetSpacing( $cellspacing) : void

Parameters
NameTypeDescription
$cellspacing
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetWidth( $width) : void

setWidth: Sets the table width

Parameters
NameTypeDescription
$width

Width

methodpublictoHTML() : string

Renders the Table element

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLTableBody

Package: Default
Table Body Element
Parent(s)
\cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
inherited

Inherited from: \cHTML::addRequiredScript()
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::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.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()
methodpubliccHTMLTableBody() : void

methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContent( $content) : void

setContent: Sets the table body's content

Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicsetContentlessTag( $contentlessTag = true) : void
inherited

Inherited from: \cHTML::setContentlessTag()
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()
Parameters
NameTypeDescription
$id
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublictoHTML() : string

Renders the table body element

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLTableData

Package: Default
Table Data Element
Parent(s)
\cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
inherited

Inherited from: \cHTML::addRequiredScript()
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::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.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()
methodpubliccHTMLTableData() : void

methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlignment( $alignment) : void

Parameters
NameTypeDescription
$alignment
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetBackgroundColor( $color) : void

Parameters
NameTypeDescription
$color
methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetColspan( $colspan) : void

Parameters
NameTypeDescription
$colspan
methodpublicsetContent( $content) : void

setContent: Sets the table data's content

Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicsetContentlessTag( $contentlessTag = true) : void
inherited

Inherited from: \cHTML::setContentlessTag()
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetHeight( $height) : void

Parameters
NameTypeDescription
$height
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()
Parameters
NameTypeDescription
$id
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetVerticalAlignment( $alignment) : void

Parameters
NameTypeDescription
$alignment
methodpublicsetWidth( $width) : void

setWidth: Sets the table width

Parameters
NameTypeDescription
$width

Width

methodpublictoHTML() : string

Renders the table data element

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLTableHead

Package: Default
Table Head Element
Parent(s)
\cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
inherited

Inherited from: \cHTML::addRequiredScript()
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::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.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()
methodpubliccHTMLTableHead() : void

methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContent( $content) : void

setContent: Sets the table head's content

Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicsetContentlessTag( $contentlessTag = true) : void
inherited

Inherited from: \cHTML::setContentlessTag()
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()
Parameters
NameTypeDescription
$id
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublictoHTML() : string

Renders the table head element

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLTableHeader

Package: Default
Table Head Element
Parent(s)
\cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
inherited

Inherited from: \cHTML::addRequiredScript()
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::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.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()
methodpubliccHTMLTableHeader() : void

methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContent( $content) : void

setContent: Sets the table head's content

Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicsetContentlessTag( $contentlessTag = true) : void
inherited

Inherited from: \cHTML::setContentlessTag()
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()
Parameters
NameTypeDescription
$id
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublictoHTML() : string

Renders the table head element

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLTableRow

Package: Default
Table Row Element
Parent(s)
\cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
inherited

Inherited from: \cHTML::addRequiredScript()
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::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.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()
methodpubliccHTMLTableRow() : void

methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContent( $content) : void

setContent: Sets the table row's content

Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicsetContentlessTag( $contentlessTag = true) : void
inherited

Inherited from: \cHTML::setContentlessTag()
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()
Parameters
NameTypeDescription
$id
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublictoHTML() : string

Renders the table row element

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLTextarea

Package: Default
HTML Form element class
Parent(s)
\cHTMLFormElement < \cHTML < \HTML_Common
Children
\cDataTextareaWidget
\cDataCodeTextareaWidget
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions\cHTMLFormElement::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
Inherited_from
\cHTMLFormElement::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
Inherited_from
\cHTMLFormElement::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content\cHTMLFormElement::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
Inherited_from
\cHTMLFormElement::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag\cHTMLFormElement::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cHTMLFormElement::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cHTMLFormElement::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cHTMLFormElement::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close\cHTMLFormElement::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cHTMLFormElement::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open\cHTMLFormElement::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cHTMLFormElement::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single\cHTMLFormElement::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cHTMLFormElement::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs\cHTMLFormElement::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cHTMLFormElement::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag\cHTMLFormElement::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cHTMLFormElement::$$_tag  
>VPropertypublic$_value
Details
Type
n/a

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()\cHTMLFormElement::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLFormElement::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

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

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

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

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLFormElement::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLFormElement::cHTML()
methodpubliccHTMLFormElement( $name = "",  $id = "",  $disabled = "",  $tabindex = "",  $accesskey = "") : \none
inherited

Constructor.

Inherited from: \cHTMLFormElement::cHTMLFormElement()

This is a generic form element, where specific elements should be inherited from this class.

Parameters
NameTypeDescription
$name

string Name of the element

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpubliccHTMLTextarea( $name,  $initvalue = "",  $width = "",  $height = "",  $id = "",  $disabled = false,  $tabindex = null,  $accesskey = "") : \none

Constructor.

Creates an HTML text area.

If no additional parameters are specified, the default width is 60 chars, and the height is 5 chars.

Parameters
NameTypeDescription
$name

string Name of the element

$initvalue

string Initial value of the textarea

$width

int width of the textarea

$height

int height of the textarea

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLFormElement::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

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

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLFormElement::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()\cHTMLFormElement::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAccessKey( $accesskey) : \none
inherited

sets the access key for this element.

Inherited from: \cHTMLFormElement::setAccessKey()
Parameters
NameTypeDescription
$accesskey

string The length of the access key. May be A-Z and 0-9.

Returns
TypeDescription
\none
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLFormElement::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLFormElement::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLFormElement::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContentlessTag( $contentlessTag = true) : void
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetDisabled( $disabled) : \none
inherited

Sets the "disabled" attribute of an element.

Inherited from: \cHTMLFormElement::setDisabled()

User Agents usually are showing the element as "greyed-out".

Example: $obj->setDisabled("disabled"); $obj->setDisabled("");

The first example sets the disabled flag, the second one removes the disabled flag.

Parameters
NameTypeDescription
$disabled

string Sets the disabled-flag if non-empty

Returns
TypeDescription
\none
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLFormElement::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetHeight( $height) : \none

sets the maximum input length of the text box.

Parameters
NameTypeDescription
$height
Returns
TypeDescription
\none
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLFormElement::setID()
Parameters
NameTypeDescription
$id
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLFormElement::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetTabindex( $tabindex) : \none
inherited

sets the tab index for this element.

Inherited from: \cHTMLFormElement::setTabindex()

The tab index needs to be numeric, bigger than 0 and smaller than 32767.

Parameters
NameTypeDescription
$tabindex

int desired tab index

Returns
TypeDescription
\none
methodpublicsetValue( $value) : \none

sets the initial value of the text box.

Parameters
NameTypeDescription
$value

string Initial value

Returns
TypeDescription
\none
methodpublicsetWidth( $width) : \none

sets the width of the text box.

Parameters
NameTypeDescription
$width

int width of the text box

Returns
TypeDescription
\none
methodpublictoHTML() : void
inherited

Renders the output If the tag

Inherited from: \cHTML::toHTML()\cHTMLFormElement::toHTML()
methodpublictoHtml() : string

Renders the textbox

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLTextbox

Package: Default
HTML Textbox
Parent(s)
\cHTMLFormElement < \cHTML < \HTML_Common
Children
\cDataTextWidget
\cDatefield
\cNominalNumberField
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions\cHTMLFormElement::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
Inherited_from
\cHTMLFormElement::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
Inherited_from
\cHTMLFormElement::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content\cHTMLFormElement::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
Inherited_from
\cHTMLFormElement::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag\cHTMLFormElement::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cHTMLFormElement::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cHTMLFormElement::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cHTMLFormElement::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close\cHTMLFormElement::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cHTMLFormElement::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open\cHTMLFormElement::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cHTMLFormElement::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single\cHTMLFormElement::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cHTMLFormElement::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs\cHTMLFormElement::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cHTMLFormElement::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag\cHTMLFormElement::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cHTMLFormElement::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()\cHTMLFormElement::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLFormElement::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

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

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

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

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLFormElement::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLFormElement::cHTML()
methodpubliccHTMLFormElement( $name = "",  $id = "",  $disabled = "",  $tabindex = "",  $accesskey = "") : \none
inherited

Constructor.

Inherited from: \cHTMLFormElement::cHTMLFormElement()

This is a generic form element, where specific elements should be inherited from this class.

Parameters
NameTypeDescription
$name

string Name of the element

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpubliccHTMLTextbox( $name,  $initvalue = "",  $width = "",  $maxlength = "",  $id = "",  $disabled = false,  $tabindex = null,  $accesskey = "") : \none

Constructor.

Creates an HTML text box.

If no additional parameters are specified, the default width is 20 units.

Parameters
NameTypeDescription
$name

string Name of the element

$initvalue

string Initial value of the box

$width

int width of the text box

$maxlength

int maximum input length of the box

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLFormElement::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

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

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLFormElement::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()\cHTMLFormElement::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAccessKey( $accesskey) : \none
inherited

sets the access key for this element.

Inherited from: \cHTMLFormElement::setAccessKey()
Parameters
NameTypeDescription
$accesskey

string The length of the access key. May be A-Z and 0-9.

Returns
TypeDescription
\none
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLFormElement::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLFormElement::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLFormElement::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContentlessTag( $contentlessTag = true) : void
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetDisabled( $disabled) : \none
inherited

Sets the "disabled" attribute of an element.

Inherited from: \cHTMLFormElement::setDisabled()

User Agents usually are showing the element as "greyed-out".

Example: $obj->setDisabled("disabled"); $obj->setDisabled("");

The first example sets the disabled flag, the second one removes the disabled flag.

Parameters
NameTypeDescription
$disabled

string Sets the disabled-flag if non-empty

Returns
TypeDescription
\none
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLFormElement::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLFormElement::setID()
Parameters
NameTypeDescription
$id
methodpublicsetMaxLength( $maxlen) : \none

sets the maximum input length of the text box.

Parameters
NameTypeDescription
$maxlen

int maximum input length

Returns
TypeDescription
\none
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLFormElement::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetTabindex( $tabindex) : \none
inherited

sets the tab index for this element.

Inherited from: \cHTMLFormElement::setTabindex()

The tab index needs to be numeric, bigger than 0 and smaller than 32767.

Parameters
NameTypeDescription
$tabindex

int desired tab index

Returns
TypeDescription
\none
methodpublicsetValue( $value) : \none

sets the initial value of the text box.

Parameters
NameTypeDescription
$value

string Initial value

Returns
TypeDescription
\none
methodpublicsetWidth( $width) : \none

sets the width of the text box.

Parameters
NameTypeDescription
$width

int width of the text box

Returns
TypeDescription
\none
methodpublictoHTML() : void
inherited

Renders the output If the tag

Inherited from: \cHTML::toHTML()\cHTMLFormElement::toHTML()
methodpublictoHtml() : string

Renders the textbox

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

\cHTMLUpload

Package: Default
HTML File upload box
Parent(s)
\cHTMLFormElement < \cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions\cHTMLFormElement::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
Inherited_from
\cHTMLFormElement::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
Inherited_from
\cHTMLFormElement::$$_aStyleDefinitions  
>VPropertypublic$_content
inherited
The content itself
Inherited from: \cHTML::$$_content\cHTMLFormElement::$$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
Inherited_from
\cHTMLFormElement::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag\cHTMLFormElement::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cHTMLFormElement::$$_contentlessTag  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cHTMLFormElement::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cHTMLFormElement::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close\cHTMLFormElement::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cHTMLFormElement::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open\cHTMLFormElement::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cHTMLFormElement::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single\cHTMLFormElement::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cHTMLFormElement::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs\cHTMLFormElement::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cHTMLFormElement::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag\cHTMLFormElement::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cHTMLFormElement::$$_tag  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()\cHTMLFormElement::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLFormElement::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

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

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

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

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

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string
inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cHTMLFormElement::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
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLFormElement::cHTML()
methodpubliccHTMLFormElement( $name = "",  $id = "",  $disabled = "",  $tabindex = "",  $accesskey = "") : \none
inherited

Constructor.

Inherited from: \cHTMLFormElement::cHTMLFormElement()

This is a generic form element, where specific elements should be inherited from this class.

Parameters
NameTypeDescription
$name

string Name of the element

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpubliccHTMLUpload( $name,  $width = "",  $maxlength = "",  $id = "",  $disabled = false,  $tabindex = null,  $accesskey = "") : \none

Constructor.

Creates an HTML upload box.

If no additional parameters are specified, the default width is 20 units.

Parameters
NameTypeDescription
$name

string Name of the element

$width

int width of the text box

$maxlength

int maximum input length of the box

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cHTMLFormElement::fillCloseSkeleton()
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

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

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

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLFormElement::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()\cHTMLFormElement::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAccessKey( $accesskey) : \none
inherited

sets the access key for this element.

Inherited from: \cHTMLFormElement::setAccessKey()
Parameters
NameTypeDescription
$accesskey

string The length of the access key. May be A-Z and 0-9.

Returns
TypeDescription
\none
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLFormElement::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
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLFormElement::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cHTMLFormElement::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContentlessTag( $contentlessTag = true) : void
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetDisabled( $disabled) : \none
inherited

Sets the "disabled" attribute of an element.

Inherited from: \cHTMLFormElement::setDisabled()

User Agents usually are showing the element as "greyed-out".

Example: $obj->setDisabled("disabled"); $obj->setDisabled("");

The first example sets the disabled flag, the second one removes the disabled flag.

Parameters
NameTypeDescription
$disabled

string Sets the disabled-flag if non-empty

Returns
TypeDescription
\none
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLFormElement::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
inherited

sets the ID class

Inherited from: \cHTML::setID()\cHTMLFormElement::setID()
Parameters
NameTypeDescription
$id
methodpublicsetMaxLength( $maxlen) : \none

sets the maximum input length of the text box.

Parameters
NameTypeDescription
$maxlen

int maximum input length

Returns
TypeDescription
\none
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cHTMLFormElement::setStyle()
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetTabindex( $tabindex) : \none
inherited

sets the tab index for this element.

Inherited from: \cHTMLFormElement::setTabindex()

The tab index needs to be numeric, bigger than 0 and smaller than 32767.

Parameters
NameTypeDescription
$tabindex

int desired tab index

Returns
TypeDescription
\none
methodpublicsetWidth( $width) : \none

sets the width of the text box.

Parameters
NameTypeDescription
$width

int width of the text box

Returns
TypeDescription
\none
methodpublictoHTML() : void
inherited

Renders the output If the tag

Inherited from: \cHTML::toHTML()\cHTMLFormElement::toHTML()
methodpublictoHtml() : string

Renders the textbox

Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void
inherited

removes an event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

Documentation was generated by phpDocumentor 2.0.0a12.