Class \Prado\Web\UI\WebControls\TCheckBox

TCheckBox class

TCheckBox displays a check box on the page. You can specify the caption to display beside the check box by setting the \Prado\Web\UI\WebControls\setText property. The caption can appear either on the right or left of the check box, which is determined by the \Prado\Web\UI\WebControls\setTextAlign property.

To determine whether the TCheckBox component is checked, test the \Prado\Web\UI\WebControls\getChecked property. The \Prado\Web\UI\WebControls\onCheckedChanged event is raised when the \Prado\Web\UI\WebControls\getChecked state of the TCheckBox component changes between posts to the server. You can provide an event handler for the \Prado\Web\UI\WebControls\onCheckedChanged event to to programmatically control the actions performed when the state of the TCheckBox component changes between posts to the server.

If \Prado\Web\UI\WebControls\setAutoPostBack is set true, changing the check box state will cause postback action. And if \Prado\Web\UI\WebControls\setCausesValidation is true, validation will also be processed, which can be further restricted within a \Prado\Web\UI\WebControls\setValidationGroup.

Note, \Prado\Web\UI\WebControls\setText is rendered as is. Make sure it does not contain unwanted characters that may bring security vulnerabilities.

Class hierarchy

\Prado\Web\UI\WebControls\TCheckBox implements IPostBackDataHandler, IValidatable, IDataRenderer, ISurroundable

\Prado\Web\UI\WebControls\TWebControl implements IStyleable

\Prado\Web\UI\TControl implements IRenderable, IBindable

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`getAutoPostBack() : bool`
`public`	`getCausesValidation() : bool`
`public`	`getChecked() : bool`
`public`	`getData() : bool` Returns the value indicating whether the checkbox is checked. This method is required by IDataRenderer. It is the same as getChecked().
`public`	`getDataChanged() : bool` Returns a value indicating whether postback has caused the control data change. This method is required by the \Prado\Web\UI\IPostBackDataHandler interface.
`public`	`getEnableClientScript() : bool`
`public`	`getInputAttributes() : TMap`
`public`	`getIsValid() : bool` Returns true if this control validated successfully. Defaults to true.
`public`	`getLabelAttributes() : TMap`
`public`	`getSurroundingTag() : string`
`public`	`getSurroundingTagID() : string`
`public`	`getText() : string`
`public`	`getTextAlign() : TTextAlign`
`public`	`getValidationGroup() : string`
`public`	`getValidationPropertyValue() : mixed` Returns the value of the property that needs validation.
`public`	`getValue() : string`
`public`	`loadPostData(string $key, array<string\|int, mixed> $values) : bool` Loads user input data. This method is primarly used by framework developers.
`public`	`onCheckedChanged(TEventParameter $param) : mixed` Raises <b>OnCheckedChanged</b> event when {@see getChecked Checked} changes value during postback. If you override this method, be sure to call the parent implementation so that the event delegates can be invoked.
`public`	`onPreRender(mixed $param) : mixed` Registers the checkbox to receive postback data during postback. This is necessary because a checkbox if unchecked, when postback, does not have direct mapping between post data and the checkbox name. This method overrides the parent implementation and is invoked before render.
`public`	`raisePostDataChangedEvent() : mixed` Raises postdata changed event. This method raises \Prado\Web\UI\WebControls\onCheckedChanged event. This method is primarly used by framework developers.
`public`	`render(THtmlWriter $writer) : mixed` Renders the checkbox control. This method overrides the parent implementation by rendering a checkbox input element and a span element if needed.
`public`	`setAutoPostBack(bool $value) : mixed` Sets a value indicating whether clicking on the checkbox will post the page.
`public`	`setCausesValidation(bool $value) : mixed` Sets the value indicating whether postback event trigger by this checkbox will cause input validation.
`public`	`setChecked(bool $value) : mixed` Sets a value indicating whether the checkbox is to be checked or not.
`public`	`setData(bool $value) : mixed` Sets the value indicating whether the checkbox is to be checked or not. This method is required by IDataRenderer. It is the same as setChecked().
`public`	`setEnableClientScript(bool $value) : mixed`
`public`	`setIsValid(bool $value) : mixed`
`public`	`setText(string $value) : mixed` Sets the text caption of the checkbox.
`public`	`setTextAlign(TTextAlign $value) : mixed`
`public`	`setValidationGroup(string $value) : mixed`
`public`	`setValue(string $value) : mixed`
`protected`	`getClientClassName() : string` Gets the name of the javascript class responsible for performing postback for this control. This method overrides the parent implementation.
`protected`	`getPostBackOptions() : array<string\|int, mixed>` Gets the post back options for this checkbox.
`protected`	`getSpanNeeded() : bool` Check if we need a span tag to surround this control. The span tag will be created if the Text property is set for this control.
`protected`	`getTagName() : string` Returns the tag name used for this control.
`protected`	`getValueAttribute() : string`
`protected`	`renderClientControlScript(mixed $writer) : mixed` Renders the client-script code.
`protected`	`renderInputTag(THtmlWriter $writer, string $clientID, string $onclick) : mixed` Renders a checkbox input element.
`protected`	`renderLabel(THtmlWriter $writer, string $clientID, string $text) : mixed` Renders a label beside the checkbox.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addedControl, addParsedObject, applyStyleSheetSkin, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, autoBindProperty, bindProperty, broadcastEvent, bubbleEvent, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearNamingContainer, clearStyle, clearViewState, convertUniqueIdToClientId, copyBaseAttributes, createChildControls, createdOnTemplate, dataBind, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAccessKey, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getBackColor, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getClassHierarchy, getClientID, getControls, getCssClass, getCustomData, getDecorator, getDisplay, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getEventHandlers, getFont, getForeColor, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasStyle, getHeight, getID, getIsSkinApplied, getListeningToGlobalEvents, getNamingContainer, getPage, getParent, getPluginModule, getRegisteredObject, getRequest, getResponse, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getToolTip, getUniqueID, getUser, getViewState, getVisible, getWidth, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadState, onDataBinding, onInit, onLoad, onPreRender, onUnload, publishAsset, publishFilePath, raiseEvent, registerObject, removeAttribute, removedControl, render, renderBeginTag, renderChildren, renderContents, renderControl, renderEndTag, saveState, setAccessKey, setAdapter, setAttribute, setBackColor, setBorderColor, setBorderStyle, setBorderWidth, setCssClass, setCustomData, setDisplay, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setForeColor, setHeight, setID, setPage, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setToolTip, setViewState, setVisible, setWidth, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, addAttributesToRender, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, createStyle, dataBindChildren, dataBindProperties, getCallChain, getChildControlsCreated, getClassFxEvents, getControlStage, getControlState, getTagName, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, preRenderRecursive, raiseBubbleEvent, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, traverseChildControls, unloadRecursive, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID

Inherited constants
\Prado\Web\UI\TControl::AUTOMATIC_ID_PREFIX, \Prado\Web\UI\TControl::CLIENT_ID_SEPARATOR, \Prado\Web\UI\TControl::CS_CHILD_INITIALIZED, \Prado\Web\UI\TControl::CS_CONSTRUCTED, \Prado\Web\UI\TControl::CS_INITIALIZED, \Prado\Web\UI\TControl::CS_LOADED, \Prado\Web\UI\TControl::CS_PRERENDERED, \Prado\Web\UI\TControl::CS_STATE_LOADED, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Web\UI\TControl::ID_FORMAT, \Prado\Web\UI\TControl::ID_SEPARATOR, \Prado\Web\UI\TControl::IS_CHILD_CREATED, \Prado\Web\UI\TControl::IS_CREATING_CHILD, \Prado\Web\UI\TControl::IS_DISABLE_THEMING, \Prado\Web\UI\TControl::IS_DISABLE_VIEWSTATE, \Prado\Web\UI\TControl::IS_ID_SET, \Prado\Web\UI\TControl::IS_SKIN_APPLIED, \Prado\Web\UI\TControl::IS_STYLESHEET_APPLIED, \Prado\Web\UI\TControl::RF_ADAPTER, \Prado\Web\UI\TControl::RF_AUTO_BINDINGS, \Prado\Web\UI\TControl::RF_CHILD_STATE, \Prado\Web\UI\TControl::RF_CONTROLS, \Prado\Web\UI\TControl::RF_CONTROLSTATE, \Prado\Web\UI\TControl::RF_DATA_BINDINGS, \Prado\Web\UI\TControl::RF_EVENTS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS_ID, \Prado\Web\UI\TControl::RF_NAMED_OBJECTS, \Prado\Web\UI\TControl::RF_SKIN_ID

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\TCheckBox

Class hierarchy