Class cHTMLCheckbox

cHTMLCheckbox class represents a checkbox.

cHTML

cHTMLCheckbox

Package: Core\GUI\HTML
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Simon Sprankel
Located at classes/html/class.html.checkbox.php

Methods summary
`public`	# `__construct( string $name, string $value, string $id = '', boolean $checked = false, string $disabled = false, string $tabindex = NULL, string $accesskey = '', string $class = '' )` Constructor to create an instance of this class. Constructor to create an instance of this class. Creates an HTML checkbox element. Parameters `$name` `string` $name Name of the element `$value` `string` $value Value of the checkbox `$id` `string` $id [optional] ID of the element `$checked` `boolean` $checked [optional] Is element checked? `$disabled` `string` $disabled [optional] Item disabled flag (non-empty to set disabled) `$tabindex` `string` $tabindex [optional] Tab index for form elements `$accesskey` `string` $accesskey [optional] Key to access the field `$class` `string` $class [optional] the class of this element Overrides `cHTMLFormElement::__construct()`
`public cHTMLCheckbox`	# `setChecked( boolean $checked )` Sets the checked flag. Sets the checked flag. Parameters `$checked` `boolean` $checked If true, the "checked" attribute will be assigned. Returns `cHTMLCheckbox` $this for chaining
`public cHTMLCheckbox`	# `setLabelText( string $text )` Sets a custom label text Sets a custom label text Parameters `$text` `string` $text Text to display Returns `cHTMLCheckbox` $this for chaining
`public string`	# `toHtml( boolean $renderlabel = true )` Renders the checkbox element. Note: Renders the checkbox element. Note: 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` `boolean` $renderlabel [optional] If true, renders a label Returns `string` Rendered HTML Overrides `cHTML::toHtml()`

Methods inherited from cHTMLFormElement
`setAccessKey(), setDisabled(), setTabindex()`

Methods inherited from cHTML
`__toString(), _appendContent(), _getAttrString(), _parseAttributes(), _setContent(), addRequiredScript(), advanceID(), appendStyleDefinition(), appendStyleDefinitions(), attachEventDefinition(), display(), fillCloseSkeleton(), fillSkeleton(), getAttribute(), getAttributes(), getID(), removeAttribute(), render(), setAlt(), setAttribute(), setAttributes(), setClass(), setEvent(), setGenerateXHTML(), setID(), setStyle(), setTag(), unsetEvent(), updateAttribute(), updateAttributes()`

Properties summary
`protected string`	`$_value`		# Values for the check box Values for the check box
`protected string`	`$_labelText`		# The text for the corresponding label The text for the corresponding label

Properties inherited from cHTML
`$_attributes, $_content, $_contentlessTag, $_eventDefinitions, $_generateXHTML, $_idCounter, $_requiredScripts, $_skeletonClose, $_skeletonOpen, $_skeletonSingle, $_styleDefinitions, $_styleDefs, $_tag`

Packages

Classes

Class cHTMLCheckbox

Parameters

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides