contenido\classes\widgets\class.widgets.datawidgets.php
\cDataCheckboxWidget
- Parent(s)
- \cHTMLCheckbox < \cHTMLFormElement < \cHTML < \HTML_Common
- Author
- Timo A. Hummel
Properties

$_aEventDefinitions- Type
- n/a
- Inherited_from
- \cHTML::$$_aEventDefinitions
- Inherited_from
- \cHTMLFormElement::$$_aEventDefinitions
- Inherited_from
- \cHTMLCheckbox::$$_aEventDefinitions

$_aStyleDefinitions- Type
- n/a
- Inherited_from
- \cHTML::$$_aStyleDefinitions
- Inherited_from
- \cHTMLFormElement::$$_aStyleDefinitions
- Inherited_from
- \cHTMLCheckbox::$$_aStyleDefinitions

$_content- Type
- n/a
- Inherited_from
- \cHTML::$$_content
- Inherited_from
- \cHTMLFormElement::$$_content
- Inherited_from
- \cHTMLCheckbox::$$_content

boolean $_contentlessTag- Type
- boolean
- Access
- private
- Inherited_from
- \cHTML::$$_contentlessTag
- Inherited_from
- \cHTMLFormElement::$$_contentlessTag
- Inherited_from
- \cHTMLCheckbox::$$_contentlessTag

array $_requiredScripts- Type
- array
- Access
- private
- Inherited_from
- \cHTML::$$_requiredScripts
- Inherited_from
- \cHTMLFormElement::$$_requiredScripts
- Inherited_from
- \cHTMLCheckbox::$$_requiredScripts

string $_skeleton_close- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_close
- Inherited_from
- \cHTMLFormElement::$$_skeleton_close
- Inherited_from
- \cHTMLCheckbox::$$_skeleton_close

string $_skeleton_open- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_open
- Inherited_from
- \cHTMLFormElement::$$_skeleton_open
- Inherited_from
- \cHTMLCheckbox::$$_skeleton_open

string $_skeleton_single- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_single
- Inherited_from
- \cHTMLFormElement::$$_skeleton_single
- Inherited_from
- \cHTMLCheckbox::$$_skeleton_single

string $_styledefs- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_styledefs
- Inherited_from
- \cHTMLFormElement::$$_styledefs
- Inherited_from
- \cHTMLCheckbox::$$_styledefs

string $_tag- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_tag
- Inherited_from
- \cHTMLFormElement::$$_tag
- Inherited_from
- \cHTMLCheckbox::$$_tag

$_value- Type
- n/a
- Inherited_from
- \cHTMLCheckbox::$$_value
Methods

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

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

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

advanceID() : voidadvances to the next ID available in the system.
Inherited from: \cHTML::advanceID()\cHTMLFormElement::advanceID()\cHTMLCheckbox::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) : voidattachEventDefinition: Attaches the code for an event
Inherited from: \cHTML::attachEventDefinition()\cHTMLFormElement::attachEventDefinition()\cHTMLCheckbox::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) : stringattachStyleDefinition: Attaches a style definition.
Inherited from: \cHTML::attachStyleDefinition()\cHTMLFormElement::attachStyleDefinition()\cHTMLCheckbox::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 |

cDataCheckboxWidget( $name, $parameters) : voidcDataCheckboxWidget: Creates a checkbox widget
| Name | Type | Description |
|---|---|---|
| $name | Name of the widget | |
| $parameters | Parameters (see below) valid parameters for this control are: title string Title of the checkbox label default string Checked or not checked |
- Access
- public

cHTML() : voidConstructor Function Initializes the SGML open/close tags
Inherited from: \cHTML::cHTML()\cHTMLFormElement::cHTML()\cHTMLCheckbox::cHTML()
cHTMLCheckbox( $name, $value, $id = "", $checked = false, $disabled = false, $tabindex = null, $accesskey = "") : \noneCreates an HTML checkbox element.
| Name | Type | Description |
|---|---|---|
| $name | string Name of the element | |
| $value | string Value of the radio button | |
| $id | string ID of the element | |
| $checked | boolean Is element checked? | |
| $disabled | string Item disabled flag (non-empty to set disabled) | |
| $tabindex | string Tab index for form elements | |
| $accesskey | string Key to access the field |
| Type | Description |
|---|---|
| \none |

cHTMLFormElement( $name = "", $id = "", $disabled = "", $tabindex = "", $accesskey = "") : \noneConstructor.
Inherited from: \cHTMLFormElement::cHTMLFormElement()\cHTMLCheckbox::cHTMLFormElement()This is a generic form element, where specific elements should be inherited from this class.
| Name | Type | Description |
|---|---|---|
| $name | string Name of the element | |
| $id | string ID of the element | |
| $disabled | string Item disabled flag (non-empty to set disabled) | |
| $tabindex | string Tab index for form elements | |
| $accesskey | string Key to access the field |
| Type | Description |
|---|---|
| \none |

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

fillSkeleton( $attributes) : stringfillSkeleton: Fills the open SGML tag skeleton
Inherited from: \cHTML::fillSkeleton()\cHTMLFormElement::fillSkeleton()\cHTMLCheckbox::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() : stringgetID: returns the current ID
Inherited from: \cHTML::getID()\cHTMLFormElement::getID()\cHTMLCheckbox::getID()| Type | Description |
|---|---|
| string | current ID |

setAccessKey( $accesskey) : \nonesets the access key for this element.
Inherited from: \cHTMLFormElement::setAccessKey()\cHTMLCheckbox::setAccessKey()| Name | Type | Description |
|---|---|---|
| $accesskey | string The length of the access key. May be A-Z and 0-9. |
| Type | Description |
|---|---|
| \none |

setAlt( $alt) : voidsetAlt: sets the alt and title attributes
Inherited from: \cHTML::setAlt()\cHTMLFormElement::setAlt()\cHTMLCheckbox::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) : voidsetAttribte: Sets a specific attribute
Inherited from: \cHTML::setAttribute()\cHTMLFormElement::setAttribute()\cHTMLCheckbox::setAttribute()| Name | Type | Description |
|---|---|---|
| $sAttributeName | string Name of the attribute | |
| $sValue | string Value of the attribute |

setChecked( $checked) : \none| Name | Type | Description |
|---|---|---|
| $checked | boolean If true, the "checked" attribute will be assigned. |
| Type | Description |
|---|---|
| \none |

setClass( $class) : voidsets the CSS class
Inherited from: \cHTML::setClass()\cHTMLFormElement::setClass()\cHTMLCheckbox::setClass()| Name | Type | Description |
|---|---|---|
| $class | string Text to set as the "alt" attribute |

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

setDisabled( $disabled) : \noneSets the "disabled" attribute of an element.
Inherited from: \cHTMLFormElement::setDisabled()\cHTMLCheckbox::setDisabled()User Agents usually are showing the element as "greyed-out".
Example: $obj->setDisabled("disabled"); $obj->setDisabled("");
The first example sets the disabled flag, the second one removes the disabled flag.
| Name | Type | Description |
|---|---|---|
| $disabled | string Sets the disabled-flag if non-empty |
| Type | Description |
|---|---|
| \none |

setEvent( $event, $action) : voidadds an "onXXX" javascript event handler
Inherited from: \cHTML::setEvent()\cHTMLFormElement::setEvent()\cHTMLCheckbox::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) : voidSetter for static $_generateXHTML property
Inherited from: \cHTML::setGenerateXHTML()\cHTMLFormElement::setGenerateXHTML()\cHTMLCheckbox::setGenerateXHTML()| Name | Type | Description |
|---|---|---|
| $value | bool |

