contenido\classes\widgets\class.widgets.page.php

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

Description: Page widgets

Requirements:

Author
Bjoern Behrens  
Con_php_req
5.0  
Copyright
four for business AG  
License
http://www.contenido.org/license/LIZENZ.txt  
Link
http://www.4fb.de  
Link
{@internal created 2007-01-30 $Id: class.widgets.page.php,v 1.24 2007/01/30 20:00:29 bjoern.behrens Exp $ }}  
Package
Contenido Backend classes  
Version
1.24  

\cNewPageLeftTopMultiPane

Package: Default
Predefined page for use in frame 1 with a multipane
Parent(s)
\cPageLeftTopMultiPane < \cPageLeftTop < \cPage < \cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublicstring $_content
inherited
Storage of the page's content
Inherited from: \cPage::$$_content\cPageLeftTop::$$_content\cPageLeftTopMultiPane::$$_content
Details
Type
string
Access
private  
Inherited_from
\cPage::$$_content  
Inherited_from
\cPageLeftTop::$$_content  
Inherited_from
\cPageLeftTopMultiPane::$$_content  
>VPropertypublicboolean $_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cPage::$$_contentlessTag  
Inherited_from
\cPageLeftTop::$$_contentlessTag  
Inherited_from
\cPageLeftTopMultiPane::$$_contentlessTag  
>VPropertypublicstring $_encoding
inherited
Storage of the desired encoding
Inherited from: \cPage::$$_encoding\cPageLeftTop::$$_encoding\cPageLeftTopMultiPane::$$_encoding
Details
Type
string
Access
private  
Inherited_from
\cPage::$$_encoding  
Inherited_from
\cPageLeftTop::$$_encoding  
Inherited_from
\cPageLeftTopMultiPane::$$_encoding  
>VPropertypublicarray $_items
inherited
Storage of the items
Inherited from: \cPageLeftTopMultiPane::$$_items
Details
Type
array
Access
private  
Inherited_from
\cPageLeftTopMultiPane::$$_items  
>VPropertypublicint $_margin
Details
Type
int
Access
private  
Inherited_from
\cPage::$$_margin  
Inherited_from
\cPageLeftTop::$$_margin  
Inherited_from
\cPageLeftTopMultiPane::$$_margin  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cPage::$$_requiredScripts\cPageLeftTop::$$_requiredScripts\cPageLeftTopMultiPane::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cPage::$$_requiredScripts  
Inherited_from
\cPageLeftTop::$$_requiredScripts  
Inherited_from
\cPageLeftTopMultiPane::$$_requiredScripts  
>VPropertypublicarray $_scripts
inherited
Storage of scripts to be used on the page
Inherited from: \cPage::$$_scripts\cPageLeftTop::$$_scripts\cPageLeftTopMultiPane::$$_scripts
Details
Type
array
Access
private  
Inherited_from
\cPage::$$_scripts  
Inherited_from
\cPageLeftTop::$$_scripts  
Inherited_from
\cPageLeftTopMultiPane::$$_scripts  
>VPropertypublicstring $_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cPage::$$_skeleton_close  
Inherited_from
\cPageLeftTop::$$_skeleton_close  
Inherited_from
\cPageLeftTopMultiPane::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cPage::$$_skeleton_open  
Inherited_from
\cPageLeftTop::$$_skeleton_open  
Inherited_from
\cPageLeftTopMultiPane::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cPage::$$_skeleton_single  
Inherited_from
\cPageLeftTop::$$_skeleton_single  
Inherited_from
\cPageLeftTopMultiPane::$$_skeleton_single  
>VPropertypublicstring $_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cPage::$$_styledefs  
Inherited_from
\cPageLeftTop::$$_styledefs  
Inherited_from
\cPageLeftTopMultiPane::$$_styledefs  
>VPropertypublicstring $_subnav
inherited
Storage of the sub navigation
Inherited from: \cPage::$$_subnav\cPageLeftTop::$$_subnav\cPageLeftTopMultiPane::$$_subnav
Details
Type
string
Access
private  
Inherited_from
\cPage::$$_subnav  
Inherited_from
\cPageLeftTop::$$_subnav  
Inherited_from
\cPageLeftTopMultiPane::$$_subnav  
>VPropertypublicstring $_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cPage::$$_tag  
Inherited_from
\cPageLeftTop::$$_tag  
Inherited_from
\cPageLeftTopMultiPane::$$_tag  
>VPropertypublicstring $extra
inherited
Storage of the extra data (see template)
Inherited from: \cPage::$$extra\cPageLeftTop::$$extra\cPageLeftTopMultiPane::$$extra
Details
Type
string
Access
private  
Inherited_from
\cPage::$$extra  
Inherited_from
\cPageLeftTop::$$extra  
Inherited_from
\cPageLeftTopMultiPane::$$extra  

