contenido\classes\widgets\class.widgets.page.php
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
- Parent(s)
- \cPageLeftTopMultiPane < \cPageLeftTop < \cPage < \cHTML < \HTML_Common
- Author
- Timo A. Hummel
Properties


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


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


string $_content
- Type
- string
- Access
- private
- Inherited_from
- \cPage::$$_content
- Inherited_from
- \cPageLeftTop::$$_content
- Inherited_from
- \cPageLeftTopMultiPane::$$_content


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


string $_encoding
- Type
- string
- Access
- private
- Inherited_from
- \cPage::$$_encoding
- Inherited_from
- \cPageLeftTop::$$_encoding
- Inherited_from
- \cPageLeftTopMultiPane::$$_encoding


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


array $_requiredScripts
- Type
- array
- Access
- private
- Inherited_from
- \cHTML::$$_requiredScripts
- Inherited_from
- \cPage::$$_requiredScripts
- Inherited_from
- \cPageLeftTop::$$_requiredScripts
- Inherited_from
- \cPageLeftTopMultiPane::$$_requiredScripts


array $_scripts
- Type
- array
- Access
- private
- Inherited_from
- \cPage::$$_scripts
- Inherited_from
- \cPageLeftTop::$$_scripts
- Inherited_from
- \cPageLeftTopMultiPane::$$_scripts


string $_skeleton_close
- 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
- 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
- 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
- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_styledefs
- Inherited_from
- \cPage::$$_styledefs
- Inherited_from
- \cPageLeftTop::$$_styledefs
- Inherited_from
- \cPageLeftTopMultiPane::$$_styledefs


string $_subnav
- Type
- string
- Access
- private
- Inherited_from
- \cPage::$$_subnav
- Inherited_from
- \cPageLeftTop::$$_subnav
- Inherited_from
- \cPageLeftTopMultiPane::$$_subnav


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


string $extra
- Type
- string
- Access
- private
- Inherited_from
- \cPage::$$extra
- Inherited_from
- \cPageLeftTop::$$extra
- Inherited_from
- \cPageLeftTopMultiPane::$$extra
Methods


__toString() : string
Direct call of object as string will return it's generated markup.
Inherited from: \cHTML::__toString()\cPage::__toString()\cPageLeftTop::__toString()\cPageLeftTopMultiPane::__toString()Type | Description |
---|---|
string | Generated markup |


_setContent( $content) : void
_setContent: Sets the content of the object
Inherited from: \cHTML::_setContent()\cPage::_setContent()\cPageLeftTop::_setContent()\cPageLeftTopMultiPane::_setContent()Name | Type | Description |
---|---|---|
$content | string/object String with the content or an object to render. |


addRequiredScript( $script) : void
Name | Type | Description |
---|---|---|
$script |


addScript( $name, $script) : void
sets a specific JavaScript for the header Important: The passed script needs to define tags.
Inherited from: \cPage::addScript()\cPageLeftTop::addScript()\cPageLeftTopMultiPane::addScript()Name | Type | Description |
---|---|---|
$name | string Script identifier | |
$script | string Script code |


advanceID() : void
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
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');");
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
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;"
Name | Type | Description |
---|---|---|
$sName | string Name for a style definition | |
$sDefinition | string Definition for the given entity |
Type | Description |
---|---|
string | filled SGML closing skeleton |


cHTML() : void
Constructor Function Initializes the SGML open/close tags
Inherited from: \cHTML::cHTML()\cPage::cHTML()\cPageLeftTop::cHTML()\cPageLeftTopMultiPane::cHTML()

cPage(\none $object = false) : void
Constructor Function
Inherited from: \cPage::cPage()\cPageLeftTop::cPage()\cPageLeftTopMultiPane::cPage()Name | Type | Description |
---|---|---|
$object | \none |


cPageLeftTop( $showCloser = true) : void
Constructor Function
Inherited from: \cPageLeftTop::cPageLeftTop()\cPageLeftTopMultiPane::cPageLeftTop()Name | Type | Description |
---|---|---|
$showCloser | boolean True if the closer should be shown (default) |