setID( $id) : voidsets the ID class
Inherited from: \cHTML::setID()\cHTMLFormElement::setID()\cHTMLCheckbox::setID()| Name | Type | Description |
|---|---|---|
| $id |

setLabelText( $text) : \none| Name | Type | Description |
|---|---|---|
| $text | string Text to display |
| Type | Description |
|---|---|
| \none |

setStyle( $style) : voidsets the CSS style
Inherited from: \cHTML::setStyle()\cHTMLFormElement::setStyle()\cHTMLCheckbox::setStyle()| Name | Type | Description |
|---|---|---|
| $style |

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

setTabindex( $tabindex) : \nonesets the tab index for this element.
Inherited from: \cHTMLFormElement::setTabindex()\cHTMLCheckbox::setTabindex()The tab index needs to be numeric, bigger than 0 and smaller than 32767.
| Name | Type | Description |
|---|---|---|
| $tabindex | int desired tab index |
| Type | Description |
|---|---|
| \none |

toHTML() : voidRenders the output If the tag
Inherited from: \cHTML::toHTML()\cHTMLFormElement::toHTML()\cHTMLCheckbox::toHTML()
toHtml( $renderlabel = true) : stringNote:
If this element has an ID, the value (which equals the text displayed) will be rendered as seperate HTML label, if not, it will be displayed as regular text. Displaying the value can be turned off via the parameter.
| Name | Type | Description |
|---|---|---|
| $renderlabel | boolean If true, renders a label |
| Type | Description |
|---|---|
| string | Rendered HTML |

unsetEvent( $event) : voidremoves an event handler
Inherited from: \cHTML::unsetEvent()\cHTMLFormElement::unsetEvent()\cHTMLCheckbox::unsetEvent()example: $item->unsetEvent("change");
| Name | Type | Description |
|---|---|---|
| $event | string Type of the event |
\cDataCodeTextareaWidget
- Parent(s)
- \cHTMLTextarea < \cHTMLFormElement < \cHTML < \HTML_Common
- Author
- Timo A. Hummel
Properties

$_aEventDefinitions- Type
- n/a
- Inherited_from
- \cHTML::$$_aEventDefinitions
- Inherited_from
- \cHTMLFormElement::$$_aEventDefinitions
- Inherited_from
- \cHTMLTextarea::$$_aEventDefinitions

$_aStyleDefinitions- Type
- n/a
- Inherited_from
- \cHTML::$$_aStyleDefinitions
- Inherited_from
- \cHTMLFormElement::$$_aStyleDefinitions
- Inherited_from
- \cHTMLTextarea::$$_aStyleDefinitions

$_content- Type
- n/a
- Inherited_from
- \cHTML::$$_content
- Inherited_from
- \cHTMLFormElement::$$_content
- Inherited_from
- \cHTMLTextarea::$$_content

boolean $_contentlessTag- Type
- boolean
- Access
- private
- Inherited_from
- \cHTML::$$_contentlessTag
- Inherited_from
- \cHTMLFormElement::$$_contentlessTag
- Inherited_from
- \cHTMLTextarea::$$_contentlessTag

array $_requiredScripts- Type
- array
- Access
- private
- Inherited_from
- \cHTML::$$_requiredScripts
- Inherited_from
- \cHTMLFormElement::$$_requiredScripts
- Inherited_from
- \cHTMLTextarea::$$_requiredScripts

string $_skeleton_close- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_close
- Inherited_from
- \cHTMLFormElement::$$_skeleton_close
- Inherited_from
- \cHTMLTextarea::$$_skeleton_close

string $_skeleton_open- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_open
- Inherited_from
- \cHTMLFormElement::$$_skeleton_open
- Inherited_from
- \cHTMLTextarea::$$_skeleton_open

string $_skeleton_single- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_single
- Inherited_from
- \cHTMLFormElement::$$_skeleton_single
- Inherited_from
- \cHTMLTextarea::$$_skeleton_single

string $_styledefs- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_styledefs
- Inherited_from
- \cHTMLFormElement::$$_styledefs
- Inherited_from
- \cHTMLTextarea::$$_styledefs

string $_tag- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_tag
- Inherited_from
- \cHTMLFormElement::$$_tag
- Inherited_from
- \cHTMLTextarea::$$_tag

$_value- Type
- n/a
- Inherited_from
- \cHTMLTextarea::$$_value
Methods

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

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

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

advanceID() : voidadvances to the next ID available in the system.
Inherited from: \cHTML::advanceID()\cHTMLFormElement::advanceID()\cHTMLTextarea::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) : voidattachEventDefinition: Attaches the code for an event
Inherited from: \cHTML::attachEventDefinition()\cHTMLFormElement::attachEventDefinition()\cHTMLTextarea::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) : stringattachStyleDefinition: Attaches a style definition.
Inherited from: \cHTML::attachStyleDefinition()\cHTMLFormElement::attachStyleDefinition()\cHTMLTextarea::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 |

cDataCodeTextareaWidget( $name, $parameters) : voidcDataTextareaWidget: Creates a text area widget which can be used for entering code
| Name | Type | Description |
|---|---|---|
| $name | Name of the widget | |
| $parameters | Parameters (see below) valid parameters for this control are: default Default value for this area notes Notes for this area |
- Access
- public

cHTML() : voidConstructor Function Initializes the SGML open/close tags
Inherited from: \cHTML::cHTML()\cHTMLFormElement::cHTML()\cHTMLTextarea::cHTML()
cHTMLFormElement( $name = "", $id = "", $disabled = "", $tabindex = "", $accesskey = "") : \noneConstructor.
Inherited from: \cHTMLFormElement::cHTMLFormElement()\cHTMLTextarea::cHTMLFormElement()This is a generic form element, where specific elements should be inherited from this class.
| Name | Type | Description |
|---|---|---|
| $name | string Name of the element | |
| $id | string ID of the element | |
| $disabled | string Item disabled flag (non-empty to set disabled) | |
| $tabindex | string Tab index for form elements | |
| $accesskey | string Key to access the field |
| Type | Description |
|---|---|
| \none |

cHTMLTextarea( $name, $initvalue = "", $width = "", $height = "", $id = "", $disabled = false, $tabindex = null, $accesskey = "") : \noneCreates an HTML text area.
If no additional parameters are specified, the default width is 60 chars, and the height is 5 chars.
| Name | Type | Description |
|---|---|---|
| $name | string Name of the element | |
| $initvalue | string Initial value of the textarea | |
| $width | int width of the textarea | |
| $height | int height of the textarea | |
| $id | string ID of the element | |
| $disabled | string Item disabled flag (non-empty to set disabled) | |
| $tabindex | string Tab index for form elements | |
| $accesskey | string Key to access the field |
| Type | Description |
|---|---|
| \none |

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

fillSkeleton( $attributes) : stringfillSkeleton: Fills the open SGML tag skeleton
Inherited from: \cHTML::fillSkeleton()\cHTMLFormElement::fillSkeleton()\cHTMLTextarea::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() : stringgetID: returns the current ID
Inherited from: \cHTML::getID()\cHTMLFormElement::getID()\cHTMLTextarea::getID()| Type | Description |
|---|---|
| string | current ID |

setAccessKey( $accesskey) : \nonesets the access key for this element.
Inherited from: \cHTMLFormElement::setAccessKey()\cHTMLTextarea::setAccessKey()| Name | Type | Description |
|---|---|---|
| $accesskey | string The length of the access key. May be A-Z and 0-9. |
| Type | Description |
|---|---|
| \none |

