Methods
Constructor Function
Initializes the SGML open/close tags
__construct() : void
Inherited
| inherited_from |
\cHTML::__construct() |
| inherited_from |
\cPage::__construct() |
| inherited_from |
\cPageLeftTop::__construct() |
| inherited_from |
\cPageLeftTopMultiPane::__construct() |
_setContent: Sets the content of the object
_setContent(\$content $content)
Inherited
| inherited_from |
\cHTML::_setContent() |
| inherited_from |
\cPage::_setContent() |
| inherited_from |
\cPageLeftTop::_setContent() |
| inherited_from |
\cPageLeftTopMultiPane::_setContent() |
Parameters
$content
\$contentstring/object String with the content or an object to render.
addRequiredScript()
addRequiredScript($script)
Inherited
| inherited_from |
\cHTML::addRequiredScript() |
| inherited_from |
\cPage::addRequiredScript() |
| inherited_from |
\cPageLeftTop::addRequiredScript() |
| inherited_from |
\cPageLeftTopMultiPane::addRequiredScript() |
Parameters
$script
sets a specific JavaScript for the header
Important: The passed script needs to define <script></script> tags.
addScript(\$name $name, \$script $script)
Inherited
| inherited_from |
\cPage::addScript() |
| inherited_from |
\cPageLeftTop::addScript() |
| inherited_from |
\cPageLeftTopMultiPane::addScript() |
Parameters
$name
\$namestring Script identifier
$script
\$scriptstring Script code
advances to the next ID available in the system.
advanceID()
Inherited
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.
| inherited_from |
\cHTML::advanceID() |
| inherited_from |
\cPage::advanceID() |
| inherited_from |
\cPageLeftTop::advanceID() |
| inherited_from |
\cPageLeftTopMultiPane::advanceID() |
attachEventDefinition: Attaches the code for an event
attachEventDefinition(\$sName $sName, \$sEvent $sEvent, \$sCode $sCode)
Inherited
Example to attach an onClick handler:
setEventDefinition("foo", "onClick", "alert('foo');");
| inherited_from |
\cHTML::attachEventDefinition() |
| inherited_from |
\cPage::attachEventDefinition() |
| inherited_from |
\cPageLeftTop::attachEventDefinition() |
| inherited_from |
\cPageLeftTopMultiPane::attachEventDefinition() |
Parameters
$sName
\$sNamestring defines the name of the event
$sEvent
\$sEventstring defines the event (e.g. onClick)
$sCode
\$sCodestring defines the code
attachStyleDefinition: Attaches a style definition.
attachStyleDefinition(\$sName $sName, \$sDefinition $sDefinition) : string
Inherited
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;"
| inherited_from |
\cHTML::attachStyleDefinition() |
| inherited_from |
\cPage::attachStyleDefinition() |
| inherited_from |
\cPageLeftTop::attachStyleDefinition() |
| inherited_from |
\cPageLeftTopMultiPane::attachStyleDefinition() |
Parameters
$sName
\$sNamestring Name for a style definition
$sDefinition
\$sDefinitionstring Definition for the given entity
Returns
stringfilled SGML closing skeleton
old Constructor
cHTML()
Inherited
| inherited_from |
\cHTML::cHTML() |
| inherited_from |
\cPage::cHTML() |
| inherited_from |
\cPageLeftTop::cHTML() |
| inherited_from |
\cPageLeftTopMultiPane::cHTML() |
cNewPageLeftTopMultiPane()
cNewPageLeftTopMultiPane($items)
Constructor Function
cPage($object)
Inherited
| inherited_from |
\cPage::cPage() |
| inherited_from |
\cPageLeftTop::cPage() |
| inherited_from |
\cPageLeftTopMultiPane::cPage() |
Parameters
Constructor Function
cPageLeftTop(\$showCloser $showCloser)
Inherited
| inherited_from |
\cPageLeftTop::cPageLeftTop() |
| inherited_from |
\cPageLeftTopMultiPane::cPageLeftTop() |
Parameters
$showCloser
\$showCloserboolean True if the closer should be shown (default)
Constructor Function
cPageLeftTopMultiPane(\$items $items)
Inherited
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.
| inherited_from |
\cPageLeftTopMultiPane::cPageLeftTopMultiPane() |
Parameters
$items
\$itemsarray All items passed as multi array (see constructor description)
fillCloseSkeleton: Fills the close skeleton
fillCloseSkeleton() : string
Inherited
| inherited_from |
\cHTML::fillCloseSkeleton() |
| inherited_from |
\cPage::fillCloseSkeleton() |
| inherited_from |
\cPageLeftTop::fillCloseSkeleton() |
| inherited_from |
\cPageLeftTopMultiPane::fillCloseSkeleton() |
Returns
stringfilled SGML closer skeleton
fillSkeleton: Fills the open SGML tag skeleton
fillSkeleton(\$attributes $attributes) : string
Inherited
fillSkeleton fills the SGML opener tag with the
specified attributes. Attributes need to be passed
in the stringyfied variant.
| inherited_from |
\cHTML::fillSkeleton() |
| inherited_from |
\cPage::fillSkeleton() |
| inherited_from |
\cPageLeftTop::fillSkeleton() |
| inherited_from |
\cPageLeftTopMultiPane::fillSkeleton() |
Parameters
$attributes
\$attributesstring Attributes to set
Returns
stringfilled SGML opener skeleton
getID: returns the current ID
getID() : string
Inherited
| inherited_from |
\cHTML::getID() |
| inherited_from |
\cPage::getID() |
| inherited_from |
\cPageLeftTop::getID() |
| inherited_from |
\cPageLeftTopMultiPane::getID() |
Returns
stringcurrent ID
render
render($print) : string
Parameters
Returns
stringRendered HTML
setAlt: sets the alt and title attributes
setAlt(\$alt $alt)
Inherited
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.
| inherited_from |
\cHTML::setAlt() |
| inherited_from |
\cPage::setAlt() |
| inherited_from |
\cPageLeftTop::setAlt() |
| inherited_from |
\cPageLeftTopMultiPane::setAlt() |
Parameters
$alt
\$altstring Text to set as the "alt" attribute
setAttribte: Sets a specific attribute
setAttribute(\$sAttributeName $sAttributeName, \$sValue $sValue)
Inherited
| inherited_from |
\cHTML::setAttribute() |
| inherited_from |
\cPage::setAttribute() |
| inherited_from |
\cPageLeftTop::setAttribute() |
| inherited_from |
\cPageLeftTopMultiPane::setAttribute() |
Parameters
$sAttributeName
\$sAttributeNamestring Name of the attribute
$sValue
\$sValuestring Value of the attribute
sets the CSS class
setClass(\$class $class)
Inherited
| inherited_from |
\cHTML::setClass() |
| inherited_from |
\cPage::setClass() |
| inherited_from |
\cPageLeftTop::setClass() |
| inherited_from |
\cPageLeftTopMultiPane::setClass() |
Parameters
$class
\$classstring Text to set as the "alt" attribute
Sets the content for the page
setContent(\$content $content)
Inherited
| inherited_from |
\cPage::setContent() |
| inherited_from |
\cPageLeftTop::setContent() |
| inherited_from |
\cPageLeftTopMultiPane::setContent() |
Parameters
$content
\$contentmixed Object with a render method or a string containing the content
setContentlessTag()
setContentlessTag(\type $contentlessTag)
Inherited
| inherited_from |
\cHTML::setContentlessTag() |
| inherited_from |
\cPage::setContentlessTag() |
| inherited_from |
\cPageLeftTop::setContentlessTag() |
| inherited_from |
\cPageLeftTopMultiPane::setContentlessTag() |
Parameters
$contentlessTag
\type
setEncoding()
setEncoding($encoding)
Inherited
| inherited_from |
\cPage::setEncoding() |
| inherited_from |
\cPageLeftTop::setEncoding() |
| inherited_from |
\cPageLeftTopMultiPane::setEncoding() |
Parameters
$encoding
adds an "onXXX" javascript event handler
setEvent(\$event $event, \$action $action)
Inherited
example:
$item->setEvent("change","document.forms[0].submit");
| inherited_from |
\cHTML::setEvent() |
| inherited_from |
\cPage::setEvent() |
| inherited_from |
\cPageLeftTop::setEvent() |
| inherited_from |
\cPageLeftTopMultiPane::setEvent() |
Parameters
$event
\$eventstring Type of the event
$action
\$actionstring Function or action to call (JavaScript Code)
sets the ID class
setID(\$class $id)
Inherited
| inherited_from |
\cHTML::setID() |
| inherited_from |
\cPage::setID() |
| inherited_from |
\cPageLeftTop::setID() |
| inherited_from |
\cPageLeftTopMultiPane::setID() |
Parameters
$id
\$classstring Text to set as the "id"
set the margin width (pixels)
setMargin(\$margin $margin)
Inherited
| inherited_from |
\cPage::setMargin() |
| inherited_from |
\cPageLeftTop::setMargin() |
| inherited_from |
\cPageLeftTopMultiPane::setMargin() |
Parameters
$margin
\$marginint Margin width
setMarkScript()
setMarkScript($item)
Inherited
| inherited_from |
\cPage::setMarkScript() |
| inherited_from |
\cPageLeftTop::setMarkScript() |
| inherited_from |
\cPageLeftTopMultiPane::setMarkScript() |
Parameters
$item
adds the default script for a messagebox
setMessageBox()
Inherited
| inherited_from |
\cPage::setMessageBox() |
| inherited_from |
\cPageLeftTop::setMessageBox() |
| inherited_from |
\cPageLeftTopMultiPane::setMessageBox() |
adds the default script to reload the left pane (frame 2)
setReload($location)
Inherited
| inherited_from |
\cPage::setReload() |
| inherited_from |
\cPageLeftTop::setReload() |
| inherited_from |
\cPageLeftTopMultiPane::setReload() |
Parameters
sets the CSS style
setStyle(\$class $style)
Inherited
| inherited_from |
\cHTML::setStyle() |
| inherited_from |
\cPage::setStyle() |
| inherited_from |
\cPageLeftTop::setStyle() |
| inherited_from |
\cPageLeftTopMultiPane::setStyle() |
Parameters
$style
\$classstring Text to set as the "alt" attribute
addStyleDefinition
setStyleDefinition(\$entity $entity, \$definition $definition) : string
Inherited
| inherited_from |
\cHTML::setStyleDefinition() |
| inherited_from |
\cPage::setStyleDefinition() |
| inherited_from |
\cPageLeftTop::setStyleDefinition() |
| inherited_from |
\cPageLeftTopMultiPane::setStyleDefinition() |
Parameters
$entity
\$entitystring Entity to define
$definition
\$definitionstring Definition for the given entity
Returns
stringfilled SGML closing skeleton
sets the link to the subnavigation. Should be set on the first page only.
setSubnav(\$append $append, $marea)
Inherited
| inherited_from |
\cPage::setSubnav() |
| inherited_from |
\cPageLeftTop::setSubnav() |
| inherited_from |
\cPageLeftTopMultiPane::setSubnav() |
Parameters
$append
\$appendURL to append
$marea
set wether the closer should be shown.
showCloser(\$show $show)
Inherited
| inherited_from |
\cPageLeftTopMultiPane::showCloser() |
Parameters
$show
\$showboolean True if the closer should be shown (default)
Renders the output
If the tag
toHTML()
Inherited
| inherited_from |
\cHTML::toHTML() |
| inherited_from |
\cPage::toHTML() |
| inherited_from |
\cPageLeftTop::toHTML() |
| inherited_from |
\cPageLeftTopMultiPane::toHTML() |
removes an event handler
unsetEvent(\$event $event)
Inherited
example:
$item->unsetEvent("change");
| inherited_from |
\cHTML::unsetEvent() |
| inherited_from |
\cPage::unsetEvent() |
| inherited_from |
\cPageLeftTop::unsetEvent() |
| inherited_from |
\cPageLeftTopMultiPane::unsetEvent() |
Parameters
$event
\$eventstring Type of the event
Properties
Defines which JS events contain which scripts
$_aEventDefinitions
Inherited
| inherited_from |
\cHTML::$$_aEventDefinitions |
| inherited_from |
\cPage::$$_aEventDefinitions |
| inherited_from |
\cPageLeftTop::$$_aEventDefinitions |
| inherited_from |
\cPageLeftTopMultiPane::$$_aEventDefinitions |
Style definitions
$_aStyleDefinitions
Inherited
| inherited_from |
\cHTML::$$_aStyleDefinitions |
| inherited_from |
\cPage::$$_aStyleDefinitions |
| inherited_from |
\cPageLeftTop::$$_aStyleDefinitions |
| inherited_from |
\cPageLeftTopMultiPane::$$_aStyleDefinitions |
Storage of the page's content
$_content : string
Inherited
| access |
private |
| inherited_from |
\cPage::$$_content |
| inherited_from |
\cPageLeftTop::$$_content |
| inherited_from |
\cPageLeftTopMultiPane::$$_content |
Defines if the current tag is a contentless tag
$_contentlessTag : boolean
Inherited
| access |
private |
| inherited_from |
\cHTML::$$_contentlessTag |
| inherited_from |
\cPage::$$_contentlessTag |
| inherited_from |
\cPageLeftTop::$$_contentlessTag |
| inherited_from |
\cPageLeftTopMultiPane::$$_contentlessTag |
Storage of the desired encoding
$_encoding : string
Inherited
| access |
private |
| inherited_from |
\cPage::$$_encoding |
| inherited_from |
\cPageLeftTop::$$_encoding |
| inherited_from |
\cPageLeftTopMultiPane::$$_encoding |
Storage of the items
$_items : array
Inherited
| access |
private |
| inherited_from |
\cPageLeftTopMultiPane::$$_items |
Storage of the margin
$_margin : int
Inherited
| access |
private |
| inherited_from |
\cPage::$$_margin |
| inherited_from |
\cPageLeftTop::$$_margin |
| inherited_from |
\cPageLeftTopMultiPane::$$_margin |
Defines all scripts which are required by the current element
$_requiredScripts : array
Inherited
| access |
private |
| inherited_from |
\cHTML::$$_requiredScripts |
| inherited_from |
\cPage::$$_requiredScripts |
| inherited_from |
\cPageLeftTop::$$_requiredScripts |
| inherited_from |
\cPageLeftTopMultiPane::$$_requiredScripts |
Storage of scripts to be used on the page
$_scripts : array
Inherited
| access |
private |
| inherited_from |
\cPage::$$_scripts |
| inherited_from |
\cPageLeftTop::$$_scripts |
| inherited_from |
\cPageLeftTopMultiPane::$$_scripts |
Storage of the close SGML tag
$_skeleton_close : string
Inherited
| access |
private |
| inherited_from |
\cHTML::$$_skeleton_close |
| inherited_from |
\cPage::$$_skeleton_close |
| inherited_from |
\cPageLeftTop::$$_skeleton_close |
| inherited_from |
\cPageLeftTopMultiPane::$$_skeleton_close |
Storage of the open SGML tag template
$_skeleton_open : string
Inherited
| access |
private |
| inherited_from |
\cHTML::$$_skeleton_open |
| inherited_from |
\cPage::$$_skeleton_open |
| inherited_from |
\cPageLeftTop::$$_skeleton_open |
| inherited_from |
\cPageLeftTopMultiPane::$$_skeleton_open |
Storage of a single SGML tag template
$_skeleton_single : string
Inherited
| access |
private |
| inherited_from |
\cHTML::$$_skeleton_single |
| inherited_from |
\cPage::$$_skeleton_single |
| inherited_from |
\cPageLeftTop::$$_skeleton_single |
| inherited_from |
\cPageLeftTopMultiPane::$$_skeleton_single |
Defines the style definitions
$_styledefs : string
Inherited
| access |
private |
| inherited_from |
\cHTML::$$_styledefs |
| inherited_from |
\cPage::$$_styledefs |
| inherited_from |
\cPageLeftTop::$$_styledefs |
| inherited_from |
\cPageLeftTopMultiPane::$$_styledefs |
Storage of the sub navigation
$_subnav : string
Inherited
| access |
private |
| inherited_from |
\cPage::$$_subnav |
| inherited_from |
\cPageLeftTop::$$_subnav |
| inherited_from |
\cPageLeftTopMultiPane::$$_subnav |
Defines which tag to use
$_tag : string
Inherited
| access |
private |
| inherited_from |
\cHTML::$$_tag |
| inherited_from |
\cPage::$$_tag |
| inherited_from |
\cPageLeftTop::$$_tag |
| inherited_from |
\cPageLeftTopMultiPane::$$_tag |