Methods

methodpublic__toString() : string
inherited

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

Inherited from: \cHTML::__toString()\cPage::__toString()\cPageLeftTop::__toString()\cPageLeftTopMultiPane::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
Parameters
NameTypeDescription
$content

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

methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicaddScript( $name,  $script) : void
inherited

sets a specific JavaScript for the header Important: The passed script needs to define tags.

Inherited from: \cPage::addScript()\cPageLeftTop::addScript()\cPageLeftTopMultiPane::addScript()
Parameters
NameTypeDescription
$name

string Script identifier

$script

string Script code

methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::advanceID()\cPage::advanceID()\cPageLeftTop::advanceID()\cPageLeftTopMultiPane::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

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

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()\cPage::cHTML()\cPageLeftTop::cHTML()\cPageLeftTopMultiPane::cHTML()
methodpubliccNewPageLeftTopMultiPane( $items) : void

Parameters
NameTypeDescription
$items
methodpubliccPage(\none $object = false) : void
Parameters
NameTypeDescription
$object\none
methodpubliccPageLeftTop( $showCloser = true) : void
inherited

Constructor Function

Inherited from: \cPageLeftTop::cPageLeftTop()\cPageLeftTopMultiPane::cPageLeftTop()
Parameters
NameTypeDescription
$showCloser

boolean True if the closer should be shown (default)

methodpubliccPageLeftTopMultiPane( $items) : void
inherited

Constructor Function

Inherited from: \cPageLeftTopMultiPane::cPageLeftTopMultiPane()

The passed array needs to be a multi-array in the following format:

$items = array( array( "image", "description", "link"), array( "image", "description", "link") );

Each sub-array needs to define an image, a description and a link. Note that the images are relative to the current directory, so you should include $cfg["path"]["images"] to retrieve the correct path.

Parameters
NameTypeDescription
$items

array All items passed as multi array (see constructor description)

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

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
Returns
TypeDescription
stringcurrent ID
methodpublicrender(\none $print = true) : string

render

Parameters
NameTypeDescription
$print\none
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cPage::setAlt()\cPageLeftTop::setAlt()\cPageLeftTopMultiPane::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
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContent( $content) : void
Parameters
NameTypeDescription
$content

mixed Object with a render method or a string containing the content

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

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()\cPage::setEvent()\cPageLeftTop::setEvent()\cPageLeftTopMultiPane::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)

methodpublicsetExtra( $extra) : void
Parameters
NameTypeDescription
$extra
methodpublicsetGenerateXHTML(bool $value) : void
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
Parameters
NameTypeDescription
$id
methodpublicsetMargin( $margin) : void
inherited

set the margin width (pixels)

Inherited from: \cPage::setMargin()\cPageLeftTop::setMargin()\cPageLeftTopMultiPane::setMargin()
Parameters
NameTypeDescription
$margin

int Margin width

methodpublicsetMarkScript( $item) : void
Parameters
NameTypeDescription
$item
methodpublicsetMessageBox() : void
inherited

adds the default script for a messagebox

Inherited from: \cPage::setMessageBox()\cPageLeftTop::setMessageBox()\cPageLeftTopMultiPane::setMessageBox()
methodpublicsetReload(\none $location = false) : void
inherited

adds the default script to reload the left pane (frame 2)

