HTML Button class
| author | Timo A. Hummel |
|---|
__toString() : string
| inherited_from | \cHTML::__toString() |
|---|---|
| inherited_from | \cHTMLFormElement::__toString() |
stringGenerated markup_setContent($content)
| inherited_from | \cHTML::_setContent() |
|---|---|
| inherited_from | \cHTMLFormElement::_setContent() |
string/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, $sEvent, $sCode)
Example to attach an onClick handler: setEventDefinition("foo", "onClick", "alert('foo');");
| inherited_from | \cHTML::attachEventDefinition() |
|---|---|
| inherited_from | \cHTMLFormElement::attachEventDefinition() |
string defines the name of the event
string defines the event (e.g. onClick)
string defines the code
attachStyleDefinition($sName, $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() |
string Name for a style definition
string Definition for the given entity
stringfilled SGML closing skeletoncHTML()
| inherited_from | \cHTML::cHTML() |
|---|---|
| inherited_from | \cHTMLFormElement::cHTML() |
cHTMLButton($name, $title, $id, $disabled, $tabindex, $accesskey, $mode) : \none
Creates an HTML button.
Creates a submit button by default, can be changed using setMode.
string Name of the element
string Title of the button
string ID of the element
string Item disabled flag (non-empty to set disabled)
string Tab index for form elements
string Key to access the field
\nonecHTMLFormElement($name, $id, $disabled, $tabindex, $accesskey) : \none
This is a generic form element, where specific elements should be inherited from this class.
| inherited_from | \cHTMLFormElement::cHTMLFormElement() |
|---|
string Name of the element
string ID of the element
string Item disabled flag (non-empty to set disabled)
string Tab index for form elements
string Key to access the field
\nonefillCloseSkeleton() : string
| inherited_from | \cHTML::fillCloseSkeleton() |
|---|---|
| inherited_from | \cHTMLFormElement::fillCloseSkeleton() |
stringfilled SGML closer skeletonfillSkeleton($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() |
string 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) : \none
| inherited_from | \cHTMLFormElement::setAccessKey() |
|---|
string The length of the access key. May be A-Z and 0-9.
\nonesetAlt($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() |
string Text to set as the "alt" attribute
setAttribute($sAttributeName, $sValue)
| inherited_from | \cHTML::setAttribute() |
|---|---|
| inherited_from | \cHTMLFormElement::setAttribute() |
string Name of the attribute
string Value of the attribute
setClass($class)
| inherited_from | \cHTML::setClass() |
|---|---|
| inherited_from | \cHTMLFormElement::setClass() |
string Text to set as the "alt" attribute
setContentlessTag($contentlessTag)
| inherited_from | \cHTML::setContentlessTag() |
|---|---|
| inherited_from | \cHTMLFormElement::setContentlessTag() |
setDisabled($disabled) : \none
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.
| inherited_from | \cHTMLFormElement::setDisabled() |
|---|
string Sets the disabled-flag if non-empty
\nonesetEvent($event, $action)
example: $item->setEvent("change","document.forms[0].submit");
| inherited_from | \cHTML::setEvent() |
|---|---|
| inherited_from | \cHTMLFormElement::setEvent() |
string Type of the event
string Function or action to call (JavaScript Code)
setGenerateXHTML(bool $value)
| inherited_from | \cHTML::setGenerateXHTML() |
|---|---|
| inherited_from | \cHTMLFormElement::setGenerateXHTML() |
bool
setID($id)
| inherited_from | \cHTML::setID() |
|---|---|
| inherited_from | \cHTMLFormElement::setID() |
setImageSource($src) : void
setMode($mode) : boolean
string Either "submit", "reset" or "image".
booleanReturns false if failed to set the modesetStyle($style)
| inherited_from | \cHTML::setStyle() |
|---|---|
| inherited_from | \cHTMLFormElement::setStyle() |
setStyleDefinition($entity, $definition) : string
| inherited_from | \cHTML::setStyleDefinition() |
|---|---|
| inherited_from | \cHTMLFormElement::setStyleDefinition() |
string Entity to define
string Definition for the given entity
stringfilled SGML closing skeletonsetTabindex($tabindex) : \none
The tab index needs to be numeric, bigger than 0 and smaller than 32767.
| inherited_from | \cHTMLFormElement::setTabindex() |
|---|
int desired tab index
\nonesetTitle($title) : \none
string The title to set
\nonetoHTML()
| inherited_from | \cHTML::toHTML() |
|---|---|
| inherited_from | \cHTMLFormElement::toHTML() |
toHtml() : string
stringRendered HTMLunsetEvent($event)
example: $item->unsetEvent("change");
| inherited_from | \cHTML::unsetEvent() |
|---|---|
| inherited_from | \cHTMLFormElement::unsetEvent() |
string 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 |