cPageLeftTopMultiPane( $items) : void
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.
Name | Type | Description |
---|---|---|
$items | array All items passed as multi array (see constructor description) |


fillCloseSkeleton() : string
fillCloseSkeleton: Fills the close skeleton
Inherited from: \cHTML::fillCloseSkeleton()\cPage::fillCloseSkeleton()\cPageLeftTop::fillCloseSkeleton()\cPageLeftTopMultiPane::fillCloseSkeleton()Type | Description |
---|---|
string | filled SGML closer skeleton |


fillSkeleton( $attributes) : string
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.
Name | Type | Description |
---|---|---|
$attributes | string Attributes to set |
Type | Description |
---|---|
string | filled SGML opener skeleton |


getID() : string
getID: returns the current ID
Inherited from: \cHTML::getID()\cPage::getID()\cPageLeftTop::getID()\cPageLeftTopMultiPane::getID()Type | Description |
---|---|
string | current ID |


render(\none $print = true) : string
render
Name | Type | Description |
---|---|---|
\none |
Type | Description |
---|---|
string | Rendered HTML |


setAlt( $alt) : void
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.
Name | Type | Description |
---|---|---|
$alt | string Text to set as the "alt" attribute |


setAttribute( $sAttributeName, $sValue) : void
setAttribte: Sets a specific attribute
Inherited from: \cHTML::setAttribute()\cPage::setAttribute()\cPageLeftTop::setAttribute()\cPageLeftTopMultiPane::setAttribute()Name | Type | Description |
---|---|---|
$sAttributeName | string Name of the attribute | |
$sValue | string Value of the attribute |


setClass( $class) : void
sets the CSS class
Inherited from: \cHTML::setClass()\cPage::setClass()\cPageLeftTop::setClass()\cPageLeftTopMultiPane::setClass()Name | Type | Description |
---|---|---|
$class | string Text to set as the "alt" attribute |


setContent( $content) : void
Sets the content for the page
Inherited from: \cPage::setContent()\cPageLeftTop::setContent()\cPageLeftTopMultiPane::setContent()Name | Type | Description |
---|---|---|
$content | mixed Object with a render method or a string containing the content |


setContentlessTag( $contentlessTag = true) : void
Name | Type | Description |
---|---|---|
$contentlessTag |


setEncoding( $encoding) : void
Name | Type | Description |
---|---|---|
$encoding |


setEvent( $event, $action) : void
adds an "onXXX" javascript event handler
Inherited from: \cHTML::setEvent()\cPage::setEvent()\cPageLeftTop::setEvent()\cPageLeftTopMultiPane::setEvent()example: $item->setEvent("change","document.forms[0].submit");
Name | Type | Description |
---|---|---|
$event | string Type of the event | |
$action | string Function or action to call (JavaScript Code) |


setExtra( $extra) : void
Name | Type | Description |
---|---|---|
$extra |


setGenerateXHTML(bool $value) : void
Setter for static $_generateXHTML property
Inherited from: \cHTML::setGenerateXHTML()\cPage::setGenerateXHTML()\cPageLeftTop::setGenerateXHTML()\cPageLeftTopMultiPane::setGenerateXHTML()Name | Type | Description |
---|---|---|
$value | bool |


setID( $id) : void
sets the ID class
Inherited from: \cHTML::setID()\cPage::setID()\cPageLeftTop::setID()\cPageLeftTopMultiPane::setID()Name | Type | Description |
---|---|---|
$id |


setMargin( $margin) : void
set the margin width (pixels)
Inherited from: \cPage::setMargin()\cPageLeftTop::setMargin()\cPageLeftTopMultiPane::setMargin()Name | Type | Description |
---|---|---|
$margin | int Margin width |


setMarkScript( $item) : void
Name | Type | Description |
---|---|---|
$item |


setMessageBox() : void
adds the default script for a messagebox
Inherited from: \cPage::setMessageBox()\cPageLeftTop::setMessageBox()\cPageLeftTopMultiPane::setMessageBox()

setReload(\none $location = false) : void
adds the default script to reload the left pane (frame 2)
Inherited from: \cPage::setReload()\cPageLeftTop::setReload()\cPageLeftTopMultiPane::setReload()Name | Type | Description |
---|---|---|
$location | \none |