Inherited from: \cPage::setReload()\cPageLeftTop::setReload()\cPageLeftTopMultiPane::setReload()
Parameters
NameTypeDescription
$location\none
methodpublicsetStyle( $style) : void
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
methodpublicsetSubnav( $append,  $marea = false) : void
inherited

sets the link to the subnavigation.

Inherited from: \cPage::setSubnav()\cPageLeftTop::setSubnav()\cPageLeftTopMultiPane::setSubnav()

Should be set on the first page only.

Parameters
NameTypeDescription
$append

URL to append

$marea
methodpublicshowCloser( $show) : void
inherited

set wether the closer should be shown.

Inherited from: \cPageLeftTopMultiPane::showCloser()
Parameters
NameTypeDescription
$show

boolean True if the closer should be shown (default)

methodpublictoHTML() : void
methodpublicunsetEvent( $event) : void

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

Parameters
NameTypeDescription
$event

string Type of the event

\cPage

Package: Default
Regular page
Parent(s)
\cHTML < \HTML_Common
Children
\cPageLeftTop
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  
>VPropertypublicstring $_content
Storage of the page's content
Details
Type
string
Access
private  
>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  
>VPropertypublicstring $_encoding
Storage of the desired encoding
Details
Type
string
Access
private  
>VPropertypublicint $_margin
Storage of the margin
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  
>VPropertypublicarray $_scripts
Storage of scripts to be used on the page
Details
Type
array
Access
private  
>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 $_subnav
Storage of the sub navigation
Details
Type
string
Access
private  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
>VPropertypublicstring $extra
Storage of the extra data (see template)
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()
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
methodpublicaddScript( $name,  $script) : void

sets a specific JavaScript for the header Important: The passed script needs to define tags.

Parameters
NameTypeDescription
$name

string Script identifier

$script

string Script code

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()
methodpubliccPage(\none $object = false) : void

Constructor Function

Parameters
NameTypeDescription
$object\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(\none $print = true) : string

render the page

Parameters
NameTypeDescription
$print\none
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

Sets the content for the page

Parameters
NameTypeDescription
$content

mixed Object with a render method or a string containing the content

methodpublicsetContentlessTag( $contentlessTag = true) : void
inherited

Inherited from: \cHTML::setContentlessTag()
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEncoding( $encoding) : void

Parameters
NameTypeDescription
$encoding
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)

methodpublicsetExtra( $extra) : void

Parameters
NameTypeDescription
$extra
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
methodpublicsetMargin( $margin) : void

set the margin width (pixels)

Parameters
NameTypeDescription
$margin

int Margin width

methodpublicsetMarkScript( $item) : void

Parameters
NameTypeDescription
$item
methodpublicsetMessageBox() : void

adds the default script for a messagebox

methodpublicsetReload(\none $location = false) : void

adds the default script to reload the left pane (frame 2)

Parameters
NameTypeDescription
$location\none
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
methodpublicsetSubnav( $append,  $marea = false) : void

sets the link to the subnavigation.

Should be set on the first page only.

Parameters
NameTypeDescription
$append

URL to append

$marea
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

\cPageLeftTop

Package: Default
Predefined page for use in frame 1
Parent(s)
\cPage < \cHTML < \HTML_Common
Children
\cPageLeftTopMultiPane
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions\cPage::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
Inherited_from
\cPage::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
inherited
Style definitions
Inherited from: \cHTML::$$_aStyleDefinitions\cPage::$$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
Inherited_from
\cPage::$$_aStyleDefinitions  
>VPropertypublicstring $_content
inherited
Storage of the page's content
Inherited from: \cPage::$$_content
Details
Type
string
Access
private  
Inherited_from
\cPage::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag\cPage::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cPage::$$_contentlessTag  
>VPropertypublicstring $_encoding
inherited
Storage of the desired encoding
Inherited from: \cPage::$$_encoding
Details
Type
string
Access
private  
Inherited_from
\cPage::$$_encoding  
>VPropertypublicint $_margin
inherited
Storage of the margin
Inherited from: \cPage::$$_margin
Details
Type
int
Access
private  
Inherited_from
\cPage::$$_margin  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cPage::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cPage::$$_requiredScripts  
>VPropertypublicarray $_scripts
inherited
Storage of scripts to be used on the page
Inherited from: \cPage::$$_scripts
Details
Type
array
Access
private  
Inherited_from
\cPage::$$_scripts  
>VPropertypublicstring $_skeleton_close
inherited
Storage of the close SGML tag
Inherited from: \cHTML::$$_skeleton_close\cPage::$$_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cPage::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open\cPage::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cPage::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single\cPage::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cPage::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs\cPage::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cPage::$$_styledefs  
>VPropertypublicstring $_subnav
inherited
Storage of the sub navigation
Inherited from: \cPage::$$_subnav
Details
Type
string
Access
private  
Inherited_from
\cPage::$$_subnav  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag\cPage::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cPage::$$_tag  
>VPropertypublicstring $extra
inherited
Storage of the extra data (see template)
Inherited from: \cPage::$$extra
Details
Type
string
Access
private  
Inherited_from
\cPage::$$extra  

