CONTENIDO_API 4.8.16 CL
Back to top  

HTML Checkbox

author Timo A. Hummel

 Methods

Constructor Function Initializes the SGML open/close tags

__construct() : void
Inherited

inherited_from \cHTML::__construct()
inherited_from \cHTMLFormElement::__construct()

_setContent: Sets the content of the object

_setContent(\$content $content) 
Inherited

inherited_from \cHTML::_setContent()
inherited_from \cHTMLFormElement::_setContent()

Parameters

$content

\$content

string/object String with the content or an object to render.

addRequiredScript() 

addRequiredScript($script) 
Inherited

inherited_from \cHTML::addRequiredScript()
inherited_from \cHTMLFormElement::addRequiredScript()

Parameters

$script

advances to the next ID available in the system.

advanceID() 
Inherited

This function is useful if you need to use HTML elements in a loop, but don't want to re-create new objects each time.

inherited_from \cHTML::advanceID()
inherited_from \cHTMLFormElement::advanceID()

attachEventDefinition: Attaches the code for an event

attachEventDefinition(\$sName $sName, \$sEvent $sEvent, \$sCode $sCode) 
Inherited

Example to attach an onClick handler: setEventDefinition("foo", "onClick", "alert('foo');");

inherited_from \cHTML::attachEventDefinition()
inherited_from \cHTMLFormElement::attachEventDefinition()

Parameters

$sName

\$sName

string defines the name of the event

$sEvent

\$sEvent

string defines the event (e.g. onClick)

$sCode

\$sCode

string defines the code

attachStyleDefinition: Attaches a style definition.

attachStyleDefinition(\$sName $sName, \$sDefinition $sDefinition) : string
Inherited

This function is not restricted to a single style, e.g. you can set multiple style definitions as-is to the handler.

$example->attachStyle("myIdentifier", "border: 1px solid black; white-space: nowrap"); $example->attachStyle("myIdentifier2", "padding: 0px");

Results in:

style="border: 1px solid black; white-space: nowrap; padding: 0px;"

inherited_from \cHTML::attachStyleDefinition()
inherited_from \cHTMLFormElement::attachStyleDefinition()

Parameters

$sName

\$sName

string Name for a style definition

$sDefinition

\$sDefinition

string Definition for the given entity

Returns

stringfilled SGML closing skeleton

old Constructor

cHTML() 
Inherited

inherited_from \cHTML::cHTML()
inherited_from \cHTMLFormElement::cHTML()

Constructor. Creates an HTML checkbox element.

cHTMLCheckbox(\$name $name, \$value $value, \$id $id, \$checked $checked, \$disabled $disabled, \$tabindex $tabindex, \$accesskey $accesskey) : \none

Parameters

$name

\$name

string Name of the element

$value

\$value

string Value of the radio button

$id

\$id

string ID of the element

$checked

\$checked

boolean Is element checked?

$disabled

\$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

\$tabindex

string Tab index for form elements

$accesskey

\$accesskey

string Key to access the field

Returns

\none

Constructor. This is a generic form element, where specific elements should be inherited from this class.

cHTMLFormElement(\$name $name, \$id $id, \$disabled $disabled, \$tabindex $tabindex, \$accesskey $accesskey) : \none
Inherited

inherited_from \cHTMLFormElement::cHTMLFormElement()

Parameters

$name

\$name

string Name of the element

$id

\$id

string ID of the element

$disabled

\$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

\$tabindex

string Tab index for form elements

$accesskey

\$accesskey

string Key to access the field

Returns

\none

fillCloseSkeleton: Fills the close skeleton

fillCloseSkeleton() : string
Inherited

inherited_from \cHTML::fillCloseSkeleton()
inherited_from \cHTMLFormElement::fillCloseSkeleton()

Returns

stringfilled SGML closer skeleton

fillSkeleton: Fills the open SGML tag skeleton

fillSkeleton(\$attributes $attributes) : string
Inherited

fillSkeleton fills the SGML opener tag with the specified attributes. Attributes need to be passed in the stringyfied variant.

inherited_from \cHTML::fillSkeleton()
inherited_from \cHTMLFormElement::fillSkeleton()

Parameters

$attributes

\$attributes

string Attributes to set

Returns

stringfilled SGML opener skeleton

getID: returns the current ID

getID() : string
Inherited

inherited_from \cHTML::getID()
inherited_from \cHTMLFormElement::getID()

Returns

stringcurrent ID

render(): Alias for toHtml

render() : string
Inherited

inherited_from \cHTML::render()
inherited_from \cHTMLFormElement::render()

Returns

stringRendered HTML

sets the access key for this element.

setAccessKey(\$accesskey $accesskey) : \none
Inherited

inherited_from \cHTMLFormElement::setAccessKey()

Parameters

$accesskey

\$accesskey

string The length of the access key. May be A-Z and 0-9.

Returns

\none

setAlt: sets the alt and title attributes

setAlt(\$alt $alt) 
Inherited

Sets the "alt" and "title" tags. Usually, "alt" is used for accessibility and "title" for mouse overs.

To set the text for all browsers for mouse over, set "alt" and "title". IE behaves incorrectly and shows "alt" on mouse over. Mozilla browsers only show "title" as mouse over.

inherited_from \cHTML::setAlt()
inherited_from \cHTMLFormElement::setAlt()

Parameters

$alt

\$alt

string Text to set as the "alt" attribute

setAttribte: Sets a specific attribute

setAttribute(\$sAttributeName $sAttributeName, \$sValue $sValue) 
Inherited