setAlt( $alt) : voidsetAlt: sets the alt and title attributes
Inherited from: \cHTML::setAlt()\cHTMLFormElement::setAlt()\cHTMLTextarea::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) : voidsetAttribte: Sets a specific attribute
Inherited from: \cHTML::setAttribute()\cHTMLFormElement::setAttribute()\cHTMLTextarea::setAttribute()| Name | Type | Description |
|---|---|---|
| $sAttributeName | string Name of the attribute | |
| $sValue | string Value of the attribute |

setClass( $class) : voidsets the CSS class
Inherited from: \cHTML::setClass()\cHTMLFormElement::setClass()\cHTMLTextarea::setClass()| Name | Type | Description |
|---|---|---|
| $class | string Text to set as the "alt" attribute |

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

setDisabled( $disabled) : \noneSets the "disabled" attribute of an element.
Inherited from: \cHTMLFormElement::setDisabled()\cHTMLTextarea::setDisabled()User Agents usually are showing the element as "greyed-out".
Example: $obj->setDisabled("disabled"); $obj->setDisabled("");
The first example sets the disabled flag, the second one removes the disabled flag.
| Name | Type | Description |
|---|---|---|
| $disabled | string Sets the disabled-flag if non-empty |
| Type | Description |
|---|---|
| \none |

setEvent( $event, $action) : voidadds an "onXXX" javascript event handler
Inherited from: \cHTML::setEvent()\cHTMLFormElement::setEvent()\cHTMLTextarea::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) : voidSetter for static $_generateXHTML property
Inherited from: \cHTML::setGenerateXHTML()\cHTMLFormElement::setGenerateXHTML()\cHTMLTextarea::setGenerateXHTML()| Name | Type | Description |
|---|---|---|
| $value | bool |

setID( $id) : voidsets the ID class
Inherited from: \cHTML::setID()\cHTMLFormElement::setID()\cHTMLTextarea::setID()| Name | Type | Description |
|---|---|---|
| $id |

setStyle( $style) : voidsets the CSS style
Inherited from: \cHTML::setStyle()\cHTMLFormElement::setStyle()\cHTMLTextarea::setStyle()| Name | Type | Description |
|---|---|---|
| $style |

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

setTabindex( $tabindex) : \nonesets the tab index for this element.
Inherited from: \cHTMLFormElement::setTabindex()\cHTMLTextarea::setTabindex()The tab index needs to be numeric, bigger than 0 and smaller than 32767.
| Name | Type | Description |
|---|---|---|
| $tabindex | int desired tab index |
| Type | Description |
|---|---|
| \none |

setValue( $value) : \none| Name | Type | Description |
|---|---|---|
| $value | string Initial value |
| Type | Description |
|---|---|
| \none |

setWidth( $width) : \none| Name | Type | Description |
|---|---|---|
| $width | int width of the text box |
| Type | Description |
|---|---|
| \none |

toHTML() : voidRenders the output If the tag
Inherited from: \cHTML::toHTML()\cHTMLFormElement::toHTML()\cHTMLTextarea::toHTML()
unsetEvent( $event) : voidremoves an event handler
Inherited from: \cHTML::unsetEvent()\cHTMLFormElement::unsetEvent()\cHTMLTextarea::unsetEvent()example: $item->unsetEvent("change");
| Name | Type | Description |
|---|---|---|
| $event | string Type of the event |
\cDataDropdownWidget
- Parent(s)
- \cHTMLSelectElement < \cHTMLFormElement < \cHTML < \HTML_Common
- Author
- Timo A. Hummel
Properties

$_aEventDefinitions- Type
- n/a
- Inherited_from
- \cHTML::$$_aEventDefinitions
- Inherited_from
- \cHTMLFormElement::$$_aEventDefinitions
- Inherited_from
- \cHTMLSelectElement::$$_aEventDefinitions

$_aStyleDefinitions- Type
- n/a
- Inherited_from
- \cHTML::$$_aStyleDefinitions
- Inherited_from
- \cHTMLFormElement::$$_aStyleDefinitions
- Inherited_from
- \cHTMLSelectElement::$$_aStyleDefinitions

$_content- Type
- n/a
- Inherited_from
- \cHTML::$$_content
- Inherited_from
- \cHTMLFormElement::$$_content
- Inherited_from
- \cHTMLSelectElement::$$_content

boolean $_contentlessTag- Type
- boolean
- Access
- private
- Inherited_from
- \cHTML::$$_contentlessTag
- Inherited_from
- \cHTMLFormElement::$$_contentlessTag
- Inherited_from
- \cHTMLSelectElement::$$_contentlessTag

array $_requiredScripts- Type
- array
- Access
- private
- Inherited_from
- \cHTML::$$_requiredScripts
- Inherited_from
- \cHTMLFormElement::$$_requiredScripts
- Inherited_from
- \cHTMLSelectElement::$$_requiredScripts

string $_skeleton_close- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_close
- Inherited_from
- \cHTMLFormElement::$$_skeleton_close
- Inherited_from
- \cHTMLSelectElement::$$_skeleton_close

string $_skeleton_open- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_open
- Inherited_from
- \cHTMLFormElement::$$_skeleton_open
- Inherited_from
- \cHTMLSelectElement::$$_skeleton_open

string $_skeleton_single- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_single
- Inherited_from
- \cHTMLFormElement::$$_skeleton_single
- Inherited_from
- \cHTMLSelectElement::$$_skeleton_single

string $_styledefs- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_styledefs
- Inherited_from
- \cHTMLFormElement::$$_styledefs
- Inherited_from
- \cHTMLSelectElement::$$_styledefs

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

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

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

addOptionElement( $index, $element) : \noneAdds an cHTMLOptionElement to the number of choices.
Inherited from: \cHTMLSelectElement::addOptionElement()| Name | Type | Description |
|---|---|---|
| $index | string Index of the element | |
| $element | object Filled cHTMLOptionElement to add |
| Type | Description |
|---|---|
| \none |

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

advanceID() : voidadvances to the next ID available in the system.
Inherited from: \cHTML::advanceID()\cHTMLFormElement::advanceID()\cHTMLSelectElement::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) : voidattachEventDefinition: Attaches the code for an event
Inherited from: \cHTML::attachEventDefinition()\cHTMLFormElement::attachEventDefinition()\cHTMLSelectElement::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) : stringattachStyleDefinition: Attaches a style definition.
Inherited from: \cHTML::attachStyleDefinition()\cHTMLFormElement::attachStyleDefinition()\cHTMLSelectElement::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 |

autoFill( $stuff) : \noneAutomatically creates and fills cHTMLOptionElements
Inherited from: \cHTMLSelectElement::autoFill()Array format: $stuff = array( array("value","title"), array("value","title"));
or regular key => value arrays.
| Name | Type | Description |
|---|---|---|
| $stuff | array Array with all items |
| Type | Description |
|---|---|
| \none |

cDataDropdownWidget( $name, $parameters) : voidcDataDropdownWidget: Creates a dropdown widget with specific entries
| Name | Type | Description |
|---|---|---|
| $name | Name of the widget | |
| $parameters | Parameters (see below) valid parameters for this control are: default string Default value which will be selected choices array Values for filling the dropdown |
- Access
- public

cHTML() : voidConstructor Function Initializes the SGML open/close tags
Inherited from: \cHTML::cHTML()\cHTMLFormElement::cHTML()\cHTMLSelectElement::cHTML()
cHTMLFormElement( $name = "", $id = "", $disabled = "", $tabindex = "", $accesskey = "") : \noneConstructor.
Inherited from: \cHTMLFormElement::cHTMLFormElement()\cHTMLSelectElement::cHTMLFormElement()This is a generic form element, where specific elements should be inherited from this class.
| Name | Type | Description |
|---|---|---|
| $name | string Name of the element | |
| $id | string ID of the element | |
| $disabled | string Item disabled flag (non-empty to set disabled) | |
| $tabindex | string Tab index for form elements | |
| $accesskey | string Key to access the field |
| Type | Description |
|---|---|
| \none |

cHTMLSelectElement( $name, $width = "", $id = "", $disabled = false, $tabindex = null, $accesskey = "") : \noneCreates an HTML select field (aka "DropDown").
| Name | Type | Description |
|---|---|---|
| $name | string Name of the element | |
| $width | int width of the select element | |
| $id | string ID of the element | |
| $disabled | string Item disabled flag (non-empty to set disabled) | |
| $tabindex | string Tab index for form elements | |
| $accesskey | string Key to access the field |
| Type | Description |
|---|---|
| \none |

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

fillSkeleton( $attributes) : stringfillSkeleton: Fills the open SGML tag skeleton
Inherited from: \cHTML::fillSkeleton()\cHTMLFormElement::fillSkeleton()\cHTMLSelectElement::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() : stringgetID: returns the current ID
Inherited from: \cHTML::getID()\cHTMLFormElement::getID()\cHTMLSelectElement::getID()| Type | Description |
|---|---|
| string | current ID |

render() : stringrender(): Alias for toHtml
Inherited from: \cHTML::render()\cHTMLFormElement::render()\cHTMLSelectElement::render()| Type | Description |
|---|---|
| string | Rendered HTML |

setAccessKey( $accesskey) : \nonesets the access key for this element.
Inherited from: \cHTMLFormElement::setAccessKey()\cHTMLSelectElement::setAccessKey()| Name | Type | Description |
|---|---|---|
| $accesskey | string The length of the access key. May be A-Z and 0-9. |
| Type | Description |
|---|---|
| \none |

setAlt( $alt) : voidsetAlt: sets the alt and title attributes
Inherited from: \cHTML::setAlt()\cHTMLFormElement::setAlt()\cHTMLSelectElement::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) : voidsetAttribte: Sets a specific attribute
Inherited from: \cHTML::setAttribute()\cHTMLFormElement::setAttribute()\cHTMLSelectElement::setAttribute()| Name | Type | Description |
|---|---|---|
| $sAttributeName | string Name of the attribute | |
| $sValue | string Value of the attribute |

setClass( $class) : voidsets the CSS class
Inherited from: \cHTML::setClass()\cHTMLFormElement::setClass()\cHTMLSelectElement::setClass()| Name | Type | Description |
|---|---|---|
| $class | string Text to set as the "alt" attribute |

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

setDefault( $lvalue) : \noneSets a specific cHTMLOptionElement to the selected state.
Inherited from: \cHTMLSelectElement::setDefault()| Name | Type | Description |
|---|---|---|
| $lvalue | string Specifies the "value" of the cHTMLOptionElement to set |
| Type | Description |
|---|---|
| \none |

setDisabled( $disabled) : \noneSets the "disabled" attribute of an element.
Inherited from: \cHTMLFormElement::setDisabled()\cHTMLSelectElement::setDisabled()User Agents usually are showing the element as "greyed-out".
Example: $obj->setDisabled("disabled"); $obj->setDisabled("");
The first example sets the disabled flag, the second one removes the disabled flag.
| Name | Type | Description |
|---|---|---|
| $disabled | string Sets the disabled-flag if non-empty |
| Type | Description |
|---|---|
| \none |

setEvent( $event, $action) : voidadds an "onXXX" javascript event handler
Inherited from: \cHTML::setEvent()\cHTMLFormElement::setEvent()\cHTMLSelectElement::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) : voidSetter for static $_generateXHTML property
Inherited from: \cHTML::setGenerateXHTML()\cHTMLFormElement::setGenerateXHTML()\cHTMLSelectElement::setGenerateXHTML()| Name | Type | Description |
|---|---|---|
| $value | bool |

setID( $id) : voidsets the ID class
Inherited from: \cHTML::setID()\cHTMLFormElement::setID()\cHTMLSelectElement::setID()| Name | Type | Description |
|---|---|---|
| $id |

setSelected(array $aElements) : \noneSets specified elements as selected (and all others as unselected)
Inherited from: \cHTMLSelectElement::setSelected()| Name | Type | Description |
|---|---|---|
| $aElements | array | Array with "values" of the cHTMLOptionElement to set |
| Type | Description |
|---|---|
| \none |

setSize( $size) : void| Name | Type | Description |
|---|---|---|
| $size |

setStyle( $style) : voidsets the CSS style
Inherited from: \cHTML::setStyle()\cHTMLFormElement::setStyle()\cHTMLSelectElement::setStyle()| Name | Type | Description |
|---|---|---|
| $style |

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

setTabindex( $tabindex) : \nonesets the tab index for this element.
Inherited from: \cHTMLFormElement::setTabindex()\cHTMLSelectElement::setTabindex()The tab index needs to be numeric, bigger than 0 and smaller than 32767.
| Name | Type | Description |
|---|---|---|
| $tabindex | int desired tab index |
| Type | Description |
|---|---|
| \none |

toHTML() : voidRenders the output If the tag
Inherited from: \cHTML::toHTML()\cHTMLFormElement::toHTML()\cHTMLSelectElement::toHTML()
unsetEvent( $event) : voidremoves an event handler
Inherited from: \cHTML::unsetEvent()\cHTMLFormElement::unsetEvent()\cHTMLSelectElement::unsetEvent()example: $item->unsetEvent("change");
| Name | Type | Description |
|---|---|---|
| $event | string Type of the event |
\cDataForeignTableDropdownWidget
- Parent(s)
- \cHTMLSelectElement < \cHTMLFormElement < \cHTML < \HTML_Common
- Author
- Timo A. Hummel
Properties

$_aEventDefinitions- Type
- n/a
- Inherited_from
- \cHTML::$$_aEventDefinitions
- Inherited_from
- \cHTMLFormElement::$$_aEventDefinitions
- Inherited_from
- \cHTMLSelectElement::$$_aEventDefinitions

$_aStyleDefinitions- Type
- n/a
- Inherited_from
- \cHTML::$$_aStyleDefinitions
- Inherited_from
- \cHTMLFormElement::$$_aStyleDefinitions
- Inherited_from
- \cHTMLSelectElement::$$_aStyleDefinitions

$_content- Type
- n/a
- Inherited_from
- \cHTML::$$_content
- Inherited_from
- \cHTMLFormElement::$$_content
- Inherited_from
- \cHTMLSelectElement::$$_content

boolean $_contentlessTag- Type
- boolean
- Access
- private
- Inherited_from
- \cHTML::$$_contentlessTag
- Inherited_from
- \cHTMLFormElement::$$_contentlessTag
- Inherited_from
- \cHTMLSelectElement::$$_contentlessTag

array $_requiredScripts- Type
- array
- Access
- private
- Inherited_from
- \cHTML::$$_requiredScripts
- Inherited_from
- \cHTMLFormElement::$$_requiredScripts
- Inherited_from
- \cHTMLSelectElement::$$_requiredScripts

string $_skeleton_close- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_close
- Inherited_from
- \cHTMLFormElement::$$_skeleton_close
- Inherited_from
- \cHTMLSelectElement::$$_skeleton_close

string $_skeleton_open- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_open
- Inherited_from
- \cHTMLFormElement::$$_skeleton_open
- Inherited_from
- \cHTMLSelectElement::$$_skeleton_open

string $_skeleton_single- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_single
- Inherited_from
- \cHTMLFormElement::$$_skeleton_single
- Inherited_from
- \cHTMLSelectElement::$$_skeleton_single

string $_styledefs- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_styledefs
- Inherited_from
- \cHTMLFormElement::$$_styledefs
- Inherited_from
- \cHTMLSelectElement::$$_styledefs

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

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

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

addOptionElement( $index, $element) : \noneAdds an cHTMLOptionElement to the number of choices.
Inherited from: \cHTMLSelectElement::addOptionElement()| Name | Type | Description |
|---|---|---|
| $index | string Index of the element | |
| $element | object Filled cHTMLOptionElement to add |
| Type | Description |
|---|---|
| \none |

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

advanceID() : voidadvances to the next ID available in the system.
Inherited from: \cHTML::advanceID()\cHTMLFormElement::advanceID()\cHTMLSelectElement::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) : voidattachEventDefinition: Attaches the code for an event
Inherited from: \cHTML::attachEventDefinition()\cHTMLFormElement::attachEventDefinition()\cHTMLSelectElement::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) : stringattachStyleDefinition: Attaches a style definition.
Inherited from: \cHTML::attachStyleDefinition()\cHTMLFormElement::attachStyleDefinition()\cHTMLSelectElement::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 |

autoFill( $stuff) : \noneAutomatically creates and fills cHTMLOptionElements
Inherited from: \cHTMLSelectElement::autoFill()Array format: $stuff = array( array("value","title"), array("value","title"));
or regular key => value arrays.
| Name | Type | Description |
|---|---|---|
| $stuff | array Array with all items |
| Type | Description |
|---|---|
| \none |

cDataForeignTableDropdownWidget( $name, $parameters) : voidcDataForeignTableDropdownWidget: Creates a dropdown widget which fetches its entries from a foreign, linked table
| Name | Type | Description |
|---|---|---|
| $name | Name of the widget | |
| $parameters | Parameters (see below) valid parameters for this control are: foreignClass string Class name of the foreign class default string Default value which will be selected |
- Access
- public

cHTML() : voidConstructor Function Initializes the SGML open/close tags
Inherited from: \cHTML::cHTML()\cHTMLFormElement::cHTML()\cHTMLSelectElement::cHTML()
cHTMLFormElement( $name = "", $id = "", $disabled = "", $tabindex = "", $accesskey = "") : \noneConstructor.
Inherited from: \cHTMLFormElement::cHTMLFormElement()\cHTMLSelectElement::cHTMLFormElement()This is a generic form element, where specific elements should be inherited from this class.
| Name | Type | Description |
|---|---|---|
| $name | string Name of the element | |
| $id | string ID of the element | |
| $disabled | string Item disabled flag (non-empty to set disabled) | |
| $tabindex | string Tab index for form elements | |
| $accesskey | string Key to access the field |
| Type | Description |
|---|---|
| \none |

cHTMLSelectElement( $name, $width = "", $id = "", $disabled = false, $tabindex = null, $accesskey = "") : \noneCreates an HTML select field (aka "DropDown").
| Name | Type | Description |
|---|---|---|
| $name | string Name of the element | |
| $width | int width of the select element | |
| $id | string ID of the element | |
| $disabled | string Item disabled flag (non-empty to set disabled) | |
| $tabindex | string Tab index for form elements | |
| $accesskey | string Key to access the field |
| Type | Description |
|---|---|
| \none |

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

fillSkeleton( $attributes) : stringfillSkeleton: Fills the open SGML tag skeleton
Inherited from: \cHTML::fillSkeleton()\cHTMLFormElement::fillSkeleton()\cHTMLSelectElement::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() : stringgetID: returns the current ID
Inherited from: \cHTML::getID()\cHTMLFormElement::getID()\cHTMLSelectElement::getID()| Type | Description |
|---|---|
| string | current ID |

render() : stringrender(): Alias for toHtml
Inherited from: \cHTML::render()\cHTMLFormElement::render()\cHTMLSelectElement::render()| Type | Description |
|---|---|
| string | Rendered HTML |

setAccessKey( $accesskey) : \nonesets the access key for this element.
Inherited from: \cHTMLFormElement::setAccessKey()\cHTMLSelectElement::setAccessKey()| Name | Type | Description |
|---|---|---|
| $accesskey | string The length of the access key. May be A-Z and 0-9. |
| Type | Description |
|---|---|
| \none |

setAlt( $alt) : voidsetAlt: sets the alt and title attributes
Inherited from: \cHTML::setAlt()\cHTMLFormElement::setAlt()\cHTMLSelectElement::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) : voidsetAttribte: Sets a specific attribute
Inherited from: \cHTML::setAttribute()\cHTMLFormElement::setAttribute()\cHTMLSelectElement::setAttribute()| Name | Type | Description |
|---|---|---|
| $sAttributeName | string Name of the attribute | |
| $sValue | string Value of the attribute |

setClass( $class) : voidsets the CSS class
Inherited from: \cHTML::setClass()\cHTMLFormElement::setClass()\cHTMLSelectElement::setClass()| Name | Type | Description |
|---|---|---|
| $class | string Text to set as the "alt" attribute |

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

setDefault( $lvalue) : \noneSets a specific cHTMLOptionElement to the selected state.
Inherited from: \cHTMLSelectElement::setDefault()| Name | Type | Description |
|---|---|---|
| $lvalue | string Specifies the "value" of the cHTMLOptionElement to set |
| Type | Description |
|---|---|
| \none |

setDisabled( $disabled) : \noneSets the "disabled" attribute of an element.
Inherited from: \cHTMLFormElement::setDisabled()\cHTMLSelectElement::setDisabled()User Agents usually are showing the element as "greyed-out".
Example: $obj->setDisabled("disabled"); $obj->setDisabled("");
The first example sets the disabled flag, the second one removes the disabled flag.
| Name | Type | Description |
|---|---|---|
| $disabled | string Sets the disabled-flag if non-empty |
| Type | Description |
|---|---|
| \none |

setEvent( $event, $action) : voidadds an "onXXX" javascript event handler
Inherited from: \cHTML::setEvent()\cHTMLFormElement::setEvent()\cHTMLSelectElement::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) : voidSetter for static $_generateXHTML property
Inherited from: \cHTML::setGenerateXHTML()\cHTMLFormElement::setGenerateXHTML()\cHTMLSelectElement::setGenerateXHTML()| Name | Type | Description |
|---|---|---|
| $value | bool |

setID( $id) : voidsets the ID class
Inherited from: \cHTML::setID()\cHTMLFormElement::setID()\cHTMLSelectElement::setID()| Name | Type | Description |
|---|---|---|
| $id |

setSelected(array $aElements) : \noneSets specified elements as selected (and all others as unselected)
Inherited from: \cHTMLSelectElement::setSelected()| Name | Type | Description |
|---|---|---|
| $aElements | array | Array with "values" of the cHTMLOptionElement to set |
| Type | Description |
|---|---|
| \none |

setSize( $size) : void| Name | Type | Description |
|---|---|---|
| $size |

setStyle( $style) : voidsets the CSS style
Inherited from: \cHTML::setStyle()\cHTMLFormElement::setStyle()\cHTMLSelectElement::setStyle()| Name | Type | Description |
|---|---|---|
| $style |

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