Methods

methodpublic__toString() : string
inherited

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

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

_setContent: Sets the content of the object

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

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

methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicaddScript( $name,  $script) : void
inherited

sets a specific JavaScript for the header Important: The passed script needs to define tags.

Inherited from: \cPage::addScript()
Parameters
NameTypeDescription
$name

string Script identifier

$script

string Script code

methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::advanceID()\cPage::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()\cPage::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()\cPage::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()\cPage::cHTML()
methodpubliccPage(\none $object = false) : void
inherited

Constructor Function

Inherited from: \cPage::cPage()
Parameters
NameTypeDescription
$object\none
methodpubliccPageLeftTop( $showCloser = true) : void

Constructor Function

Parameters
NameTypeDescription
$showCloser

boolean True if the closer should be shown (default)

methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

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

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()\cPage::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()\cPage::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender(\none $print = true) : string

render

Parameters
NameTypeDescription
$print\none
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cPage::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()\cPage::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()\cPage::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContent( $content) : void
inherited

Sets the content for the page

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

mixed Object with a render method or a string containing the content

methodpublicsetContentlessTag( $contentlessTag = true) : void
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetEncoding( $encoding) : void
inherited

Inherited from: \cPage::setEncoding()
Parameters
NameTypeDescription
$encoding
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()\cPage::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)

methodpublicsetExtra( $extra) : void
inherited

Inherited from: \cPage::setExtra()
Parameters
NameTypeDescription
$extra
methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

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

sets the ID class

Inherited from: \cHTML::setID()\cPage::setID()
Parameters
NameTypeDescription
$id
methodpublicsetMargin( $margin) : void
inherited

set the margin width (pixels)

Inherited from: \cPage::setMargin()
Parameters
NameTypeDescription
$margin

int Margin width

methodpublicsetMarkScript( $item) : void
inherited

Inherited from: \cPage::setMarkScript()
Parameters
NameTypeDescription
$item
methodpublicsetMessageBox() : void
inherited

adds the default script for a messagebox

Inherited from: \cPage::setMessageBox()
methodpublicsetReload(\none $location = false) : void
inherited

adds the default script to reload the left pane (frame 2)

Inherited from: \cPage::setReload()
Parameters
NameTypeDescription
$location\none
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

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

addStyleDefinition

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

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetSubnav( $append,  $marea = false) : void
inherited

sets the link to the subnavigation.

Inherited from: \cPage::setSubnav()

Should be set on the first page only.

Parameters
NameTypeDescription
$append

URL to append

$marea
methodpublicshowCloser( $show) : void

set wether the closer should be shown.

Parameters
NameTypeDescription
$show

boolean True if the closer should be shown (default)

methodpublictoHTML() : void
inherited

Renders the output If the tag

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

removes an event handler

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

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

Parameters
NameTypeDescription
$event

string Type of the event

\cPageLeftTopMultiPane