setStyle( $style) : void
sets the CSS style
Inherited from: \cHTML::setStyle()\cPage::setStyle()\cPageLeftTop::setStyle()\cPageLeftTopMultiPane::setStyle()Name | Type | Description |
---|---|---|
$style |


setStyleDefinition( $entity, $definition) : string
addStyleDefinition
Inherited from: \cHTML::setStyleDefinition()\cPage::setStyleDefinition()\cPageLeftTop::setStyleDefinition()\cPageLeftTopMultiPane::setStyleDefinition()Name | Type | Description |
---|---|---|
$entity | string Entity to define | |
$definition | string Definition for the given entity |
Type | Description |
---|---|
string | filled SGML closing skeleton |


setSubnav( $append, $marea = false) : void
sets the link to the subnavigation.
Inherited from: \cPage::setSubnav()\cPageLeftTop::setSubnav()\cPageLeftTopMultiPane::setSubnav()Should be set on the first page only.
Name | Type | Description |
---|---|---|
$append | URL to append | |
$marea |


showCloser( $show) : void
Name | Type | Description |
---|---|---|
$show | boolean True if the closer should be shown (default) |


toHTML() : void
Renders the output If the tag
Inherited from: \cHTML::toHTML()\cPage::toHTML()\cPageLeftTop::toHTML()\cPageLeftTopMultiPane::toHTML()

unsetEvent( $event) : void
removes an event handler
Inherited from: \cHTML::unsetEvent()\cPage::unsetEvent()\cPageLeftTop::unsetEvent()\cPageLeftTopMultiPane::unsetEvent()example: $item->unsetEvent("change");
Name | Type | Description |
---|---|---|
$event | string Type of the event |
\cPage
- Parent(s)
- \cHTML < \HTML_Common
- Children
- \cPageLeftTop
- Author
- Timo A. Hummel
Properties


array $_requiredScripts
- Type
- array
- Access
- private
- Inherited_from
- \cHTML::$$_requiredScripts
Methods


__toString() : string
Direct call of object as string will return it's generated markup.
Inherited from: \cHTML::__toString()Type | Description |
---|---|
string | Generated markup |


_setContent( $content) : void
Name | Type | Description |
---|---|---|
$content | string/object String with the content or an object to render. |


addRequiredScript( $script) : void
Name | Type | Description |
---|---|---|
$script |


addScript( $name, $script) : void
sets a specific JavaScript for the header Important: The passed script needs to define tags.
Name | Type | Description |
---|---|---|
$name | string Script identifier | |
$script | string Script code |


advanceID() : void
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
attachEventDefinition: Attaches the code for an event
Inherited from: \cHTML::attachEventDefinition()Example to attach an onClick handler: setEventDefinition("foo", "onClick", "alert('foo');");
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
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;"
Name | Type | Description |
---|---|---|
$sName | string Name for a style definition | |
$sDefinition | string Definition for the given entity |
Type | Description |
---|---|
string | filled SGML closing skeleton |


fillSkeleton( $attributes) : string
fillSkeleton fills the SGML opener tag with the specified attributes. Attributes need to be passed in the stringyfied variant.
Name | Type | Description |
---|---|---|
$attributes | string Attributes to set |
Type | Description |
---|---|
string | filled SGML opener skeleton |


render(\none $print = true) : string
render the page
Name | Type | Description |
---|---|---|
\none |
Type | Description |
---|---|
string | Rendered HTML |


setAlt( $alt) : void
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.
Name | Type | Description |
---|---|---|
$alt | string Text to set as the "alt" attribute |


setAttribute( $sAttributeName, $sValue) : void
Name | Type | Description |
---|---|---|
$sAttributeName | string Name of the attribute | |
$sValue | string Value of the attribute |


setClass( $class) : void
Name | Type | Description |
---|---|---|
$class | string Text to set as the "alt" attribute |


setContent( $content) : void
Sets the content for the page
Name | Type | Description |
---|---|---|
$content | mixed Object with a render method or a string containing the content |


setContentlessTag( $contentlessTag = true) : void
Name | Type | Description |
---|---|---|
$contentlessTag |


setEvent( $event, $action) : void
example: $item->setEvent("change","document.forms[0].submit");
Name | Type | Description |
---|---|---|
$event | string Type of the event | |
$action | string Function or action to call (JavaScript Code) |


setMargin( $margin) : void
set the margin width (pixels)
Name | Type | Description |
---|---|---|
$margin | int Margin width |


setReload(\none $location = false) : void
adds the default script to reload the left pane (frame 2)
Name | Type | Description |
---|---|---|
$location | \none |


setStyleDefinition( $entity, $definition) : string
Name | Type | Description |
---|---|---|
$entity | string Entity to define | |
$definition | string Definition for the given entity |
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.
Name | Type | Description |
---|---|---|
$append | URL to append | |
$marea |
\cPageLeftTop
- Parent(s)
- \cPage < \cHTML < \HTML_Common
- Children
- \cPageLeftTopMultiPane
- Author
- Timo A. Hummel
Properties


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


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


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


array $_requiredScripts
- Type
- array
- Access
- private
- Inherited_from
- \cHTML::$$_requiredScripts
- Inherited_from
- \cPage::$$_requiredScripts


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


string $_skeleton_open
- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_open
- Inherited_from
- \cPage::$$_skeleton_open


string $_skeleton_single
- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_single
- Inherited_from
- \cPage::$$_skeleton_single


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


string $_tag
- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_tag
- Inherited_from
- \cPage::$$_tag
Methods


__toString() : string
Direct call of object as string will return it's generated markup.
Inherited from: \cHTML::__toString()\cPage::__toString()Type | Description |
---|---|
string | Generated markup |


_setContent( $content) : void
_setContent: Sets the content of the object
Inherited from: \cHTML::_setContent()\cPage::_setContent()Name | Type | Description |
---|---|---|
$content | string/object String with the content or an object to render. |


addScript( $name, $script) : void
sets a specific JavaScript for the header Important: The passed script needs to define tags.
Inherited from: \cPage::addScript()Name | Type | Description |
---|---|---|
$name | string Script identifier | |
$script | string Script code |


advanceID() : void
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
attachEventDefinition: Attaches the code for an event
Inherited from: \cHTML::attachEventDefinition()\cPage::attachEventDefinition()Example to attach an onClick handler: setEventDefinition("foo", "onClick", "alert('foo');");
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
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;"
Name | Type | Description |
---|---|---|
$sName | string Name for a style definition | |
$sDefinition | string Definition for the given entity |
Type | Description |
---|---|
string | filled SGML closing skeleton |


cHTML() : void
Constructor Function Initializes the SGML open/close tags
Inherited from: \cHTML::cHTML()\cPage::cHTML()

cPageLeftTop( $showCloser = true) : void
Constructor Function
Name | Type | Description |
---|---|---|
$showCloser | boolean True if the closer should be shown (default) |


fillCloseSkeleton() : string
fillCloseSkeleton: Fills the close skeleton
Inherited from: \cHTML::fillCloseSkeleton()\cPage::fillCloseSkeleton()Type | Description |
---|---|
string | filled SGML closer skeleton |


fillSkeleton( $attributes) : string
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.
Name | Type | Description |
---|---|---|
$attributes | string Attributes to set |
Type | Description |
---|---|
string | filled SGML opener skeleton |


render(\none $print = true) : string
render
Name | Type | Description |
---|---|---|
\none |
Type | Description |
---|---|
string | Rendered HTML |


setAlt( $alt) : void
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.
Name | Type | Description |
---|---|---|
$alt | string Text to set as the "alt" attribute |


setAttribute( $sAttributeName, $sValue) : void
setAttribte: Sets a specific attribute
Inherited from: \cHTML::setAttribute()\cPage::setAttribute()Name | Type | Description |
---|---|---|
$sAttributeName | string Name of the attribute | |
$sValue | string Value of the attribute |


setClass( $class) : void
Name | Type | Description |
---|---|---|
$class | string Text to set as the "alt" attribute |


setContent( $content) : void
Name | Type | Description |
---|---|---|
$content | mixed Object with a render method or a string containing the content |


setEncoding( $encoding) : void
Name | Type | Description |
---|---|---|
$encoding |


