Class \Prado\Web\UI\WebControls\TBaseDataList

TBaseDataList class

TBaseDataList is the base class for data listing controls, including TDataList and TDataGrid.

The key field in the data source is specified by \Prado\Web\UI\WebControls\setKeyField, while \Prado\Web\UI\WebControls\getKeyValues stores the key values of each record in a data listing control. You may use the list item index to obtain the corresponding database key value.

TBaseDataList also implements a few properties used for presentation based on tabular layout. The \Prado\Web\UI\WebControls\setCaption, whose alignment is specified via \Prado\Web\UI\WebControls\setCaptionAlign, is rendered as the table caption. The table cellpadding and cellspacing are specified by \Prado\Web\UI\WebControls\setCellPadding and \Prado\Web\UI\WebControls\setCellSpacing properties, respectively. The \Prado\Web\UI\WebControls\setGridLines specifies how the table should display its borders, and the horizontal alignment of the table content can be specified via \Prado\Web\UI\WebControls\setHorizontalAlign.

Class hierarchy

\Prado\Web\UI\WebControls\TBaseDataList

\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 deprecated`	`getCellPadding() : int`
`public deprecated`	`getCellSpacing() : int`
`public`	`getDataKeyField() : string`
`public`	`getDataKeys() : TList`
`public`	`getGridLines() : TTableGridLines`
`public`	`getHorizontalAlign() : THorizontalAlign`
`public`	`onSelectedIndexChanged(mixed $param) : mixed` Raises OnSelectedIndexChanged event. This method is invoked when a different item is selected in a data listing control between posts to the server.
`public deprecated`	`setCellPadding(int $value) : mixed`
`public deprecated`	`setCellSpacing(int $value) : mixed`
`public`	`setDataKeyField(string $value) : mixed`
`public`	`setGridLines(TTableGridLines $value) : mixed` Sets the grid line style of the table layout.
`public`	`setHorizontalAlign(THorizontalAlign $value) : mixed`
`protected`	`createStyle() : TTableStyle` Creates a style object for the control. This method creates a TTableStyle to be used by the data list control.
`protected`	`getDataFieldValue(mixed $data, mixed $field) : mixed` Returns the value of the data at the specified field. If data is an array, TMap or TList, the value will be returned at the index of the specified field. If the data is a component with a property named as the field name, the property value will be returned. Otherwise, an exception will be raised.

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, dataSourceViewChanged, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAccessKey, getAdapter, getAllowChildControls, getAllowCustomPaging, getAllowPaging, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getBackColor, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getClassHierarchy, getClientID, getControls, getCssClass, getCurrentPageIndex, getCustomData, getDataMember, getDataSource, getDataSourceID, getDecorator, getDisplay, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getEventHandlers, getFont, getForeColor, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasStyle, getHeight, getID, getIsSkinApplied, getListeningToGlobalEvents, getNamingContainer, getPage, getPageCount, getPageSize, getParent, getPluginModule, getRegisteredObject, getRequest, getResponse, getSelectParameters, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getToolTip, getUniqueID, getUser, getViewState, getVirtualItemCount, getVisible, getWidth, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadState, onDataBinding, onDataBound, onDataSourceChanged, onInit, onLoad, onPreRender, onUnload, pagePreLoad, publishAsset, publishFilePath, raiseEvent, registerObject, removeAttribute, removedControl, render, renderBeginTag, renderChildren, renderContents, renderControl, renderEndTag, saveState, setAccessKey, setAdapter, setAllowCustomPaging, setAllowPaging, setAttribute, setBackColor, setBorderColor, setBorderStyle, setBorderWidth, setCssClass, setCurrentPageIndex, setCustomData, setDataMember, setDataSource, setDataSourceID, setDisplay, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setForeColor, setHeight, setID, setPage, setPageSize, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setToolTip, setViewState, setVirtualItemCount, setVisible, setWidth, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, addAttributesToRender, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, createPagedDataSource, createStyle, dataBindChildren, dataBindProperties, determineDataSource, ensureDataBound, getCallChain, getChildControlsCreated, getClassFxEvents, getControlStage, getControlState, getDataSourceView, getInitialized, getIsDataBound, getRequiresDataBinding, getTagName, getUsingDataSourceID, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, performDataBinding, preRenderRecursive, raiseBubbleEvent, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, setInitialized, setIsDataBound, setRequiresDataBinding, traverseChildControls, unloadRecursive, validateDataSource, 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\TBaseDataList

Class hierarchy