Package: Default
Predefined page for use in frame 1 with a multipane
Parent(s)
\cPageLeftTop < \cPage < \cHTML < \HTML_Common
Children
\cNewPageLeftTopMultiPane
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
inherited
Defines which JS events contain which scripts
Inherited from: \cHTML::$$_aEventDefinitions\cPage::$$_aEventDefinitions\cPageLeftTop::$$_aEventDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aEventDefinitions  
Inherited_from
\cPage::$$_aEventDefinitions  
Inherited_from
\cPageLeftTop::$$_aEventDefinitions  
>VPropertypublic$_aStyleDefinitions
Details
Type
n/a
Inherited_from
\cHTML::$$_aStyleDefinitions  
Inherited_from
\cPage::$$_aStyleDefinitions  
Inherited_from
\cPageLeftTop::$$_aStyleDefinitions  
>VPropertypublicstring $_content
inherited
Storage of the page's content
Inherited from: \cPage::$$_content\cPageLeftTop::$$_content
Details
Type
string
Access
private  
Inherited_from
\cPage::$$_content  
Inherited_from
\cPageLeftTop::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag\cPage::$$_contentlessTag\cPageLeftTop::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cPage::$$_contentlessTag  
Inherited_from
\cPageLeftTop::$$_contentlessTag  
>VPropertypublicstring $_encoding
inherited
Storage of the desired encoding
Inherited from: \cPage::$$_encoding\cPageLeftTop::$$_encoding
Details
Type
string
Access
private  
Inherited_from
\cPage::$$_encoding  
Inherited_from
\cPageLeftTop::$$_encoding  
>VPropertypublicarray $_items
Storage of the items
Details
Type
array
Access
private  
>VPropertypublicint $_margin
inherited
Storage of the margin
Inherited from: \cPage::$$_margin\cPageLeftTop::$$_margin
Details
Type
int
Access
private  
Inherited_from
\cPage::$$_margin  
Inherited_from
\cPageLeftTop::$$_margin  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cPage::$$_requiredScripts\cPageLeftTop::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cPage::$$_requiredScripts  
Inherited_from
\cPageLeftTop::$$_requiredScripts  
>VPropertypublicarray $_scripts
inherited
Storage of scripts to be used on the page
Inherited from: \cPage::$$_scripts\cPageLeftTop::$$_scripts
Details
Type
array
Access
private  
Inherited_from
\cPage::$$_scripts  
Inherited_from
\cPageLeftTop::$$_scripts  
>VPropertypublicstring $_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cPage::$$_skeleton_close  
Inherited_from
\cPageLeftTop::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
inherited
Storage of the open SGML tag template
Inherited from: \cHTML::$$_skeleton_open\cPage::$$_skeleton_open\cPageLeftTop::$$_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cPage::$$_skeleton_open  
Inherited_from
\cPageLeftTop::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
inherited
Storage of a single SGML tag template
Inherited from: \cHTML::$$_skeleton_single\cPage::$$_skeleton_single\cPageLeftTop::$$_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cPage::$$_skeleton_single  
Inherited_from
\cPageLeftTop::$$_skeleton_single  
>VPropertypublicstring $_styledefs
inherited
Defines the style definitions
Inherited from: \cHTML::$$_styledefs\cPage::$$_styledefs\cPageLeftTop::$$_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cPage::$$_styledefs  
Inherited_from
\cPageLeftTop::$$_styledefs  
>VPropertypublicstring $_subnav
inherited
Storage of the sub navigation
Inherited from: \cPage::$$_subnav\cPageLeftTop::$$_subnav
Details
Type
string
Access
private  
Inherited_from
\cPage::$$_subnav  
Inherited_from
\cPageLeftTop::$$_subnav  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag\cPage::$$_tag\cPageLeftTop::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cPage::$$_tag  
Inherited_from
\cPageLeftTop::$$_tag  
>VPropertypublicstring $extra
inherited
Storage of the extra data (see template)
Inherited from: \cPage::$$extra\cPageLeftTop::$$extra
Details
Type
string
Access
private  
Inherited_from
\cPage::$$extra  
Inherited_from
\cPageLeftTop::$$extra  

Methods

methodpublic__toString() : string
inherited

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

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

_setContent: Sets the content of the object

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

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

methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicaddScript( $name,  $script) : void
inherited

