Overview

Packages

  • CONTENIDO
  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentRssCreator
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
    • ScriptCookieDirective
  • mpAutoloaderClassMap
  • None
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SearchSolr
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob
  • Smarty
    • Cacher
    • Compiler
    • Config
    • Debug
    • PluginsBlock
    • PluginsFilter
    • PluginsFunction
    • PluginsInternal
    • PluginsModifier
    • PluginsModifierCompiler
    • PluginsShared
    • Security
    • Template
    • TemplateResources
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Transport

Classes

  • cHTML
  • cHTMLAlignmentTable
  • cHTMLArticle
  • cHTMLAside
  • cHTMLAudio
  • cHTMLButton
  • cHTMLCanvas
  • cHTMLCheckbox
  • cHTMLContentElement
  • cHTMLDiv
  • cHTMLFieldset
  • cHTMLFooter
  • cHTMLForm
  • cHTMLFormElement
  • cHTMLHeader
  • cHTMLHgroup
  • cHTMLHiddenField
  • cHTMLIFrame
  • cHTMLImage
  • cHTMLLabel
  • cHTMLLegend
  • cHTMLLink
  • cHTMLList
  • cHTMLListItem
  • cHTMLNav
  • cHTMLOptgroup
  • cHTMLOptionElement
  • cHTMLParagraph
  • cHTMLPasswordbox
  • cHTMLRadiobutton
  • cHTMLScript
  • cHTMLSection
  • cHTMLSelectElement
  • cHTMLSpan
  • cHTMLTable
  • cHTMLTableBody
  • cHTMLTableData
  • cHTMLTableHead
  • cHTMLTableHeader
  • cHTMLTableRow
  • cHTMLTextarea
  • cHTMLTextbox
  • cHTMLTime
  • cHTMLUpload
  • cHTMLVideo
  • Overview
  • Package
  • Class
  • Todo
  • Download

Class cHTMLCheckbox

cHTMLCheckbox class represents a checkbox.

cHTML
Extended by cHTMLFormElement
Extended by 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. Creates an HTML checkbox element.

Constructor. Creates an HTML checkbox element.

Parameters

$name
Name of the element
$value
Value of the checkbox
$id
ID of the element
$checked
Is element checked?
$disabled
Item disabled flag (non-empty to set disabled)
$tabindex
Tab index for form elements
$accesskey
Key to access the field
$class
the class of this element

Overrides

cHTMLFormElement::__construct()
public cHTMLCheckbox
# setChecked( boolean $checked )

Sets the checked flag.

Sets the checked flag.

Parameters

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

Returns

cHTMLCheckbox
$this
public cHTMLCheckbox
# setLabelText( string $text )

Sets a custom label text

Sets a custom label text

Parameters

$text
Text to display

Returns

cHTMLCheckbox
$this
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
If true, renders a label

Returns

string
Rendered HTML
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(), toHTML(), 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
CMS CONTENIDO 4.9.7 API documentation generated by ApiGen