setTabindex( $tabindex) : \nonesets the tab index for this element.
Inherited from: \cHTMLFormElement::setTabindex()\cHTMLSelectElement::setTabindex()The tab index needs to be numeric, bigger than 0 and smaller than 32767.
| Name | Type | Description |
|---|---|---|
| $tabindex | int desired tab index |
| Type | Description |
|---|---|
| \none |

toHTML() : voidRenders the output If the tag
Inherited from: \cHTML::toHTML()\cHTMLFormElement::toHTML()\cHTMLSelectElement::toHTML()
unsetEvent( $event) : voidremoves an event handler
Inherited from: \cHTML::unsetEvent()\cHTMLFormElement::unsetEvent()\cHTMLSelectElement::unsetEvent()example: $item->unsetEvent("change");
| Name | Type | Description |
|---|---|---|
| $event | string Type of the event |
\cDataMultiTextboxWidget
- Parent(s)
- \cHTMLTable < \cHTML < \HTML_Common
- Author
- Timo A. Hummel
Properties

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

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

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

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

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

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

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

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

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

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

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

advanceID() : voidadvances to the next ID available in the system.
Inherited from: \cHTML::advanceID()\cHTMLTable::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) : voidattachEventDefinition: Attaches the code for an event
Inherited from: \cHTML::attachEventDefinition()\cHTMLTable::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) : stringattachStyleDefinition: Attaches a style definition.
Inherited from: \cHTML::attachStyleDefinition()\cHTMLTable::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 |

cDataMultiTextboxWidget( $name, $parameters) : voidcDataMultiTextboxWidget: Creates a multi-line textbox widget
| Name | Type | Description |
|---|---|---|
| $name | Name of the widget | |
| $parameters | Parameters (see below) valid parameters for this control are: title string Title of the multi-line textbox widget default array Values (=lines) to fill |
- Access
- public

cHTML() : voidConstructor Function Initializes the SGML open/close tags
Inherited from: \cHTML::cHTML()\cHTMLTable::cHTML()
fillCloseSkeleton() : stringfillCloseSkeleton: Fills the close skeleton
Inherited from: \cHTML::fillCloseSkeleton()\cHTMLTable::fillCloseSkeleton()| Type | Description |
|---|---|
| string | filled SGML closer skeleton |

fillSkeleton( $attributes) : stringfillSkeleton: Fills the open SGML tag skeleton
Inherited from: \cHTML::fillSkeleton()\cHTMLTable::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 |

setAlt( $alt) : voidsetAlt: sets the alt and title attributes
Inherited from: \cHTML::setAlt()\cHTMLTable::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) : voidsetAttribte: Sets a specific attribute
Inherited from: \cHTML::setAttribute()\cHTMLTable::setAttribute()| Name | Type | Description |
|---|---|---|
| $sAttributeName | string Name of the attribute | |
| $sValue | string Value of the attribute |

setCellPadding( $cellpadding) : voidsetCellPadding: Sets the padding between cells
Inherited from: \cHTMLTable::setCellPadding()| Name | Type | Description |
|---|---|---|
| $cellpadding | Padding |

setCellSpacing( $cellspacing) : voidsetCellSpacing: Sets the spacing between cells
Inherited from: \cHTMLTable::setCellSpacing()| Name | Type | Description |
|---|---|---|
| $cellspacing | Spacing |

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

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

setEvent( $event, $action) : voidadds an "onXXX" javascript event handler
Inherited from: \cHTML::setEvent()\cHTMLTable::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) : voidSetter for static $_generateXHTML property
Inherited from: \cHTML::setGenerateXHTML()\cHTMLTable::setGenerateXHTML()| Name | Type | Description |
|---|---|---|
| $value | bool |

setPadding( $cellpadding) : void| Name | Type | Description |
|---|---|---|
| $cellpadding |

setSpacing( $cellspacing) : void| Name | Type | Description |
|---|---|---|
| $cellspacing |

setStyleDefinition( $entity, $definition) : stringaddStyleDefinition
Inherited from: \cHTML::setStyleDefinition()\cHTMLTable::setStyleDefinition()| Name | Type | Description |
|---|---|---|
| $entity | string Entity to define | |
| $definition | string Definition for the given entity |
| Type | Description |
|---|---|
| string | filled SGML closing skeleton |
\cDataTextWidget
- Parent(s)
- \cHTMLTextbox < \cHTMLFormElement < \cHTML < \HTML_Common
- Author
- Timo A. Hummel
Properties

$_aEventDefinitions- Type
- n/a
- Inherited_from
- \cHTML::$$_aEventDefinitions
- Inherited_from
- \cHTMLFormElement::$$_aEventDefinitions
- Inherited_from
- \cHTMLTextbox::$$_aEventDefinitions

$_aStyleDefinitions- Type
- n/a
- Inherited_from
- \cHTML::$$_aStyleDefinitions
- Inherited_from
- \cHTMLFormElement::$$_aStyleDefinitions
- Inherited_from
- \cHTMLTextbox::$$_aStyleDefinitions

$_content- Type
- n/a
- Inherited_from
- \cHTML::$$_content
- Inherited_from
- \cHTMLFormElement::$$_content
- Inherited_from
- \cHTMLTextbox::$$_content

boolean $_contentlessTag- Type
- boolean
- Access
- private
- Inherited_from
- \cHTML::$$_contentlessTag
- Inherited_from
- \cHTMLFormElement::$$_contentlessTag
- Inherited_from
- \cHTMLTextbox::$$_contentlessTag

array $_requiredScripts- Type
- array
- Access
- private
- Inherited_from
- \cHTML::$$_requiredScripts
- Inherited_from
- \cHTMLFormElement::$$_requiredScripts
- Inherited_from
- \cHTMLTextbox::$$_requiredScripts

string $_skeleton_close- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_close
- Inherited_from
- \cHTMLFormElement::$$_skeleton_close
- Inherited_from
- \cHTMLTextbox::$$_skeleton_close

string $_skeleton_open- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_open
- Inherited_from
- \cHTMLFormElement::$$_skeleton_open
- Inherited_from
- \cHTMLTextbox::$$_skeleton_open

string $_skeleton_single- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_single
- Inherited_from
- \cHTMLFormElement::$$_skeleton_single
- Inherited_from
- \cHTMLTextbox::$$_skeleton_single

string $_styledefs- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_styledefs
- Inherited_from
- \cHTMLFormElement::$$_styledefs
- Inherited_from
- \cHTMLTextbox::$$_styledefs

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

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

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

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

advanceID() : voidadvances to the next ID available in the system.
Inherited from: \cHTML::advanceID()\cHTMLFormElement::advanceID()\cHTMLTextbox::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) : voidattachEventDefinition: Attaches the code for an event
Inherited from: \cHTML::attachEventDefinition()\cHTMLFormElement::attachEventDefinition()\cHTMLTextbox::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) : stringattachStyleDefinition: Attaches a style definition.
Inherited from: \cHTML::attachStyleDefinition()\cHTMLFormElement::attachStyleDefinition()\cHTMLTextbox::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 |

cDataTextWidget( $name, $parameters) : voidcDataTextWidget: Creates a text box widget
| Name | Type | Description |
|---|---|---|
| $name | Name of the widget | |
| $parameters | Parameters (see below) valid parameters for this control are: default Default value for this box |
- Access
- public

