Class \Prado\Web\UI\WebControls\TCheckBoxList

TCheckBoxList class

TCheckBoxList displays a list of checkboxes on a Web page.

The layout of the checkbox list is specified via \Prado\Web\UI\WebControls\setRepeatLayout, which can be either 'Table' (default) or 'Flow'. A table layout uses HTML table cells to organize the checkboxes while a flow layout uses line breaks to organize the checkboxes. When the layout is using 'Table', \Prado\Web\UI\WebControls\setCellPadding and \Prado\Web\UI\WebControls\setCellSpacing can be used to adjust the cellpadding and cellpadding of the table.

The number of columns used to display the checkboxes is specified via \Prado\Web\UI\WebControls\setRepeatColumns property, while the \Prado\Web\UI\WebControls\setRepeatDirection governs the order of the items being rendered.

The alignment of the text besides each checkbox can be specified via \Prado\Web\UI\WebControls\setTextAlign.

Class hierarchy

\Prado\Web\UI\WebControls\TCheckBoxList implements IRepeatInfoUser, INamingContainer, IPostBackDataHandler, IValidatable

\Prado\Web\UI\WebControls\TListControl implements IDataRenderer

\Prado\Web\UI\WebControls\TDataBoundControl

\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`	`__construct() : mixed` Constructor. Remember to call parent implementation if you override this method
`public`	`findControl(string $id[, bool $real = false ]) : TControl` Finds a control by ID. This method overrides the parent implementation so that it always returns the checkbox list itself (because the checkbox list does not have child controls.)
`public`	`generateItemStyle(string $itemType, int $index) : null` Returns a style used for rendering items. This method is required by IRepeatInfoUser interface.
`public deprecated`	`getCellPadding() : int`
`public deprecated`	`getCellSpacing() : int`
`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`	`getHasFooter() : bool` Returns a value indicating whether this control contains footer item. This method is required by IRepeatInfoUser interface.
`public`	`getHasHeader() : bool` Returns a value indicating whether this control contains header item. This method is required by IRepeatInfoUser interface.
`public`	`getHasSeparators() : bool` Returns a value indicating whether this control contains separator items. This method is required by IRepeatInfoUser interface.
`public`	`getIsValid() : bool` Returns true if this control validated successfully. Defaults to true.
`public`	`getRepeatColumns() : int`
`public`	`getRepeatDirection() : string`
`public`	`getRepeatLayout() : string`
`public`	`getTextAlign() : TTextAlign`
`public`	`getValidationPropertyValue() : mixed` Returns the value to be validated. This methid is required by \Prado\Web\UI\IValidatable interface.
`public`	`loadPostData(string $key, array<string\|int, mixed> $values) : bool` Loads user input data. This method is primarly used by framework developers.
`public`	`onPreRender(mixed $param) : mixed` Registers for post data on postback. This method overrides the parent implementation.
`public`	`raisePostDataChangedEvent() : mixed` Raises postdata changed event. This method is required by IPostBackDataHandler interface. It is invoked by the framework when \Prado\Web\UI\WebControls\getSelectedIndices property is changed on postback. This method is primarly used by framework developers.
`public`	`render(THtmlWriter $writer) : mixed` Renders the checkbox list control. This method overrides the parent implementation.
`public`	`renderItem(THtmlWriter $writer, TRepeatInfo $repeatInfo, string $itemType, int $index) : mixed` Renders an item in the list. This method is required by IRepeatInfoUser interface.
`public deprecated`	`setCellPadding(int $value) : mixed` Sets the cellpadding for the table keeping the checkbox list.
`public deprecated`	`setCellSpacing(int $value) : mixed` Sets the cellspacing for the table keeping the checkbox list.
`public`	`setEnabled(bool $value) : mixed`
`public`	`setIsValid(bool $value) : mixed`
`public`	`setRepeatColumns(int $value) : mixed`
`public`	`setRepeatDirection(string $value) : mixed`
`public`	`setRepeatLayout(string $value) : mixed`
`public`	`setTextAlign(TTextAlign $value) : mixed`
`protected`	`createRepeatedControl() : TControl` Creates a control used for repetition (used as a template).
`protected`	`createStyle() : TStyle` Creates a style object for the control. This method creates a TTableStyle to be used by checkbox list.
`protected`	`getClientClassName() : string` Gets the name of the javascript class responsible for performing postback for this control. This method overrides the parent implementation.
`protected`	`getIsMultiSelect() : bool`
`protected`	`getPostBackOptions() : array<string\|int, mixed>` Gets the post back options for this checkbox.
`protected`	`getRepeatInfo() : TRepeatInfo`
`protected`	`getSpanNeeded() : bool` Wether the list should be rendered inside a span or not

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, clearSelection, clearStyle, clearViewState, convertUniqueIdToClientId, copyBaseAttributes, createChildControls, createdOnTemplate, dataBind, dataSourceViewChanged, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAccessKey, getAdapter, getAllowChildControls, getAllowCustomPaging, getAllowPaging, getAppendDataBoundItems, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getAutoPostBack, getBackColor, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getCausesValidation, getClassHierarchy, getClientID, getControls, getCssClass, getCurrentPageIndex, getCustomData, getData, getDataGroupField, getDataMember, getDataSource, getDataSourceID, getDataTextField, getDataTextFormatString, getDataValueField, getDecorator, getDisplay, getEnableClientScript, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getEventHandlers, getFont, getForeColor, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasItems, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasStyle, getHeight, getID, getIsSkinApplied, getItemCount, getItems, getListeningToGlobalEvents, getNamingContainer, getPage, getPageCount, getPageSize, getParent, getPluginModule, getPromptText, getPromptValue, getRegisteredObject, getRequest, getResponse, getSelectedIndex, getSelectedIndices, getSelectedItem, getSelectedValue, getSelectedValues, getSelectParameters, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getText, getToolTip, getUniqueID, getUser, getValidationGroup, getViewState, getVirtualItemCount, getVisible, getWidth, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadState, onDataBinding, onDataBound, onDataSourceChanged, onInit, onLoad, onPreRender, onSelectedIndexChanged, onTextChanged, onUnload, pagePreLoad, publishAsset, publishFilePath, raiseEvent, registerObject, removeAttribute, removedControl, render, renderBeginTag, renderChildren, renderContents, renderControl, renderEndTag, saveState, setAccessKey, setAdapter, setAllowCustomPaging, setAllowPaging, setAppendDataBoundItems, setAttribute, setAutoPostBack, setBackColor, setBorderColor, setBorderStyle, setBorderWidth, setCausesValidation, setCssClass, setCurrentPageIndex, setCustomData, setData, setDataGroupField, setDataMember, setDataSource, setDataSourceID, setDataTextField, setDataTextFormatString, setDataValueField, setDisplay, setEnableClientScript, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setForeColor, setHeight, setID, setPage, setPageSize, setPromptText, setPromptValue, setSelectedIndex, setSelectedIndices, setSelectedValue, setSelectedValues, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setText, setToolTip, setValidationGroup, setViewState, setVirtualItemCount, setVisible, setWidth, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, addAttributesToRender, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, createListItemCollection, createPagedDataSource, createStyle, dataBindChildren, dataBindProperties, determineDataSource, ensureDataBound, formatDataValue, getCallChain, getChildControlsCreated, getClassFxEvents, getClientClassName, getControlStage, getControlState, getDataSourceView, getInitialized, getIsDataBound, getIsMultiSelect, getPostBackOptions, getRequiresDataBinding, getTagName, getUsingDataSourceID, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, performDataBinding, preRenderRecursive, raiseBubbleEvent, renderClientControlScript, renderPrompt, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, setInitialized, setIsDataBound, setRequiresDataBinding, traverseChildControls, unloadRecursive, validateDataSource, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID, resetCachedSelections

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\TCheckBoxList

Class hierarchy