__construct()
_setContent()
addRequiredScript()
advanceID()
attachEventDefinition()
attachStyleDefinition()
cHTML()
cHTMLButton()
cHTMLFormElement()
fillCloseSkeleton()
fillSkeleton()
getID()
render()
setAccessKey()
setAlt()
setAttribute()
setClass()
setContentlessTag()
setDisabled()
setEvent()
setID()
setImageSource()
setMode()
setStyle()
setStyleDefinition()
setTabindex()
setTitle()
toHTML()
toHtml()
unsetEvent()
$_aEventDefinitions
$_aStyleDefinitions
$_content
$_contentlessTag
$_requiredScripts
$_skeleton_close
$_skeleton_open
$_skeleton_single
$_styledefs
$_tag
HTML Button class
| author | Timo A. Hummel |
|---|
__construct() : void
| inherited_from | \cHTML::__construct() |
|---|---|
| inherited_from | \cHTMLFormElement::__construct() |
_setContent(\$content $content)
| inherited_from | \cHTML::_setContent() |
|---|---|
| inherited_from | \cHTMLFormElement::_setContent() |
\$contentstring/object String with the content or an object to render.
addRequiredScript($script)
| inherited_from | \cHTML::addRequiredScript() |
|---|---|
| inherited_from | \cHTMLFormElement::addRequiredScript() |
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.
| inherited_from | \cHTML::advanceID() |
|---|---|
| inherited_from | \cHTMLFormElement::advanceID() |
attachEventDefinition(\$sName $sName, \$sEvent $sEvent, \$sCode $sCode)
Example to attach an onClick handler: setEventDefinition("foo", "onClick", "alert('foo');");
| inherited_from | \cHTML::attachEventDefinition() |
|---|---|
| inherited_from | \cHTMLFormElement::attachEventDefinition() |
\$sNamestring defines the name of the event
\$sEventstring defines the event (e.g. onClick)
\$sCodestring defines the code
attachStyleDefinition(\$sName $sName, \$sDefinition $sDefinition) : string
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 | \cHTMLFormElement::attachStyleDefinition() |
\$sNamestring Name for a style definition
\$sDefinitionstring Definition for the given entity
stringfilled SGML closing skeletoncHTML()
| inherited_from | \cHTML::cHTML() |
|---|---|
| inherited_from | \cHTMLFormElement::cHTML() |
cHTMLButton(\$name $name, \$title $title, \$id $id, \$disabled $disabled, \$tabindex $tabindex, \$accesskey $accesskey, $mode) : \none
Creates a submit button by default, can be changed using setMode.
\$namestring Name of the element
\$titlestring Title of the button
\$idstring ID of the element
\$disabledstring Item disabled flag (non-empty to set disabled)
\$tabindexstring Tab index for form elements
\$accesskeystring Key to access the field
\nonecHTMLFormElement(\$name $name, \$id $id, \$disabled $disabled, \$tabindex $tabindex, \$accesskey $accesskey) : \none
| inherited_from | \cHTMLFormElement::cHTMLFormElement() |
|---|
\$namestring Name of the element
\$idstring ID of the element
\$disabledstring Item disabled flag (non-empty to set disabled)
\$tabindexstring Tab index for form elements
\$accesskeystring Key to access the field
\nonefillCloseSkeleton() : string
| inherited_from | \cHTML::fillCloseSkeleton() |
|---|---|
| inherited_from | \cHTMLFormElement::fillCloseSkeleton() |
stringfilled SGML closer skeletonfillSkeleton(\$attributes $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() |
|---|---|
| inherited_from | \cHTMLFormElement::fillSkeleton() |
\$attributesstring Attributes to set
stringfilled SGML opener skeletongetID() : string
| inherited_from | \cHTML::getID() |
|---|---|
| inherited_from | \cHTMLFormElement::getID() |
stringcurrent IDrender() : string
| inherited_from | \cHTML::render() |
|---|---|
| inherited_from | \cHTMLFormElement::render() |
stringRendered HTMLsetAccessKey(\$accesskey $accesskey) : \none
| inherited_from | \cHTMLFormElement::setAccessKey() |
|---|
\$accesskeystring The length of the access key. May be A-Z and 0-9.
\nonesetAlt(\$alt $alt)
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 | \cHTMLFormElement::setAlt() |
\$altstring Text to set as the "alt" attribute
setAttribute(\$sAttributeName $sAttributeName, \$sValue $sValue)
| inherited_from | \cHTML::setAttribute() |
|---|---|
| inherited_from | \cHTMLFormElement::setAttribute() |
\$sAttributeNamestring Name of the attribute
\$sValuestring Value of the attribute
setClass(\$class $class)
| inherited_from | \cHTML::setClass() |
|---|---|
| inherited_from | \cHTMLFormElement::setClass() |
\$classstring Text to set as the "alt" attribute
setContentlessTag(\type $contentlessTag)
| inherited_from | \cHTML::setContentlessTag() |
|---|---|
| inherited_from | \cHTMLFormElement::setContentlessTag() |
\type
setDisabled(\$disabled $disabled) : \none
Example: $obj->setDisabled("disabled"); $obj->setDisabled("");
The first example sets the disabled flag, the second one removes the disabled flag.
| inherited_from | \cHTMLFormElement::setDisabled() |
|---|
\$disabledstring Sets the disabled-flag if non-empty
\nonesetEvent(\$event $event, \$action $action)
example: $item->setEvent("change","document.forms[0].submit");
| inherited_from | \cHTML::setEvent() |
|---|---|
| inherited_from | \cHTMLFormElement::setEvent() |
\$eventstring Type of the event
\$actionstring Function or action to call (JavaScript Code)
setID(\$class $id)
| inherited_from | \cHTML::setID() |
|---|---|
| inherited_from | \cHTMLFormElement::setID() |
\$classstring Text to set as the "id"
setImageSource(\$mode $src) : void
\$modestring image path.
setMode(\$mode $mode) : boolean
\$modestring Either "submit", "reset" or "image".
booleanReturns false if failed to set the modesetStyle(\$class $style)
| inherited_from | \cHTML::setStyle() |
|---|---|
| inherited_from | \cHTMLFormElement::setStyle() |
\$classstring Text to set as the "alt" attribute
setStyleDefinition(\$entity $entity, \$definition $definition) : string
| inherited_from | \cHTML::setStyleDefinition() |
|---|---|
| inherited_from | \cHTMLFormElement::setStyleDefinition() |
\$entitystring Entity to define
\$definitionstring Definition for the given entity
stringfilled SGML closing skeletonsetTabindex(\$tabindex $tabindex) : \none
| inherited_from | \cHTMLFormElement::setTabindex() |
|---|
\$tabindexint desired tab index
\nonesetTitle(\$title $title) : \none
\$titlestring The title to set
\nonetoHTML()
| inherited_from | \cHTML::toHTML() |
|---|---|
| inherited_from | \cHTMLFormElement::toHTML() |
toHtml() : string
stringRendered HTMLunsetEvent(\$event $event)
example: $item->unsetEvent("change");
| inherited_from | \cHTML::unsetEvent() |
|---|---|
| inherited_from | \cHTMLFormElement::unsetEvent() |
\$eventstring Type of the event
$_aEventDefinitions
| inherited_from | \cHTML::$$_aEventDefinitions |
|---|---|
| inherited_from | \cHTMLFormElement::$$_aEventDefinitions |
$_aStyleDefinitions
| inherited_from | \cHTML::$$_aStyleDefinitions |
|---|---|
| inherited_from | \cHTMLFormElement::$$_aStyleDefinitions |
$_content
| inherited_from | \cHTML::$$_content |
|---|---|
| inherited_from | \cHTMLFormElement::$$_content |
$_contentlessTag : boolean
| access | private |
|---|---|
| inherited_from | \cHTML::$$_contentlessTag |
| inherited_from | \cHTMLFormElement::$$_contentlessTag |
$_requiredScripts : array
| access | private |
|---|---|
| inherited_from | \cHTML::$$_requiredScripts |
| inherited_from | \cHTMLFormElement::$$_requiredScripts |
$_skeleton_close : string
| access | private |
|---|---|
| inherited_from | \cHTML::$$_skeleton_close |
| inherited_from | \cHTMLFormElement::$$_skeleton_close |
$_skeleton_open : string
| access | private |
|---|---|
| inherited_from | \cHTML::$$_skeleton_open |
| inherited_from | \cHTMLFormElement::$$_skeleton_open |
$_skeleton_single : string
| access | private |
|---|---|
| inherited_from | \cHTML::$$_skeleton_single |
| inherited_from | \cHTMLFormElement::$$_skeleton_single |
$_styledefs : string
| access | private |
|---|---|
| inherited_from | \cHTML::$$_styledefs |
| inherited_from | \cHTMLFormElement::$$_styledefs |
$_tag : string
| access | private |
|---|---|
| inherited_from | \cHTML::$$_tag |
| inherited_from | \cHTMLFormElement::$$_tag |