setEvent( $event, $action) : void
adds an "onXXX" javascript event handler
Inherited from: \cHTML::setEvent()\cPage::setEvent()example: $item->setEvent("change","document.forms[0].submit");
Name | Type | Description |
---|---|---|
$event | string Type of the event | |
$action | string Function or action to call (JavaScript Code) |


setExtra( $extra) : void
Name | Type | Description |
---|---|---|
$extra |


setGenerateXHTML(bool $value) : void
Setter for static $_generateXHTML property
Inherited from: \cHTML::setGenerateXHTML()\cPage::setGenerateXHTML()Name | Type | Description |
---|---|---|
$value | bool |


setMarkScript( $item) : void
Name | Type | Description |
---|---|---|
$item |


setReload(\none $location = false) : void
adds the default script to reload the left pane (frame 2)
Inherited from: \cPage::setReload()Name | Type | Description |
---|---|---|
$location | \none |


setStyleDefinition( $entity, $definition) : string
Name | Type | Description |
---|---|---|
$entity | string Entity to define | |
$definition | string Definition for the given entity |
Type | Description |
---|---|
string | filled SGML closing skeleton |


setSubnav( $append, $marea = false) : void
Should be set on the first page only.
Name | Type | Description |
---|---|---|
$append | URL to append | |
$marea |


showCloser( $show) : void
set wether the closer should be shown.
Name | Type | Description |
---|---|---|
$show | boolean True if the closer should be shown (default) |
\cPageLeftTopMultiPane
- Parent(s)
- \cPageLeftTop < \cPage < \cHTML < \HTML_Common
- Children
- \cNewPageLeftTopMultiPane
- Author
- Timo A. Hummel
Properties


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


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


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


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


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


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


array $_requiredScripts
- Type
- array
- Access
- private
- Inherited_from
- \cHTML::$$_requiredScripts
- Inherited_from
- \cPage::$$_requiredScripts
- Inherited_from
- \cPageLeftTop::$$_requiredScripts


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


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


string $_skeleton_open
- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_open
- Inherited_from
- \cPage::$$_skeleton_open
- Inherited_from
- \cPageLeftTop::$$_skeleton_open


string $_skeleton_single
- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_single
- Inherited_from
- \cPage::$$_skeleton_single
- Inherited_from
- \cPageLeftTop::$$_skeleton_single


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


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


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


string $extra
- Type
- string
- Access
- private
- Inherited_from
- \cPage::$$extra
- Inherited_from
- \cPageLeftTop::$$extra
Methods


__toString() : string
Direct call of object as string will return it's generated markup.
Inherited from: \cHTML::__toString()\cPage::__toString()\cPageLeftTop::__toString()Type | Description |
---|---|
string | Generated markup |


_setContent( $content) : void
_setContent: Sets the content of the object
Inherited from: \cHTML::_setContent()\cPage::_setContent()\cPageLeftTop::_setContent()Name | Type | Description |
---|---|---|
$content | string/object String with the content or an object to render. |


addRequiredScript( $script) : void
Name | Type | Description |
---|---|---|
$script |


addScript( $name, $script) : void
sets a specific JavaScript for the header Important: The passed script needs to define tags.
Inherited from: \cPage::addScript()\cPageLeftTop::addScript()Name | Type | Description |
---|---|---|
$name | string Script identifier | |
$script | string Script code |


advanceID() : void
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
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');");
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
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;"
Name | Type | Description |
---|---|---|
$sName | string Name for a style definition | |
$sDefinition | string Definition for the given entity |
Type | Description |
---|---|
string | filled SGML closing skeleton |


cHTML() : void
Constructor Function Initializes the SGML open/close tags
Inherited from: \cHTML::cHTML()\cPage::cHTML()\cPageLeftTop::cHTML()

cPageLeftTop( $showCloser = true) : void
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") );
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.
Name | Type | Description |
---|---|---|
$items | array All items passed as multi array (see constructor description) |


fillCloseSkeleton() : string
fillCloseSkeleton: Fills the close skeleton
Inherited from: \cHTML::fillCloseSkeleton()\cPage::fillCloseSkeleton()\cPageLeftTop::fillCloseSkeleton()Type | Description |
---|---|
string | filled SGML closer skeleton |