cHTML() : voidConstructor Function Initializes the SGML open/close tags
Inherited from: \cHTML::cHTML()\cHTMLFormElement::cHTML()\cHTMLTextbox::cHTML()
cHTMLFormElement( $name = "", $id = "", $disabled = "", $tabindex = "", $accesskey = "") : \noneConstructor.
Inherited from: \cHTMLFormElement::cHTMLFormElement()\cHTMLTextbox::cHTMLFormElement()This is a generic form element, where specific elements should be inherited from this class.
| Name | Type | Description |
|---|---|---|
| $name | string Name of the element | |
| $id | string ID of the element | |
| $disabled | string Item disabled flag (non-empty to set disabled) | |
| $tabindex | string Tab index for form elements | |
| $accesskey | string Key to access the field |
| Type | Description |
|---|---|
| \none |

cHTMLTextbox( $name, $initvalue = "", $width = "", $maxlength = "", $id = "", $disabled = false, $tabindex = null, $accesskey = "") : \noneCreates an HTML text box.
If no additional parameters are specified, the default width is 20 units.
| Name | Type | Description |
|---|---|---|
| $name | string Name of the element | |
| $initvalue | string Initial value of the box | |
| $width | int width of the text box | |
| $maxlength | int maximum input length of the box | |
| $id | string ID of the element | |
| $disabled | string Item disabled flag (non-empty to set disabled) | |
| $tabindex | string Tab index for form elements | |
| $accesskey | string Key to access the field |
| Type | Description |
|---|---|
| \none |

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

fillSkeleton( $attributes) : stringfillSkeleton: Fills the open SGML tag skeleton
Inherited from: \cHTML::fillSkeleton()\cHTMLFormElement::fillSkeleton()\cHTMLTextbox::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() : stringgetID: returns the current ID
Inherited from: \cHTML::getID()\cHTMLFormElement::getID()\cHTMLTextbox::getID()| Type | Description |
|---|---|
| string | current ID |

render() : stringrender(): Alias for toHtml
Inherited from: \cHTML::render()\cHTMLFormElement::render()\cHTMLTextbox::render()| Type | Description |
|---|---|
| string | Rendered HTML |

setAccessKey( $accesskey) : \nonesets the access key for this element.
Inherited from: \cHTMLFormElement::setAccessKey()\cHTMLTextbox::setAccessKey()| Name | Type | Description |
|---|---|---|
| $accesskey | string The length of the access key. May be A-Z and 0-9. |
| Type | Description |
|---|---|
| \none |

setAlt( $alt) : voidsetAlt: sets the alt and title attributes
Inherited from: \cHTML::setAlt()\cHTMLFormElement::setAlt()\cHTMLTextbox::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) : voidsetAttribte: Sets a specific attribute
Inherited from: \cHTML::setAttribute()\cHTMLFormElement::setAttribute()\cHTMLTextbox::setAttribute()| Name | Type | Description |
|---|---|---|
| $sAttributeName | string Name of the attribute | |
| $sValue | string Value of the attribute |

setClass( $class) : voidsets the CSS class
Inherited from: \cHTML::setClass()\cHTMLFormElement::setClass()\cHTMLTextbox::setClass()| Name | Type | Description |
|---|---|---|
| $class | string Text to set as the "alt" attribute |

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

setDisabled( $disabled) : \noneSets the "disabled" attribute of an element.
Inherited from: \cHTMLFormElement::setDisabled()\cHTMLTextbox::setDisabled()User Agents usually are showing the element as "greyed-out".
Example: $obj->setDisabled("disabled"); $obj->setDisabled("");
The first example sets the disabled flag, the second one removes the disabled flag.
| Name | Type | Description |
|---|---|---|
| $disabled | string Sets the disabled-flag if non-empty |
| Type | Description |
|---|---|
| \none |

setEvent( $event, $action) : voidadds an "onXXX" javascript event handler
Inherited from: \cHTML::setEvent()\cHTMLFormElement::setEvent()\cHTMLTextbox::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) : voidSetter for static $_generateXHTML property
Inherited from: \cHTML::setGenerateXHTML()\cHTMLFormElement::setGenerateXHTML()\cHTMLTextbox::setGenerateXHTML()| Name | Type | Description |
|---|---|---|
| $value | bool |

setID( $id) : voidsets the ID class
Inherited from: \cHTML::setID()\cHTMLFormElement::setID()\cHTMLTextbox::setID()| Name | Type | Description |
|---|---|---|
| $id |

setMaxLength( $maxlen) : \nonesets the maximum input length of the text box.
Inherited from: \cHTMLTextbox::setMaxLength()| Name | Type | Description |
|---|---|---|
| $maxlen | int maximum input length |
| Type | Description |
|---|---|
| \none |

setStyle( $style) : voidsets the CSS style
Inherited from: \cHTML::setStyle()\cHTMLFormElement::setStyle()\cHTMLTextbox::setStyle()| Name | Type | Description |
|---|---|---|
| $style |

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

setTabindex( $tabindex) : \nonesets the tab index for this element.
Inherited from: \cHTMLFormElement::setTabindex()\cHTMLTextbox::setTabindex()The tab index needs to be numeric, bigger than 0 and smaller than 32767.
| Name | Type | Description |
|---|---|---|
| $tabindex | int desired tab index |
| Type | Description |
|---|---|
| \none |

setValue( $value) : \none| Name | Type | Description |
|---|---|---|
| $value | string Initial value |
| Type | Description |
|---|---|
| \none |

setWidth( $width) : \none| Name | Type | Description |
|---|---|---|
| $width | int width of the text box |
| Type | Description |
|---|---|
| \none |

toHTML() : voidRenders the output If the tag
Inherited from: \cHTML::toHTML()\cHTMLFormElement::toHTML()\cHTMLTextbox::toHTML()
unsetEvent( $event) : voidremoves an event handler
Inherited from: \cHTML::unsetEvent()\cHTMLFormElement::unsetEvent()\cHTMLTextbox::unsetEvent()example: $item->unsetEvent("change");
| Name | Type | Description |
|---|---|---|
| $event | string Type of the event |
\cDataTextareaWidget
- Parent(s)
- \cHTMLTextarea < \cHTMLFormElement < \cHTML < \HTML_Common
- Author
- Timo A. Hummel
Properties

$_aEventDefinitions- Type
- n/a
- Inherited_from
- \cHTML::$$_aEventDefinitions
- Inherited_from
- \cHTMLFormElement::$$_aEventDefinitions
- Inherited_from
- \cHTMLTextarea::$$_aEventDefinitions

$_aStyleDefinitions- Type
- n/a
- Inherited_from
- \cHTML::$$_aStyleDefinitions
- Inherited_from
- \cHTMLFormElement::$$_aStyleDefinitions
- Inherited_from
- \cHTMLTextarea::$$_aStyleDefinitions

$_content- Type
- n/a
- Inherited_from
- \cHTML::$$_content
- Inherited_from
- \cHTMLFormElement::$$_content
- Inherited_from
- \cHTMLTextarea::$$_content

boolean $_contentlessTag- Type
- boolean
- Access
- private
- Inherited_from
- \cHTML::$$_contentlessTag
- Inherited_from
- \cHTMLFormElement::$$_contentlessTag
- Inherited_from
- \cHTMLTextarea::$$_contentlessTag

array $_requiredScripts- Type
- array
- Access
- private
- Inherited_from
- \cHTML::$$_requiredScripts
- Inherited_from
- \cHTMLFormElement::$$_requiredScripts
- Inherited_from
- \cHTMLTextarea::$$_requiredScripts

string $_skeleton_close- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_close
- Inherited_from
- \cHTMLFormElement::$$_skeleton_close
- Inherited_from
- \cHTMLTextarea::$$_skeleton_close

