Regular page
deprecated | This class was replaced by cGuiPage |
---|---|
author | Timo A. Hummel |
package | Core |
__construct(\obj $object) : void
deprecated | This class was replaced by cGuiPage |
---|---|
global | obj $auth |
global | string $lang |
\obj
__toString() : string
inherited_from | \cHTML::__toString() |
---|
string
Generated markupaddRequiredScript(string $script) : \cHTML
Anyway, scripts are not included twice.
inherited_from | \cHTML::addRequiredScript() |
---|
string
the script to include
\cHTML
$thisaddScript(string $name, string $script)
string
a name for internal usage
string
advanceID() : \cHTML
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() |
---|
\cHTML
$thisappendStyleDefinition(string $property, string $value) : \cHTML
Example usage: $element->appendStyleDefinition('margin', '5px');
inherited_from | \cHTML::appendStyleDefinition() |
---|
string
the property name, e.g. 'margin'
string
the value of the property, e.g. '5px'
\cHTML
$thisappendStyleDefinitions(array $styles) : \cHTML
Example usage: $element->appendStyleDefinitions(array( 'margin' => '5px', 'padding' => '0' ));
inherited_from | \cHTML::appendStyleDefinitions() |
---|
string
the styles to append
\cHTML
$thisattachEventDefinition(string $name, string $event, string $code) : \cHTML
Example to attach an onClick handler: attachEventDefinition('foo', 'onClick', 'alert("foo");');
inherited_from | \cHTML::attachEventDefinition() |
---|
string
Defines the name of the event
string
Defines the event (e.g. onClick)
string
Defines the code
\cHTML
$thisattachStyleDefinition(string $name, string $definition) : \cHTML
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() |
---|
string
Name for a style definition
string
Definition for the given entity
\cHTML
$thiscHTML()
inherited_from | \cHTML::cHTML() |
---|
cPage($object)
deprecated | [2011-08-31] Old constructor function for downwards compatibility |
---|---|
uses | \__construct() |
display()
inherited_from | \cHTML::display() |
---|
fillCloseSkeleton() : string
inherited_from | \cHTML::fillCloseSkeleton() |
---|
string
filled SGML closer skeletonfillSkeleton(string $attributes) : string
fillSkeleton fills the SGML opener tag with the specified attributes. Attributes need to be passed in the stringyfied variant.
inherited_from | \cHTML::fillSkeleton() |
---|
string
Attributes to set
string
filled SGML opener skeletongetAttribute(string $attributeName) : string
inherited_from | \cHTML::getAttribute() |
---|
string
Attribute name
string
null value or null if the attribute does not
existgetAttributes(bool $returnAsString) : array
inherited_from | \cHTML::getAttributes() |
---|
bool
Whether to return the attributes as string
array
stringgetID() : string
inherited_from | \cHTML::getID() |
---|
string
current IDremoveAttribute(string $attributeName) : \cHTML
inherited_from | \cHTML::removeAttribute() |
---|
string
Attribute name
\cHTML
$thisrender(bool $print) : string
global | cSession $sess |
---|---|
global | array $cfg |
bool
if true echo, if false print (default: true)
string
or nothing if printsetAlt(string $alt) : \cHTML
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() |
---|
string
Text to set as the "alt" and "title" attribute
\cHTML
$thissetAttribute(string $attributeName, string $value) : \cHTML
inherited_from | \cHTML::setAttribute() |
---|
string
Name of the attribute
string
Value of the attribute
\cHTML
$thissetAttributes(array $attributes) : \cHTML
inherited_from | \cHTML::setAttributes() |
---|
array
Associative array with attributes
\cHTML
$thissetClass(string $class) : \cHTML
inherited_from | \cHTML::setClass() |
---|
string
Text to set as the "class" attribute
\cHTML
$thissetContent(mixed $content) : void
mixed
Object with a render method or a string containing the content
setEncoding(string $encoding)
string
setEvent(string $event, string $action) : \cHTML
example: $item->setEvent('change','document.forms[0].submit');
inherited_from | \cHTML::setEvent() |
---|
string
Type of the event, e. g. "change" for "onchange"
string
Function or action to call (JavaScript Code)
\cHTML
$thissetExtra(string $extra)
string
setGenerateXHTML(bool $value)
inherited_from | \cHTML::setGenerateXHTML() |
---|
bool
setMargin(\type $margin)
\type
setMarkScript(string $item)
string
id of item
setMessageBoxScript()
deprecated | 2012-09-17 Use jQuery UI Dialog instead! |
---|
setReload(string $location)
string
default = false
setStyle(string $style) : \cHTML
inherited_from | \cHTML::setStyle() |
---|
string
Text to set as the "style" attribute
\cHTML
$thissetStyleDefinition(string $entity, string $definition) : \cHTML
inherited_from | \cHTML::setStyleDefinition() |
---|
string
Entity to define
string
Definition for the given entity
\cHTML
$thissetSubnav(string $append, string $marea)
Should be set on the first page only.
global | string $area |
---|
string
string
toHTML() : string
inherited_from | \cHTML::toHTML() |
---|
string
Generated markupunsetEvent(string $event) : \cHTML
example: $item->unsetEvent('change');
inherited_from | \cHTML::unsetEvent() |
---|
string
Type of the event
\cHTML
$thisupdateAttribute(string $name, string $value) : \cHTML
inherited_from | \cHTML::updateAttribute() |
---|
string
the name of the attribute
string
the value of the attribute with the given name
\cHTML
$thisupdateAttributes(array $attributes) : \cHTML
inherited_from | \cHTML::updateAttributes() |
---|
array
Associative array with attributes
\cHTML
$this_appendContent(string | object | array $content) : \cHTML
inherited_from | \cHTML::_appendContent() |
---|
string
object
array
String with the content or an object to render or an array of strings/objects.
\cHTML
$this_getAttrString(array $attributes) : string
inherited_from | \cHTML::_getAttrString() |
---|
array
Associative array with attributes
string
Attribute string in HTML format_parseAttributes(array $attributes) : array
inherited_from | \cHTML::_parseAttributes() |
---|
array
Associative array with attributes
array
the parsed attributes_setContent(string | object | array $content) : \cHTML
inherited_from | \cHTML::_setContent() |
---|
string
object
array
String with the content or a cHTML object to render or an array of strings / objects.
\cHTML
$this$_attributes : array
inherited_from | \cHTML::$$_attributes |
---|
$_content : string
inherited_from | \cHTML::$$_content |
---|
$_contentlessTag : bool
inherited_from | \cHTML::$$_contentlessTag |
---|
$_encoding : string
$_eventDefinitions : array
inherited_from | \cHTML::$$_eventDefinitions |
---|
$_generateXHTML : bool
inherited_from | \cHTML::$$_generateXHTML |
---|
$_idCounter : int
inherited_from | \cHTML::$$_idCounter |
---|
$_margin : int
$_requiredScripts : array
inherited_from | \cHTML::$$_requiredScripts |
---|
$_scripts : array
$_skeletonClose : string
inherited_from | \cHTML::$$_skeletonClose |
---|
$_skeletonOpen : string
inherited_from | \cHTML::$$_skeletonOpen |
---|
$_skeletonSingle : string
inherited_from | \cHTML::$$_skeletonSingle |
---|
$_styleDefinitions : array
inherited_from | \cHTML::$$_styleDefinitions |
---|
$_styleDefs : array
inherited_from | \cHTML::$$_styleDefs |
---|
$_tag : string
inherited_from | \cHTML::$$_tag |
---|
$extra : string