fillSkeleton( $attributes) : string
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.
Name | Type | Description |
---|---|---|
$attributes | string Attributes to set |
Type | Description |
---|---|
string | filled SGML opener skeleton |


getID() : string
getID: returns the current ID
Inherited from: \cHTML::getID()\cPage::getID()\cPageLeftTop::getID()Type | Description |
---|---|
string | current ID |


render(\none $print = true) : string
render
Name | Type | Description |
---|---|---|
\none |
Type | Description |
---|---|
string | Rendered HTML |


setAlt( $alt) : void
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.
Name | Type | Description |
---|---|---|
$alt | string Text to set as the "alt" attribute |


setAttribute( $sAttributeName, $sValue) : void
setAttribte: Sets a specific attribute
Inherited from: \cHTML::setAttribute()\cPage::setAttribute()\cPageLeftTop::setAttribute()Name | Type | Description |
---|---|---|
$sAttributeName | string Name of the attribute | |
$sValue | string Value of the attribute |


setClass( $class) : void
sets the CSS class
Inherited from: \cHTML::setClass()\cPage::setClass()\cPageLeftTop::setClass()Name | Type | Description |
---|---|---|
$class | string Text to set as the "alt" attribute |


setContent( $content) : void
Sets the content for the page
Inherited from: \cPage::setContent()\cPageLeftTop::setContent()Name | Type | Description |
---|---|---|
$content | mixed Object with a render method or a string containing the content |


setContentlessTag( $contentlessTag = true) : void
Name | Type | Description |
---|---|---|
$contentlessTag |


setEvent( $event, $action) : void
adds an "onXXX" javascript event handler
Inherited from: \cHTML::setEvent()\cPage::setEvent()\cPageLeftTop::setEvent()example: $item->setEvent("change","document.forms[0].submit");
Name | Type | Description |
---|---|---|
$event | string Type of the event | |
$action | string Function or action to call (JavaScript Code) |


setGenerateXHTML(bool $value) : void
Setter for static $_generateXHTML property
Inherited from: \cHTML::setGenerateXHTML()\cPage::setGenerateXHTML()\cPageLeftTop::setGenerateXHTML()Name | Type | Description |
---|---|---|
$value | bool |


setMessageBox() : void
adds the default script for a messagebox
Inherited from: \cPage::setMessageBox()\cPageLeftTop::setMessageBox()

setReload(\none $location = false) : void
adds the default script to reload the left pane (frame 2)
Inherited from: \cPage::setReload()\cPageLeftTop::setReload()Name | Type | Description |
---|---|---|
$location | \none |


setStyle( $style) : void
sets the CSS style
Inherited from: \cHTML::setStyle()\cPage::setStyle()\cPageLeftTop::setStyle()Name | Type | Description |
---|---|---|
$style |


setStyleDefinition( $entity, $definition) : string
addStyleDefinition
Inherited from: \cHTML::setStyleDefinition()\cPage::setStyleDefinition()\cPageLeftTop::setStyleDefinition()Name | Type | Description |
---|---|---|
$entity | string Entity to define | |
$definition | string Definition for the given entity |
Type | Description |
---|---|
string | filled SGML closing skeleton |


setSubnav( $append, $marea = false) : void
sets the link to the subnavigation.
Inherited from: \cPage::setSubnav()\cPageLeftTop::setSubnav()Should be set on the first page only.
Name | Type | Description |
---|---|---|
$append | URL to append | |
$marea |


showCloser( $show) : void
set wether the closer should be shown.
Name | Type | Description |
---|---|---|
$show | boolean True if the closer should be shown (default) |


toHTML() : void
Renders the output If the tag
Inherited from: \cHTML::toHTML()\cPage::toHTML()\cPageLeftTop::toHTML()

unsetEvent( $event) : void
removes an event handler
Inherited from: \cHTML::unsetEvent()\cPage::unsetEvent()\cPageLeftTop::unsetEvent()example: $item->unsetEvent("change");
Name | Type | Description |
---|---|---|
$event | string Type of the event |