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

Show:

inherited

Classes

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
jump to top

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

$_aEventDefinitions

inherited

Defines which JS events contain which scripts

Inherited from: \cHTML::$$_aEventDefinitions \cPage::$$_aEventDefinitions \cPageLeftTop::$$_aEventDefinitions \cPageLeftTopMultiPane::$$_aEventDefinitions

Details

Type: n/a
Inherited_from: \cHTML::$$_aEventDefinitions
Inherited_from: \cPage::$$_aEventDefinitions
Inherited_from: \cPageLeftTop::$$_aEventDefinitions
Inherited_from: \cPageLeftTopMultiPane::$$_aEventDefinitions

$_aStyleDefinitions

inherited

Style definitions

Inherited from: \cHTML::$$_aStyleDefinitions \cPage::$$_aStyleDefinitions \cPageLeftTop::$$_aStyleDefinitions \cPageLeftTopMultiPane::$$_aStyleDefinitions

Details

Type: n/a
Inherited_from: \cHTML::$$_aStyleDefinitions
Inherited_from: \cPage::$$_aStyleDefinitions
Inherited_from: \cPageLeftTop::$$_aStyleDefinitions
Inherited_from: \cPageLeftTopMultiPane::$$_aStyleDefinitions

string $_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

boolean $_contentlessTag

inherited

Defines if the current tag is a contentless tag

Inherited from: \cHTML::$$_contentlessTag \cPage::$$_contentlessTag \cPageLeftTop::$$_contentlessTag \cPageLeftTopMultiPane::$$_contentlessTag

Details

Type: boolean
Access: private
Inherited_from: \cHTML::$$_contentlessTag
Inherited_from: \cPage::$$_contentlessTag
Inherited_from: \cPageLeftTop::$$_contentlessTag
Inherited_from: \cPageLeftTopMultiPane::$$_contentlessTag

string $_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

array $_items

inherited

Storage of the items

Inherited from: \cPageLeftTopMultiPane::$$_items

Details

Type: array
Access: private
Inherited_from: \cPageLeftTopMultiPane::$$_items

int $_margin

inherited

Storage of the margin

Inherited from: \cPage::$$_margin \cPageLeftTop::$$_margin \cPageLeftTopMultiPane::$$_margin

Details

Type: int
Access: private
Inherited_from: \cPage::$$_margin
Inherited_from: \cPageLeftTop::$$_margin
Inherited_from: \cPageLeftTopMultiPane::$$_margin

array $_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

array $_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

string $_skeleton_close

inherited

Storage of the close SGML tag

Inherited from: \cHTML::$$_skeleton_close \cPage::$$_skeleton_close \cPageLeftTop::$$_skeleton_close \cPageLeftTopMultiPane::$$_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

string $_skeleton_open

inherited

Storage of the open SGML tag template

Inherited from: \cHTML::$$_skeleton_open \cPage::$$_skeleton_open \cPageLeftTop::$$_skeleton_open \cPageLeftTopMultiPane::$$_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

string $_skeleton_single

inherited

Storage of a single SGML tag template

Inherited from: \cHTML::$$_skeleton_single \cPage::$$_skeleton_single \cPageLeftTop::$$_skeleton_single \cPageLeftTopMultiPane::$$_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

string $_styledefs

inherited

Defines the style definitions

Inherited from: \cHTML::$$_styledefs \cPage::$$_styledefs \cPageLeftTop::$$_styledefs \cPageLeftTopMultiPane::$$_styledefs

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_styledefs
Inherited_from: \cPage::$$_styledefs
Inherited_from: \cPageLeftTop::$$_styledefs
Inherited_from: \cPageLeftTopMultiPane::$$_styledefs

string $_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

string $_tag

inherited

Defines which tag to use

Inherited from: \cHTML::$$_tag \cPage::$$_tag \cPageLeftTop::$$_tag \cPageLeftTopMultiPane::$$_tag

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_tag
Inherited_from: \cPage::$$_tag
Inherited_from: \cPageLeftTop::$$_tag
Inherited_from: \cPageLeftTopMultiPane::$$_tag

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

__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

Type	Description
string	Generated markup

_setContent( $content) : void

inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cPage::_setContent()\cPageLeftTop::_setContent()\cPageLeftTopMultiPane::_setContent()

Parameters

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

addRequiredScript( $script) : void

inherited

