Class QCheckBox

This class will render an HTML Checkbox.

Labels are a little tricky with checkboxes. There are two built-in ways to make labels: 1) Assign a Name property, and render using something like RenderWithName 2) Assign a Text property, in which case the checkbox will be wrapped with a label and the text you assign.

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QCheckBox

Direct known subclasses

QJqCheckBoxGen, QRadioButton

Indirect known subclasses

QJqCheckBox, QJqCheckBoxBase, QJqRadioButton, QJqRadioButtonBase, QJqRadioButtonGen

Package: Controls
Located at includes/base_controls/QCheckBox.class.php

Methods summary
`public`	# `ParsePostData( )` Parses the Post Data submitted for the control and sets the values according to the data submitted Parses the Post Data submitted for the control and sets the values according to the data submitted
`protected string`	# `GetControlHtml( )` Returns the HTML code for the control which can be sent to the client. Returns the HTML code for the control which can be sent to the client. Note, previous version wrapped this in a div and made the control a block level control unnecessarily. To achieve a block control, set blnUseWrapper and blnIsBlockElement. Returns string THe HTML for the control
`protected string`	# `RenderButton( $attrOverride )` Render the button code. Broken out to allow QRadioButton to use it too. Render the button code. Broken out to allow QRadioButton to use it too. Parameters `$attrOverride` Returns string
`public QTagStyler`	# `getCheckLabelStyler( )` Return a styler to style the label that surrounds the control if the control has text. Return a styler to style the label that surrounds the control if the control has text. Returns `QTagStyler`
`protected string`	# `RenderLabelAttributes( )` There is a little bit of a conundrum here. If there is text assigned to the checkbox, we wrap the checkbox in a label. However, in this situation, its unclear what to do with the class and style attributes that are for the checkbox. We are going to let the developer use the label styler to make it clear what their intentions are. There is a little bit of a conundrum here. If there is text assigned to the checkbox, we wrap the checkbox in a label. However, in this situation, its unclear what to do with the class and style attributes that are for the checkbox. We are going to let the developer use the label styler to make it clear what their intentions are. Returns string
`public boolean`	# `Validate( )` Checks whether the post data submitted for the control is valid or not Right now it tests whether or not the control was marked as required and then tests whether it was checked or not Checks whether the post data submitted for the control is valid or not Right now it tests whether or not the control was marked as required and then tests whether it was checked or not Returns boolean
`public mixed`	# `GetState( )` Returns the current state of the control to be able to restore it later. Returns the current state of the control to be able to restore it later. Returns mixed Overrides `QControlBase::GetState()`
`public`	# `PutState( mixed $state )` Restore the state of the control. Restore the state of the control. Parameters `$state` Overrides `QControlBase::PutState()`
`public mixed`	# `__get( string $strName )` PHP __get magic method implementation PHP __get magic method implementation Parameters `$strName` Name of the property Returns mixed Throws `QCallerException` Overrides `QControlBase::__get()`
`public mixed`	# `__set( string $strName, string $mixValue )` PHP __set magic method implementation PHP __set magic method implementation Parameters `$strName` `$mixValue` Returns mixed Throws `QInvalidCastException`\|`QCallerException` Overrides `QControlBase::__set()`
`public static QModelConnectorParam[]`	# `GetModelConnectorParams( )` Returns an description of the options available to modify by the designer for the code generator. Returns an description of the options available to modify by the designer for the code generator. Returns `QModelConnectorParam[]` Overrides `QControlBase::GetModelConnectorParams()`

Methods inherited from QControlBase
AddAction(), AddActionArray(), AddAttributeScript(), AddChildControl(), AddCssFile(), AddJavascriptFile(), AddPluginCssFile(), AddPluginJavascriptFile(), AddWrapperCssClass(), Blink(), EvaluateTemplate(), Focus(), ForgetState(), GetAllActions(), GetAttributes(), GetChildControl(), GetChildControls(), GetControlFromHierarchyByMethodName(), GetCustomAttribute(), GetCustomAttributes(), GetCustomStyle(), GetEndHtml(), GetEndScript(), GetForm(), GetJavaScriptForEvent(), GetJqControlId(), GetNonWrappedHtml(), GetStyleAttributes(), GetTemplatePath(), GetWrapperAttributes(), GetWrapperStyleAttributes(), GetWrapperStyler(), IsDescendantOf(), IsModified(), MakeCurrent(), MarkAsModified(), MarkAsRendered(), MarkAsWrapperModified(), ProcessActionParameters(), Refresh(), RemoveAllActions(), RemoveChildControl(), RemoveChildControls(), RemoveCustomAttribute(), RemoveCustomStyle(), RemoveWrapperCssClass(), Render(), RenderActionScripts(), RenderAjax(), RenderAttributeScripts(), RenderChildren(), RenderComment(), RenderCssStyles(), RenderExtensionRenderer(), RenderHelper(), RenderHtmlAttributes(), RenderOutput(), RenderWithError(), RenderWithName(), RenderWrappedOutput(), ResetFlags(), ResetOnPageStatus(), SetCustomAttribute(), SetCustomStyle(), SetFocus(), SetForm(), SetParentControl(), Sleep(), SleepHelper(), ValidateControlAndChildren(), ValidationReset(), VarExport(), Wakeup(), WakeupHelper(), Watch(), _CallActionMethod(), _ProcessActionParams(), _ReadState(), _WriteState(), __construct()

