Class \Prado\Web\UI\WebControls\TDataBoundControl

TDataBoundControl class.

TDataBoundControl is the based class for controls that need to populate data from data sources. It provides basic properties and methods that allow the derived controls to associate with data sources and retrieve data from them.

TBC....

TDataBoundControl is equipped with paging capabilities. By setting \Prado\Web\UI\WebControls\setAllowPaging to true, the input data will be paged and only one page of data is actually populated into the data-bound control. This saves a lot of memory when dealing with larget datasets.

To specify the number of data items displayed on each page, set the \Prado\Web\UI\WebControls\setPageSize property, and to specify which page of data to be displayed, set \Prado\Web\UI\WebControls\setCurrentPageIndex.

When the size of the original data is too big to be loaded all in the memory, one can enable custom paging. In custom paging, the total number of data items is specified manually via \Prado\Web\UI\WebControls\setVirtualItemCount, and the data source only needs to contain the current page of data. To enable custom paging, set \Prado\Web\UI\WebControls\setAllowCustomPaging to true.

Class hierarchy

\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`	`dataBind() : mixed` Performs databinding. This method overrides the parent implementation by calling performSelect which fetches data from data source and does the actual binding work.
`public`	`dataSourceViewChanged(mixed $sender, mixed $param) : mixed`
`public`	`getAllowCustomPaging() : bool`
`public`	`getAllowPaging() : bool`
`public`	`getCurrentPageIndex() : int`
`public`	`getDataMember() : mixed`
`public`	`getDataSource() : Traversable`
`public`	`getDataSourceID() : string`
`public`	`getPageCount() : int`
`public`	`getPageSize() : int`
`public`	`getSelectParameters() : mixed`
`public`	`getVirtualItemCount() : int`
`public`	`onDataBound(mixed $param) : mixed` Raises <b>OnDataBound</b> event. This method should be invoked after a databind is performed. It is mainly used by framework and component developers.
`public`	`onDataSourceChanged() : mixed` Sets {@see setRequiresDataBinding RequiresDataBinding} as true if the control is initialized. This method is invoked when either setDataSource or setDataSourceID is changed.
`public`	`onInit(TEventParameter $param) : mixed` Sets page's <b>OnPreLoad</b> event handler as {@see pagePreLoad}. If viewstate is disabled and the current request is a postback, \Prado\Web\UI\WebControls\setRequiresDataBinding will be set true. This method overrides the parent implementation.
`public`	`onPreRender(TEventParameter $param) : mixed` Ensures any pending databind is performed. This method overrides the parent implementation.
`public`	`pagePreLoad(mixed $sender, TEventParameter $param) : mixed` Sets {@see getInitialized} as true. This method is invoked when page raises PreLoad event.
`public`	`setAllowCustomPaging(bool $value) : mixed` Sets a value indicating whether the custom paging should be enabled. When the pager is in custom paging mode, the \Prado\Web\UI\WebControls\setVirtualItemCount property is used to determine the paging, and the data items in the \Prado\Web\UI\WebControls\setDataSource are considered to be in the current page.
`public`	`setAllowPaging(bool $value) : mixed`
`public`	`setCurrentPageIndex(int $value) : mixed`
`public`	`setDataMember(mixed $value) : mixed`
`public`	`setDataSource(array<string\|int, mixed>\|string\|Traversable $value) : mixed` Sets the data source object associated with the databound control. The data source must implement \Traversable interface. If an array is given, it will be converted to xxx. If a string is given, it will be converted to xxx.
`public`	`setDataSourceID(string $value) : mixed`
`public`	`setPageSize(int $value) : mixed`
`public`	`setVirtualItemCount(int $value) : mixed`
`protected`	`createPagedDataSource() : TPagedDataSource`
`protected`	`determineDataSource() : mixed`
`protected`	`ensureDataBound() : mixed` Ensures any pending {@see dataBind} is called. This method calls dataBind if the data source is specified by setDataSourceID or if \Prado\Web\UI\WebControls\getRequiresDataBinding is true.
`protected`	`getDataSourceView() : mixed`
`protected`	`getInitialized() : bool`
`protected`	`getIsDataBound() : bool`
`protected`	`getRequiresDataBinding() : bool`
`protected`	`getUsingDataSourceID() : bool`
`protected abstract`	`performDataBinding(mixed $data) : mixed`
`protected`	`setInitialized(bool $value) : mixed` Sets a value indicating whether the databound control is initialized. If initialized, any modification to \Prado\Web\UI\WebControls\setDataSource or \Prado\Web\UI\WebControls\setDataSourceID will set \Prado\Web\UI\WebControls\setRequiresDataBinding as true.
`protected`	`setIsDataBound(bool $value) : mixed`
`protected`	`setRequiresDataBinding(bool $value) : mixed` Sets a value indicating whether a databind call is required by the data bound control. If true and the control has been prerendered while it uses the data source specified by setDataSourceID, a databind call will be called by this method.
`protected`	`validateDataSource(array<string\|int, mixed>\|string\|Traversable $value) : Traversable` Validates if the parameter is a valid data source. If it is a string or an array, it will be converted as a TList object.

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

Class hierarchy