Inherited from: \cHTML::addRequiredScript()\cPage::addRequiredScript()\cPageLeftTop::addRequiredScript()\cPageLeftTopMultiPane::addRequiredScript()

Parameters

Name	Type	Description
$script

addScript( $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

Name	Type	Description
$name		string Script identifier
$script		string Script code

advanceID() : 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.

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

inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()\cPage::attachEventDefinition()\cPageLeftTop::attachEventDefinition()\cPageLeftTopMultiPane::attachEventDefinition()

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

Parameters

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

attachStyleDefinition( $sName, $sDefinition) : string

inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()\cPage::attachStyleDefinition()\cPageLeftTop::attachStyleDefinition()\cPageLeftTopMultiPane::attachStyleDefinition()

This function is not restricted to a single style, e.g. you can set multiple style definitions as-is to the handler.

$example->attachStyle("myIdentifier", "border: 1px solid black; white-space: nowrap"); $example->attachStyle("myIdentifier2", "padding: 0px");

Results in:

style="border: 1px solid black; white-space: nowrap; padding: 0px;"

Parameters

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

Returns

Type	Description
string	filled SGML closing skeleton

cHTML() : void

inherited

Constructor Function Initializes the SGML open/close tags

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

cNewPageLeftTopMultiPane( $items) : void

Parameters

Name	Type	Description
$items

cPage(\none $object = false) : void

inherited

Constructor Function

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

Parameters

Name	Type	Description
$object	\none

cPageLeftTop( $showCloser = true) : void

inherited

Constructor Function

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

Parameters

Name	Type	Description
$showCloser		boolean True if the closer should be shown (default)

cPageLeftTopMultiPane( $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

Name	Type	Description
$items		array All items passed as multi array (see constructor description)

fillCloseSkeleton() : string

inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()\cPage::fillCloseSkeleton()\cPageLeftTop::fillCloseSkeleton()\cPageLeftTopMultiPane::fillCloseSkeleton()

Returns

Type	Description
string	filled SGML closer skeleton

fillSkeleton( $attributes) : string

inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()\cPage::fillSkeleton()\cPageLeftTop::fillSkeleton()\cPageLeftTopMultiPane::fillSkeleton()

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

Parameters

Name	Type	Description
$attributes		string Attributes to set

Returns

Type	Description
string	filled SGML opener skeleton

getID() : string

inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cPage::getID()\cPageLeftTop::getID()\cPageLeftTopMultiPane::getID()

Returns

Type	Description
string	current ID

render(\none $print = true) : string

render

Parameters

Name	Type	Description
$print	\none

Returns

Type	Description
string	Rendered HTML

setAlt( $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

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

setAttribute( $sAttributeName, $sValue) : void

inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cPage::setAttribute()\cPageLeftTop::setAttribute()\cPageLeftTopMultiPane::setAttribute()

Parameters

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

setClass( $class) : void

inherited

sets the CSS class

Inherited from: \cHTML::setClass()\cPage::setClass()\cPageLeftTop::setClass()\cPageLeftTopMultiPane::setClass()

Parameters

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

setContent( $content) : void

inherited

Sets the content for the page

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

Parameters

Name	Type	Description
$content		mixed Object with a render method or a string containing the content

setContentlessTag( $contentlessTag = true) : void

inherited

Inherited from: \cHTML::setContentlessTag()\cPage::setContentlessTag()\cPageLeftTop::setContentlessTag()\cPageLeftTopMultiPane::setContentlessTag()

Parameters

Name	Type	Description
$contentlessTag

setEncoding( $encoding) : void

inherited

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

Parameters

Name	Type	Description
$encoding

setEvent( $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

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

setExtra( $extra) : void

inherited

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

Parameters

Name	Type	Description
$extra

setGenerateXHTML(bool $value) : void

staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cPage::setGenerateXHTML()\cPageLeftTop::setGenerateXHTML()\cPageLeftTopMultiPane::setGenerateXHTML()

Parameters

Name	Type	Description
$value	bool

setID( $id) : void

inherited

sets the ID class

Inherited from: \cHTML::setID()\cPage::setID()\cPageLeftTop::setID()\cPageLeftTopMultiPane::setID()

Parameters

Name	Type	Description
$id

setMargin( $margin) : void

inherited

set the margin width (pixels)

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

Parameters

Name	Type	Description
$margin		int Margin width

setMarkScript( $item) : void

inherited

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

Parameters

Name	Type	Description
$item

setMessageBox() : void

inherited

adds the default script for a messagebox

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

setReload(\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

Name	Type	Description
$location	\none

setStyle( $style) : void

inherited

sets the CSS style

Inherited from: \cHTML::setStyle()\cPage::setStyle()\cPageLeftTop::setStyle()\cPageLeftTopMultiPane::setStyle()

Parameters

Name	Type	Description
$style

setStyleDefinition( $entity, $definition) : string

inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()\cPage::setStyleDefinition()\cPageLeftTop::setStyleDefinition()\cPageLeftTopMultiPane::setStyleDefinition()

Parameters

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

Returns

Type	Description
string	filled SGML closing skeleton

setSubnav( $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

Name	Type	Description
$append		URL to append
$marea

showCloser( $show) : void

inherited

set wether the closer should be shown.

Inherited from: \cPageLeftTopMultiPane::showCloser()

Parameters

Name	Type	Description
$show		boolean True if the closer should be shown (default)

toHTML() : void

inherited

Renders the output If the tag

Inherited from: \cHTML::toHTML()\cPage::toHTML()\cPageLeftTop::toHTML()\cPageLeftTopMultiPane::toHTML()

unsetEvent( $event) : void

inherited

removes an event handler

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

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

Parameters

Name	Type	Description
$event		string Type of the event

\cPage
jump to top

Package: Default

Regular page

Parent(s): \cHTML < \HTML_Common
Children: \cPageLeftTop
Author: Timo A. Hummel

Properties

$_aEventDefinitions

inherited

Defines which JS events contain which scripts

Inherited from: \cHTML::$$_aEventDefinitions

Details

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

$_aStyleDefinitions

inherited

Style definitions

Inherited from: \cHTML::$$_aStyleDefinitions

Details

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

string $_content

Storage of the page's content

Details

Type: string
Access: private

boolean $_contentlessTag

inherited

Defines if the current tag is a contentless tag

Inherited from: \cHTML::$$_contentlessTag

Details

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

string $_encoding

Storage of the desired encoding

Details

Type: string
Access: private

int $_margin

Storage of the margin

Details

Type: int
Access: private

array $_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

array $_scripts

Storage of scripts to be used on the page

Details

Type: array
Access: private

string $_skeleton_close

inherited

Storage of the close SGML tag

Inherited from: \cHTML::$$_skeleton_close

Details

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

string $_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

string $_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

string $_styledefs

inherited

Defines the style definitions

Inherited from: \cHTML::$$_styledefs

Details

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

string $_subnav

Storage of the sub navigation

Details

Type: string
Access: private

string $_tag

inherited

Defines which tag to use

Inherited from: \cHTML::$$_tag

Details

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

string $extra

Storage of the extra data (see template)

Details

Type: string
Access: private

Methods

__toString() : string

inherited

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

Inherited from: \cHTML::__toString()

Returns

Type	Description
string	Generated markup

_setContent( $content) : void

inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()

Parameters

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

addRequiredScript( $script) : void

inherited

Inherited from: \cHTML::addRequiredScript()

Parameters

Name	Type	Description
$script

addScript( $name, $script) : void

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

Parameters

Name	Type	Description
$name		string Script identifier
$script		string Script code

advanceID() : 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.

attachEventDefinition( $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

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

attachStyleDefinition( $sName, $sDefinition) : string

inherited

attachStyleDefinition: Attaches a style definition.

Inherited from: \cHTML::attachStyleDefinition()

This function is not restricted to a single style, e.g. you can set multiple style definitions as-is to the handler.

$example->attachStyle("myIdentifier", "border: 1px solid black; white-space: nowrap"); $example->attachStyle("myIdentifier2", "padding: 0px");

Results in:

style="border: 1px solid black; white-space: nowrap; padding: 0px;"

Parameters

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

Returns

Type	Description
string	filled SGML closing skeleton

cHTML() : void

inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()

cPage(\none $object = false) : void

Constructor Function

Parameters

Name	Type	Description
$object	\none

fillCloseSkeleton() : string

inherited

fillCloseSkeleton: Fills the close skeleton

Inherited from: \cHTML::fillCloseSkeleton()

Returns

Type	Description
string	filled SGML closer skeleton

fillSkeleton( $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

Name	Type	Description
$attributes		string Attributes to set

Returns

Type	Description
string	filled SGML opener skeleton

getID() : string

inherited

getID: returns the current ID

Inherited from: \cHTML::getID()

Returns

Type	Description
string	current ID

render(\none $print = true) : string

render the page

Parameters

Name	Type	Description
$print	\none

Returns

Type	Description
string	Rendered HTML

setAlt( $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

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

setAttribute( $sAttributeName, $sValue) : void

inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()

Parameters

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

setClass( $class) : void

inherited

sets the CSS class

Inherited from: \cHTML::setClass()

Parameters

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

setContent( $content) : void

Sets the content for the page

Parameters

Name	Type	Description
$content		mixed Object with a render method or a string containing the content

setContentlessTag( $contentlessTag = true) : void

inherited

Inherited from: \cHTML::setContentlessTag()

Parameters

Name	Type	Description
$contentlessTag

setEncoding( $encoding) : void

Parameters

Name	Type	Description
$encoding

setEvent( $event, $action) : void

inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()

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

Parameters

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

setExtra( $extra) : void

Parameters

Name	Type	Description
$extra

setGenerateXHTML(bool $value) : void

staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()

Parameters

Name	Type	Description
$value	bool

setID( $id) : void

inherited

sets the ID class

Inherited from: \cHTML::setID()

Parameters

Name	Type	Description
$id

setMargin( $margin) : void

set the margin width (pixels)

Parameters

Name	Type	Description
$margin		int Margin width

setMarkScript( $item) : void

Parameters

Name	Type	Description
$item

setMessageBox() : void

adds the default script for a messagebox

setReload(\none $location = false) : void

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

Parameters

Name	Type	Description
$location	\none

setStyle( $style) : void

inherited

sets the CSS style

Inherited from: \cHTML::setStyle()

Parameters

Name	Type	Description
$style

setStyleDefinition( $entity, $definition) : string

inherited

addStyleDefinition

Inherited from: \cHTML::setStyleDefinition()

Parameters

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

Returns

Type	Description
string	filled SGML closing skeleton

setSubnav( $append, $marea = false) : void

sets the link to the subnavigation.

Should be set on the first page only.

Parameters

Name	Type	Description
$append		URL to append
$marea

toHTML() : void

inherited

Renders the output If the tag

Inherited from: \cHTML::toHTML()

unsetEvent( $event) : void

inherited

removes an event handler

Inherited from: \cHTML::unsetEvent()

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

Parameters

Name	Type	Description
$event		string Type of the event

\cPageLeftTop
jump to top

Package: Default

Predefined page for use in frame 1

Parent(s): \cPage < \cHTML < \HTML_Common
Children: \cPageLeftTopMultiPane
Author: Timo A. Hummel

Properties

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

$_aStyleDefinitions

inherited

Style definitions

Inherited from: \cHTML::$$_aStyleDefinitions \cPage::$$_aStyleDefinitions

Details

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

string $_content

inherited

Storage of the page's content

Inherited from: \cPage::$$_content

Details

Type: string
Access: private
Inherited_from: \cPage::$$_content

boolean $_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

string $_encoding

inherited

Storage of the desired encoding

Inherited from: \cPage::$$_encoding

Details

Type: string
Access: private
Inherited_from: \cPage::$$_encoding

int $_margin

inherited

Storage of the margin

Inherited from: \cPage::$$_margin

Details

Type: int
Access: private
Inherited_from: \cPage::$$_margin

array $_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

array $_scripts

inherited

Storage of scripts to be used on the page

Inherited from: \cPage::$$_scripts

Details

Type: array
Access: private
Inherited_from: \cPage::$$_scripts

string $_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

string $_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

string $_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

string $_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

string $_subnav

inherited

Storage of the sub navigation

Inherited from: \cPage::$$_subnav

Details

Type: string
Access: private
Inherited_from: \cPage::$$_subnav

string $_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

string $extra

inherited

Storage of the extra data (see template)

Inherited from: \cPage::$$extra

Details

Type: string
Access: private
Inherited_from: \cPage::$$extra

Methods

__toString() : string

inherited

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

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

Returns

Type	Description
string	Generated markup

_setContent( $content) : void

inherited

_setContent: Sets the content of the object

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

Parameters

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

addRequiredScript( $script) : void

inherited

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

Parameters

Name	Type	Description
$script

addScript( $name, $script) : void

inherited

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

Inherited from: \cPage::addScript()

Parameters

Name	Type	Description
$name		string Script identifier
$script		string Script code

advanceID() : 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.

attachEventDefinition( $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

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

attachStyleDefinition( $sName, $sDefinition) : string

inherited

attachStyleDefinition: Attaches a style definition.

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

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

Returns

Type	Description
string	filled SGML closing skeleton

cHTML() : void

inherited

Constructor Function Initializes the SGML open/close tags

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

cPage(\none $object = false) : void

inherited

Constructor Function

Inherited from: \cPage::cPage()

Parameters

Name	Type	Description
$object	\none

cPageLeftTop( $showCloser = true) : void

Constructor Function

Parameters

Name	Type	Description
$showCloser		boolean True if the closer should be shown (default)

fillCloseSkeleton() : string

inherited

fillCloseSkeleton: Fills the close skeleton

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

Returns

Type	Description
string	filled SGML closer skeleton

fillSkeleton( $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

Name	Type	Description
$attributes		string Attributes to set

Returns

Type	Description
string	filled SGML opener skeleton

getID() : string

inherited

getID: returns the current ID

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

Returns

Type	Description
string	current ID

render(\none $print = true) : string

render

Parameters

Name	Type	Description
$print	\none

Returns

Type	Description
string	Rendered HTML

setAlt( $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

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

setAttribute( $sAttributeName, $sValue) : void

inherited

setAttribte: Sets a specific attribute

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

Parameters

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

setClass( $class) : void

inherited

sets the CSS class

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

Parameters

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

setContent( $content) : void

inherited

Sets the content for the page

Inherited from: \cPage::setContent()

Parameters

Name	Type	Description
$content		mixed Object with a render method or a string containing the content

setContentlessTag( $contentlessTag = true) : void

inherited

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

Parameters

Name	Type	Description
$contentlessTag

setEncoding( $encoding) : void

inherited

Inherited from: \cPage::setEncoding()

Parameters

Name	Type	Description
$encoding

setEvent( $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

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

setExtra( $extra) : void

inherited

Inherited from: \cPage::setExtra()

Parameters

Name	Type	Description
$extra

setGenerateXHTML(bool $value) : void

staticinherited

Setter for static $_generateXHTML property

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

Parameters

Name	Type	Description
$value	bool

setID( $id) : void

inherited

sets the ID class

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

Parameters

Name	Type	Description
$id

setMargin( $margin) : void

inherited

set the margin width (pixels)

Inherited from: \cPage::setMargin()

Parameters

Name	Type	Description
$margin		int Margin width

setMarkScript( $item) : void

inherited

Inherited from: \cPage::setMarkScript()

Parameters

Name	Type	Description
$item

setMessageBox() : void

inherited

adds the default script for a messagebox

Inherited from: \cPage::setMessageBox()

setReload(\none $location = false) : void

inherited

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

Inherited from: \cPage::setReload()

Parameters

Name	Type	Description
$location	\none

setStyle( $style) : void

inherited

sets the CSS style

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

Parameters

Name	Type	Description
$style

setStyleDefinition( $entity, $definition) : string

inherited

addStyleDefinition

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

Parameters

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

Returns

Type	Description
string	filled SGML closing skeleton

setSubnav( $append, $marea = false) : void

inherited

sets the link to the subnavigation.

Inherited from: \cPage::setSubnav()

Should be set on the first page only.

Parameters

Name	Type	Description
$append		URL to append
$marea

showCloser( $show) : void

set wether the closer should be shown.

Parameters

Name	Type	Description
$show		boolean True if the closer should be shown (default)

toHTML() : void

inherited

Renders the output If the tag

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

unsetEvent( $event) : void

inherited

removes an event handler

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

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

Parameters

Name	Type	Description
$event		string Type of the event

\cPageLeftTopMultiPane
jump to top

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

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

$_aStyleDefinitions

inherited

Style definitions

Inherited from: \cHTML::$$_aStyleDefinitions \cPage::$$_aStyleDefinitions \cPageLeftTop::$$_aStyleDefinitions

Details

Type: n/a
Inherited_from: \cHTML::$$_aStyleDefinitions
Inherited_from: \cPage::$$_aStyleDefinitions
Inherited_from: \cPageLeftTop::$$_aStyleDefinitions

string $_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

boolean $_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

string $_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

array $_items

Storage of the items

Details

Type: array
Access: private

int $_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

array $_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

array $_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

string $_skeleton_close

inherited

Storage of the close SGML tag

Inherited from: \cHTML::$$_skeleton_close \cPage::$$_skeleton_close \cPageLeftTop::$$_skeleton_close

Details

Type: string
Access: private
Inherited_from: \cHTML::$$_skeleton_close
Inherited_from: \cPage::$$_skeleton_close
Inherited_from: \cPageLeftTop::$$_skeleton_close

string $_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

string $_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

string $_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

string $_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

string $_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

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

__toString() : string

inherited

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

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

Returns

Type	Description
string	Generated markup

_setContent( $content) : void

inherited

_setContent: Sets the content of the object

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

Parameters

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

addRequiredScript( $script) : void

inherited

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

Parameters

Name	Type	Description
$script

addScript( $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

Name	Type	Description
$name		string Script identifier
$script		string Script code

advanceID() : 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.

attachEventDefinition( $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

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

attachStyleDefinition( $sName, $sDefinition) : string

inherited

attachStyleDefinition: Attaches a style definition.

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

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

Returns

Type	Description
string	filled SGML closing skeleton

cHTML() : void

inherited

Constructor Function Initializes the SGML open/close tags

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

cPage(\none $object = false) : void

inherited

Constructor Function

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

Parameters

Name	Type	Description
$object	\none

cPageLeftTop( $showCloser = true) : void

inherited

Constructor Function

Inherited from: \cPageLeftTop::cPageLeftTop()

Parameters

Name	Type	Description
$showCloser		boolean True if the closer should be shown (default)

cPageLeftTopMultiPane( $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") );

Parameters

Name	Type	Description
$items		array All items passed as multi array (see constructor description)

fillCloseSkeleton() : string

inherited

fillCloseSkeleton: Fills the close skeleton

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

Returns

Type	Description
string	filled SGML closer skeleton

fillSkeleton( $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

Name	Type	Description
$attributes		string Attributes to set

Returns

Type	Description
string	filled SGML opener skeleton

getID() : string

inherited

getID: returns the current ID

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

Returns

Type	Description
string	current ID

render(\none $print = true) : string

render

Parameters

Name	Type	Description
$print	\none

Returns

Type	Description
string	Rendered HTML

setAlt( $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

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

setAttribute( $sAttributeName, $sValue) : void

inherited

setAttribte: Sets a specific attribute

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

Parameters

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

setClass( $class) : void

inherited

sets the CSS class

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

Parameters

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

setContent( $content) : void

inherited

Sets the content for the page

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

Parameters

Name	Type	Description
$content		mixed Object with a render method or a string containing the content

setContentlessTag( $contentlessTag = true) : void

inherited

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

Parameters

Name	Type	Description
$contentlessTag

setEncoding( $encoding) : void

inherited

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

Parameters

Name	Type	Description
$encoding

setEvent( $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

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

setExtra( $extra) : void

inherited

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

Parameters

Name	Type	Description
$extra

setGenerateXHTML(bool $value) : void

staticinherited

Setter for static $_generateXHTML property

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

Parameters

Name	Type	Description
$value	bool

setID( $id) : void

inherited

sets the ID class

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

Parameters

Name	Type	Description
$id

setMargin( $margin) : void

inherited

set the margin width (pixels)

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

Parameters

Name	Type	Description
$margin		int Margin width

setMarkScript( $item) : void

inherited

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

Parameters

Name	Type	Description
$item

setMessageBox() : void

inherited

adds the default script for a messagebox

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

setReload(\none $location = false) : void

inherited

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

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

Parameters

Name	Type	Description
$location	\none

setStyle( $style) : void

inherited

sets the CSS style

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

Parameters

Name	Type	Description
$style

setStyleDefinition( $entity, $definition) : string

inherited

addStyleDefinition

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

Parameters

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

Returns

Type	Description
string	filled SGML closing skeleton

setSubnav( $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

Name	Type	Description
$append		URL to append
$marea

showCloser( $show) : void

set wether the closer should be shown.

Parameters

Name	Type	Description
$show		boolean True if the closer should be shown (default)

toHTML() : void

inherited

Renders the output If the tag

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

unsetEvent( $event) : void

inherited

removes an event handler

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

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

Parameters

Name	Type	Description
$event		string Type of the event

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

\cNewPageLeftTopMultiPanejump to top

Properties

Methods

\cPagejump to top

Properties

Methods

\cPageLeftTopjump to top

Properties

Methods

\cPageLeftTopMultiPanejump to top

Properties

Methods

\cNewPageLeftTopMultiPane
jump to top

\cPage
jump to top

\cPageLeftTop
jump to top

\cPageLeftTopMultiPane
jump to top