Methods inherited from QHtmlAttributeManagerBase
`AddCssClass(), GetCssStyle(), GetDataAttribute(), GetHtmlAttribute(), GetHtmlAttributes(), HasCssClass(), HasCssStyle(), HasHtmlAttribute(), Override(), RemoveCssClass(), RemoveCssClassesByPrefix(), RemoveCssStyle(), RemoveDataAttribute(), RemoveHtmlAttribute(), RenderTag(), SetCssBoxValue(), SetCssClass(), SetCssStyle(), SetDataAttribute(), SetHtmlAttribute()`

Methods inherited from QBaseClass
`OverrideAttributes(), __call()`

Constants inherited from QControlBase
`CommentEnd, CommentStart`

Properties summary
`protected string`	`$strTag` Tag for rendering the control Tag for rendering the control	# `'input'`
`protected boolean`	`$blnIsVoidElement`	# `true`
`protected string`	`$strText` Text opposite to the checkbox Text opposite to the checkbox	# `null`
`protected QTextAlign\|string`	`$strTextAlign` the alignment of the string the alignment of the string	# `QTextAlign::Right`
`protected boolean`	`$blnHtmlEntities` Should the htmlentities function be run on the control's text (strText)? Should the htmlentities function be run on the control's text (strText)?	# `true`
`protected boolean`	`$blnChecked` Determines whether the checkbox is checked? Determines whether the checkbox is checked?	# `false`
`protected QTagStyler`	`$objLabelStyle` for labels of checkboxes. If side-by-side labeling, the styles will be applied to a span that wraps both the checkbox and the label. for labels of checkboxes. If side-by-side labeling, the styles will be applied to a span that wraps both the checkbox and the label.	#

Properties inherited from QControlBase
$blnActionsMustTerminate, $blnAutoRender, $blnDisplay, $blnIsBlockElement, $blnMinimize, $blnModified, $blnOnPage, $blnRendered, $blnRendering, $blnRequired, $blnSaveState, $blnScriptsOnly, $blnUseWrapper, $blnVisible, $blnWrapLabel, $blnWrapperModified, $mixActionParameter, $mixCausesValidation, $objActionArray, $objChildControlArray, $objDraggable, $objDroppable, $objForm, $objLinkedNode, $objParentControl, $objResizable, $objWatcher, $objWrapperStyler, $strAttributeScripts, $strControlId, $strCssClass, $strCustomAttributeArray, $strCustomStyleArray, $strFormAttributes, $strHtmlAfter, $strHtmlBefore, $strInstructions, $strJavaScripts, $strName, $strPreferredRenderMethod, $strRenderMethod, $strStyleSheets, $strValidationError, $strWarning

Properties inherited from QHtmlAttributeManagerBase
`$attributes, $styles`

Magic properties summary
`public string`	`$Text` is used to display text that is displayed next to the checkbox. The text is rendered as an html "Label For" the checkbox.
`public string`	`$TextAlign` specifies if "Text" should be displayed to the left or to the right of the checkbox.
`public boolean`	`$Checked` specifices whether or not hte checkbox is checked
`public boolean`	`$HtmlEntities` specifies whether the checkbox text will have to be run through htmlentities or not.

Magic properties inherited from QControlBase
`$ActionParameter, $ActionsMustTerminate, $AutoRender, $CausesValidation, $ControlId, $Form, $FormAttributes, $HtmlAfter, $HtmlBefore, $Instructions, $JavaScripts, $LinkedNode, $Minimize, $Modified, $Moveable, $Name, $OnPage, $ParentControl, $PreferredRenderMethod, $RenderMethod, $Rendered, $Rendering, $Required, $Resizable, $SaveState, $ScriptsOnly, $StyleSheets, $UseWrapper, $ValidationError, $Visible, $Warning, $WrapLabel, $WrapperCssClass, $WrapperModified`

Magic properties inherited from QHtmlAttributeManagerBase
`$AccessKey, $AltText, $BackColor, $BorderCollapse, $BorderColor, $BorderStyle, $BorderWidth, $CssClass, $Cursor, $Data, $Display, $DisplayStyle, $Enabled, $FontBold, $FontItalic, $FontNames, $FontOverline, $FontSize, $FontStrikeout, $FontUnderline, $ForeColor, $Height, $HorizontalAlign, $Left, $Margin, $NoWrap, $Opacity, $OrderedListType, $Overflow, $Padding, $Position, $ReadOnly, $TabIndex, $ToolTip, $Top, $UnorderedListStyle, $VerticalAlign, $Width`

Packages

Classes

Traits

Exceptions

Functions

Class QCheckBox

Direct known subclasses

Indirect known subclasses

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Overrides

Parameters

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Overrides