sets a specific JavaScript for the header Important: The passed script needs to define tags.

Inherited from: \cPage::addScript()\cPageLeftTop::addScript()
Parameters
NameTypeDescription
$name

string Script identifier

$script

string Script code

methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::advanceID()\cPage::advanceID()\cPageLeftTop::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()\cPage::attachEventDefinition()\cPageLeftTop::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()\cPage::attachStyleDefinition()\cPageLeftTop::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()\cPage::cHTML()\cPageLeftTop::cHTML()
methodpubliccPage(\none $object = false) : void
inherited

Constructor Function

Inherited from: \cPage::cPage()\cPageLeftTop::cPage()
Parameters
NameTypeDescription
$object\none
methodpubliccPageLeftTop( $showCloser = true) : void
inherited

Constructor Function

Inherited from: \cPageLeftTop::cPageLeftTop()
Parameters
NameTypeDescription
$showCloser

boolean True if the closer should be shown (default)

methodpubliccPageLeftTopMultiPane( $items) : void

Constructor Function

The passed array needs to be a multi-array in the following format:

$items = array( array( "image", "description", "link"), array( "image", "description", "link") );

Each sub-array needs to define an image, a description and a link. Note that the images are relative to the current directory, so you should include $cfg["path"]["images"] to retrieve the correct path.

Parameters
NameTypeDescription
$items

array All items passed as multi array (see constructor description)

methodpublicfillCloseSkeleton() : string
inherited

fillCloseSkeleton: Fills the close skeleton

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

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()\cPage::fillSkeleton()\cPageLeftTop::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()\cPage::getID()\cPageLeftTop::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender(\none $print = true) : string

render

Parameters
NameTypeDescription
$print\none
Returns
TypeDescription
stringRendered HTML
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cPage::setAlt()\cPageLeftTop::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()\cPage::setAttribute()\cPageLeftTop::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()\cPage::setClass()\cPageLeftTop::setClass()
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContent( $content) : void
inherited

Sets the content for the page

Inherited from: \cPage::setContent()\cPageLeftTop::setContent()
Parameters
NameTypeDescription
$content

mixed Object with a render method or a string containing the content

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

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()\cPage::setEvent()\cPageLeftTop::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)

methodpublicsetExtra( $extra) : void
Parameters
NameTypeDescription
$extra
methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

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

sets the ID class

Inherited from: \cHTML::setID()\cPage::setID()\cPageLeftTop::setID()
Parameters
NameTypeDescription
$id
methodpublicsetMargin( $margin) : void
inherited

set the margin width (pixels)

Inherited from: \cPage::setMargin()\cPageLeftTop::setMargin()
Parameters
NameTypeDescription
$margin

int Margin width

methodpublicsetMarkScript( $item) : void
Parameters
NameTypeDescription
$item
methodpublicsetMessageBox() : void
inherited

adds the default script for a messagebox

Inherited from: \cPage::setMessageBox()\cPageLeftTop::setMessageBox()
methodpublicsetReload(\none $location = false) : void
inherited

adds the default script to reload the left pane (frame 2)

Inherited from: \cPage::setReload()\cPageLeftTop::setReload()
Parameters
NameTypeDescription
$location\none
methodpublicsetStyle( $style) : void
inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cPage::setStyle()\cPageLeftTop::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
methodpublicsetSubnav( $append,  $marea = false) : void
inherited

sets the link to the subnavigation.

Inherited from: \cPage::setSubnav()\cPageLeftTop::setSubnav()

Should be set on the first page only.

Parameters
NameTypeDescription
$append

URL to append

$marea
methodpublicshowCloser( $show) : void

set wether the closer should be shown.

Parameters
NameTypeDescription
$show

boolean True if the closer should be shown (default)

methodpublictoHTML() : void
inherited

Renders the output If the tag

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

removes an event handler

Inherited from: \cHTML::unsetEvent()\cPage::unsetEvent()\cPageLeftTop::unsetEvent()

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

Parameters
NameTypeDescription
$event

string Type of the event

Documentation was generated by phpDocumentor 2.0.0a12.