inherited_from \cHTML::setAttribute()
inherited_from \cHTMLFormElement::setAttribute()

Parameters

$sAttributeName

\$sAttributeName

string Name of the attribute

$sValue

\$sValue

string Value of the attribute

Sets the checked flag.

setChecked(\$checked $checked) : \none

Parameters

$checked

\$checked

boolean If true, the "checked" attribute will be assigned.

Returns

\none

sets the CSS class

setClass(\$class $class) 
Inherited

inherited_from \cHTML::setClass()
inherited_from \cHTMLFormElement::setClass()

Parameters

$class

\$class

string Text to set as the "alt" attribute

setContentlessTag() 

setContentlessTag(\type $contentlessTag) 
Inherited

inherited_from \cHTML::setContentlessTag()
inherited_from \cHTMLFormElement::setContentlessTag()

Parameters

$contentlessTag

\type

Sets the "disabled" attribute of an element. User Agents usually are showing the element as "greyed-out".

setDisabled(\$disabled $disabled) : \none
Inherited

Example: $obj->setDisabled("disabled"); $obj->setDisabled("");

The first example sets the disabled flag, the second one removes the disabled flag.

inherited_from \cHTMLFormElement::setDisabled()

Parameters

$disabled

\$disabled

string Sets the disabled-flag if non-empty

Returns

\none

adds an "onXXX" javascript event handler

setEvent(\$event $event, \$action $action) 
Inherited

example: $item->setEvent("change","document.forms[0].submit");

inherited_from \cHTML::setEvent()
inherited_from \cHTMLFormElement::setEvent()

Parameters

$event

\$event

string Type of the event

$action

\$action

string Function or action to call (JavaScript Code)

sets the ID class

setID(\$class $id) 
Inherited

inherited_from \cHTML::setID()
inherited_from \cHTMLFormElement::setID()

Parameters

$id

\$class

string Text to set as the "id"

Sets a custom label text

setLabelText(\$text $text) : \none

Parameters

$text

\$text

string Text to display

Returns

\none

sets the CSS style

setStyle(\$class $style) 
Inherited

inherited_from \cHTML::setStyle()
inherited_from \cHTMLFormElement::setStyle()

Parameters

$style

\$class

string Text to set as the "alt" attribute

addStyleDefinition

setStyleDefinition(\$entity $entity, \$definition $definition) : string
Inherited

inherited_from \cHTML::setStyleDefinition()
inherited_from \cHTMLFormElement::setStyleDefinition()

Parameters

$entity

\$entity

string Entity to define

$definition

\$definition

string Definition for the given entity

Returns

stringfilled SGML closing skeleton

sets the tab index for this element. The tab index needs to be numeric, bigger than 0 and smaller than 32767.

setTabindex(\$tabindex $tabindex) : \none
Inherited

inherited_from \cHTMLFormElement::setTabindex()

Parameters

$tabindex

\$tabindex

int desired tab index

Returns

\none

Renders the output If the tag

toHTML() 
Inherited

inherited_from \cHTML::toHTML()
inherited_from \cHTMLFormElement::toHTML()

Renders the checkbox element. Note:

toHtml(\$renderlabel $renderlabel) : string

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.

Parameters

$renderlabel

\$renderlabel

boolean If true, renders a label

Returns

stringRendered HTML

removes an event handler

unsetEvent(\$event $event) 
Inherited

example: $item->unsetEvent("change");

inherited_from \cHTML::unsetEvent()
inherited_from \cHTMLFormElement::unsetEvent()

Parameters

$event

\$event

string Type of the event

 Properties

 

Defines which JS events contain which scripts

$_aEventDefinitions 
Inherited

inherited_from \cHTML::$$_aEventDefinitions
inherited_from \cHTMLFormElement::$$_aEventDefinitions
 

Style definitions

$_aStyleDefinitions 
Inherited

inherited_from \cHTML::$$_aStyleDefinitions
inherited_from \cHTMLFormElement::$$_aStyleDefinitions
 

The content itself

$_content 
Inherited

inherited_from \cHTML::$$_content
inherited_from \cHTMLFormElement::$$_content
 

Defines if the current tag is a contentless tag

$_contentlessTag : boolean
Inherited

access private
inherited_from \cHTML::$$_contentlessTag
inherited_from \cHTMLFormElement::$$_contentlessTag
 

Defines all scripts which are required by the current element

$_requiredScripts : array
Inherited

access private
inherited_from \cHTML::$$_requiredScripts
inherited_from \cHTMLFormElement::$$_requiredScripts
 

Storage of the close SGML tag

$_skeleton_close : string
Inherited

access private
inherited_from \cHTML::$$_skeleton_close
inherited_from \cHTMLFormElement::$$_skeleton_close
 

Storage of the open SGML tag template

$_skeleton_open : string
Inherited

access private
inherited_from \cHTML::$$_skeleton_open
inherited_from \cHTMLFormElement::$$_skeleton_open
 

Storage of a single SGML tag template

$_skeleton_single : string
Inherited

access private
inherited_from \cHTML::$$_skeleton_single
inherited_from \cHTMLFormElement::$$_skeleton_single
 

Defines the style definitions

$_styledefs : string
Inherited

access private
inherited_from \cHTML::$$_styledefs
inherited_from \cHTMLFormElement::$$_styledefs
 

Defines which tag to use

$_tag : string
Inherited

access private
inherited_from \cHTML::$$_tag
inherited_from \cHTMLFormElement::$$_tag
 

$_value

$_value