string $_skeleton_open- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_open
- Inherited_from
- \cHTMLFormElement::$$_skeleton_open
- Inherited_from
- \cHTMLTextarea::$$_skeleton_open

string $_skeleton_single- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_skeleton_single
- Inherited_from
- \cHTMLFormElement::$$_skeleton_single
- Inherited_from
- \cHTMLTextarea::$$_skeleton_single

string $_styledefs- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_styledefs
- Inherited_from
- \cHTMLFormElement::$$_styledefs
- Inherited_from
- \cHTMLTextarea::$$_styledefs

string $_tag- Type
- string
- Access
- private
- Inherited_from
- \cHTML::$$_tag
- Inherited_from
- \cHTMLFormElement::$$_tag
- Inherited_from
- \cHTMLTextarea::$$_tag

$_value- Type
- n/a
- Inherited_from
- \cHTMLTextarea::$$_value
Methods

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

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

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

advanceID() : voidadvances to the next ID available in the system.
Inherited from: \cHTML::advanceID()\cHTMLFormElement::advanceID()\cHTMLTextarea::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) : voidattachEventDefinition: Attaches the code for an event
Inherited from: \cHTML::attachEventDefinition()\cHTMLFormElement::attachEventDefinition()\cHTMLTextarea::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) : stringattachStyleDefinition: Attaches a style definition.
Inherited from: \cHTML::attachStyleDefinition()\cHTMLFormElement::attachStyleDefinition()\cHTMLTextarea::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 |

cDataTextareaWidget( $name, $parameters) : voidcDataTextareaWidget: Creates a text area widget
| Name | Type | Description |
|---|---|---|
| $name | Name of the widget | |
| $parameters | Parameters (see below) valid parameters for this control are: default Default value for this area |
- Access
- public

cHTML() : voidConstructor Function Initializes the SGML open/close tags
Inherited from: \cHTML::cHTML()\cHTMLFormElement::cHTML()\cHTMLTextarea::cHTML()
cHTMLFormElement( $name = "", $id = "", $disabled = "", $tabindex = "", $accesskey = "") : \noneConstructor.
Inherited from: \cHTMLFormElement::cHTMLFormElement()\cHTMLTextarea::cHTMLFormElement()This is a generic form element, where specific elements should be inherited from this class.
| Name | Type | Description |
|---|---|---|
| $name | string Name of the element | |
| $id | string ID of the element | |
| $disabled | string Item disabled flag (non-empty to set disabled) | |
| $tabindex | string Tab index for form elements | |
| $accesskey | string Key to access the field |
| Type | Description |
|---|---|
| \none |

cHTMLTextarea( $name, $initvalue = "", $width = "", $height = "", $id = "", $disabled = false, $tabindex = null, $accesskey = "") : \noneCreates an HTML text area.
If no additional parameters are specified, the default width is 60 chars, and the height is 5 chars.
| Name | Type | Description |
|---|---|---|
| $name | string Name of the element | |
| $initvalue | string Initial value of the textarea | |
| $width | int width of the textarea | |
| $height | int height of the textarea | |
| $id | string ID of the element | |
| $disabled | string Item disabled flag (non-empty to set disabled) | |
| $tabindex | string Tab index for form elements | |
| $accesskey | string Key to access the field |
| Type | Description |
|---|---|
| \none |

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

fillSkeleton( $attributes) : stringfillSkeleton: Fills the open SGML tag skeleton
Inherited from: \cHTML::fillSkeleton()\cHTMLFormElement::fillSkeleton()\cHTMLTextarea::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() : stringgetID: returns the current ID
Inherited from: \cHTML::getID()\cHTMLFormElement::getID()\cHTMLTextarea::getID()| Type | Description |
|---|---|
| string | current ID |

render() : stringrender(): Alias for toHtml
Inherited from: \cHTML::render()\cHTMLFormElement::render()\cHTMLTextarea::render()| Type | Description |
|---|---|
| string | Rendered HTML |

setAccessKey( $accesskey) : \nonesets the access key for this element.
Inherited from: \cHTMLFormElement::setAccessKey()\cHTMLTextarea::setAccessKey()| Name | Type | Description |
|---|---|---|
| $accesskey | string The length of the access key. May be A-Z and 0-9. |
| Type | Description |
|---|---|
| \none |

setAlt( $alt) : voidsetAlt: sets the alt and title attributes
Inherited from: \cHTML::setAlt()\cHTMLFormElement::setAlt()\cHTMLTextarea::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) : voidsetAttribte: Sets a specific attribute
Inherited from: \cHTML::setAttribute()\cHTMLFormElement::setAttribute()\cHTMLTextarea::setAttribute()| Name | Type | Description |
|---|---|---|
| $sAttributeName | string Name of the attribute | |
| $sValue | string Value of the attribute |

setClass( $class) : voidsets the CSS class
Inherited from: \cHTML::setClass()\cHTMLFormElement::setClass()\cHTMLTextarea::setClass()| Name | Type | Description |
|---|---|---|
| $class | string Text to set as the "alt" attribute |

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

setDisabled( $disabled) : \noneSets the "disabled" attribute of an element.
Inherited from: \cHTMLFormElement::setDisabled()\cHTMLTextarea::setDisabled()User Agents usually are showing the element as "greyed-out".
Example: $obj->setDisabled("disabled"); $obj->setDisabled("");
The first example sets the disabled flag, the second one removes the disabled flag.
| Name | Type | Description |
|---|---|---|
| $disabled | string Sets the disabled-flag if non-empty |
| Type | Description |
|---|---|
| \none |

setEvent( $event, $action) : voidadds an "onXXX" javascript event handler
Inherited from: \cHTML::setEvent()\cHTMLFormElement::setEvent()\cHTMLTextarea::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) : voidSetter for static $_generateXHTML property
Inherited from: \cHTML::setGenerateXHTML()\cHTMLFormElement::setGenerateXHTML()\cHTMLTextarea::setGenerateXHTML()| Name | Type | Description |
|---|---|---|
| $value | bool |

setID( $id) : voidsets the ID class
Inherited from: \cHTML::setID()\cHTMLFormElement::setID()\cHTMLTextarea::setID()| Name | Type | Description |
|---|---|---|
| $id |

setStyle( $style) : voidsets the CSS style
Inherited from: \cHTML::setStyle()\cHTMLFormElement::setStyle()\cHTMLTextarea::setStyle()| Name | Type | Description |
|---|---|---|
| $style |

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

setTabindex( $tabindex) : \nonesets the tab index for this element.
Inherited from: \cHTMLFormElement::setTabindex()\cHTMLTextarea::setTabindex()The tab index needs to be numeric, bigger than 0 and smaller than 32767.
| Name | Type | Description |
|---|---|---|
| $tabindex | int desired tab index |
| Type | Description |
|---|---|
| \none |

setValue( $value) : \none| Name | Type | Description |
|---|---|---|
| $value | string Initial value |
| Type | Description |
|---|---|
| \none |

setWidth( $width) : \none| Name | Type | Description |
|---|---|---|
| $width | int width of the text box |
| Type | Description |
|---|---|
| \none |

toHTML() : voidRenders the output If the tag
Inherited from: \cHTML::toHTML()\cHTMLFormElement::toHTML()\cHTMLTextarea::toHTML()
unsetEvent( $event) : voidremoves an event handler
Inherited from: \cHTML::unsetEvent()\cHTMLFormElement::unsetEvent()\cHTMLTextarea::unsetEvent()example: $item->unsetEvent("change");
| Name | Type | Description |
|---|---|---|
| $event | string Type of the event |