|
Class 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 setKeyField
KeyField, while getKeyValues KeyValues 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 setCaption Caption, whose alignment is specified via
setCaptionAlign CaptionAlign, is rendered as the table caption. The
table cellpadding and cellspacing are specified by setCellPadding
CellPadding and setCellSpacing CellSpacing properties, respectively.
The setGridLines GridLines specifies how the table should display its
borders, and the horizontal alignment of the table content can be specified via
setHorizontalAlign HorizontalAlign.
-
TComponent
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TWebControl
implements
IStyleable
-
TDataBoundControl
-
TBaseDataList
Methods summary
protected
TTableStyle
|
#
createStyle( )
Creates a style object for the control. This method creates a TTableStyle to be used by the data list control.
Creates a style object for the control. This method creates a TTableStyle to be used by the data list control.
Returns
Overrides
|
public
integer
|
#
getCellSpacing( )
Returns
integer the cellspacing for the table layout. Defaults to -1, meaning not set.
|
public
|
#
setCellSpacing( integer $value )
Parameters
- $value
integer the cellspacing for the table layout.
|
public
integer
|
#
getCellPadding( )
Returns
integer the cellpadding for the table layout. Defaults to -1, meaning not set.
|
public
|
#
setCellPadding( integer $value )
Parameters
- $value
integer the cellpadding for the table layout
|
public
THorizontalAlign
|
#
getHorizontalAlign( )
Returns
THorizontalAlign
the horizontal alignment of the table content. Defaults to
THorizontalAlign::NotSet.
|
public
|
|
public
TTableGridLines
|
#
getGridLines( )
Returns
TTableGridLines
the grid line setting of the table layout. Defaults to TTableGridLines::None.
|
public
|
#
setGridLines( TTableGridLines $value )
Sets the grid line style of the table layout.
Sets the grid line style of the table layout.
Parameters
|
public
string
|
#
getDataKeyField( )
Returns
string the field of the data source that provides the keys of the list items.
|
public
|
#
setDataKeyField( string $value )
Parameters
- $value
string the field of the data source that provides the keys of the list items.
|
public
TList
|
#
getDataKeys( )
Returns
TList
the keys used in the data listing control.
|
protected
mixed
|
#
getDataFieldValue( mixed $data, mixed $field )
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.
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.
Parameters
- $data
mixed data item
- $field
mixed field name
Returns
mixed data value at the specified field
Throws
|
public
|
#
onSelectedIndexChanged( mixed $param )
Raises OnSelectedIndexChanged event. This method is invoked when a different
item is selected in a data listing control between posts to the server.
Raises OnSelectedIndexChanged event. This method is invoked when a different
item is selected in a data listing control between posts to the server.
Parameters
- $param
mixed event parameter
|
Methods inherited from TDataBoundControl
createPagedDataSource(),
dataBind(),
dataSourceViewChanged(),
determineDataSource(),
ensureDataBound(),
getAllowCustomPaging(),
getAllowPaging(),
getCurrentPageIndex(),
getDataMember(),
getDataSource(),
getDataSourceID(),
getDataSourceView(),
getInitialized(),
getIsDataBound(),
getPageCount(),
getPageSize(),
getRequiresDataBinding(),
getSelectParameters(),
getUsingDataSourceID(),
getVirtualItemCount(),
onDataBound(),
onDataSourceChanged(),
onInit(),
onPreRender(),
pagePreLoad(),
performDataBinding(),
setAllowCustomPaging(),
setAllowPaging(),
setCurrentPageIndex(),
setDataMember(),
setDataSource(),
setDataSourceID(),
setInitialized(),
setIsDataBound(),
setPageSize(),
setRequiresDataBinding(),
setVirtualItemCount(),
validateDataSource()
|
Methods inherited from TWebControl
addAttributesToRender(),
clearStyle(),
copyBaseAttributes(),
getAccessKey(),
getBackColor(),
getBorderColor(),
getBorderStyle(),
getBorderWidth(),
getCssClass(),
getDecorator(),
getDisplay(),
getEnsureId(),
getFont(),
getForeColor(),
getHasStyle(),
getHeight(),
getStyle(),
getTabIndex(),
getTagName(),
getToolTip(),
getWidth(),
render(),
renderBeginTag(),
renderContents(),
renderEndTag(),
setAccessKey(),
setBackColor(),
setBorderColor(),
setBorderStyle(),
setBorderWidth(),
setCssClass(),
setDisplay(),
setEnsureId(),
setForeColor(),
setHeight(),
setStyle(),
setTabIndex(),
setToolTip(),
setWidth()
|
Methods inherited from TControl
__construct(),
__get(),
addParsedObject(),
addToPostDataLoader(),
addedControl(),
applyStyleSheetSkin(),
autoBindProperty(),
autoDataBindProperties(),
bindProperty(),
broadcastEvent(),
bubbleEvent(),
clearChildState(),
clearControlState(),
clearNamingContainer(),
clearViewState(),
convertUniqueIdToClientId(),
createChildControls(),
createControlCollection(),
dataBindChildren(),
dataBindProperties(),
ensureChildControls(),
findControl(),
findControlsByID(),
findControlsByType(),
focus(),
getAdapter(),
getAllowChildControls(),
getAttribute(),
getAttributes(),
getChildControlsCreated(),
getClientID(),
getControlStage(),
getControlState(),
getControls(),
getCustomData(),
getEnableTheming(),
getEnableViewState(),
getEnabled(),
getHasAdapter(),
getHasAttributes(),
getHasChildInitialized(),
getHasControls(),
getHasInitialized(),
getHasLoaded(),
getHasLoadedPostData(),
getHasPreRendered(),
getID(),
getIsSkinApplied(),
getNamingContainer(),
getPage(),
getParent(),
getRegisteredObject(),
getSkinID(),
getSourceTemplateControl(),
getTemplateControl(),
getUniqueID(),
getViewState(),
getVisible(),
hasAttribute(),
initRecursive(),
isDescendentOf(),
isObjectRegistered(),
loadRecursive(),
loadState(),
loadStateRecursive(),
onDataBinding(),
onLoad(),
onUnload(),
preRenderRecursive(),
raiseBubbleEvent(),
registerObject(),
removeAttribute(),
removedControl(),
renderChildren(),
renderControl(),
saveState(),
saveStateRecursive(),
setAdapter(),
setAttribute(),
setChildControlsCreated(),
setControlStage(),
setControlState(),
setCustomData(),
setEnableTheming(),
setEnableViewState(),
setEnabled(),
setID(),
setPage(),
setSkinID(),
setTemplateControl(),
setViewState(),
setVisible(),
trackViewState(),
traverseChildControls(),
unbindProperty(),
unloadRecursive(),
unregisterObject()
|
Methods inherited from TComponent
__call(),
__destruct(),
__isset(),
__set(),
__sleep(),
__unset(),
__wakeup(),
asa(),
attachBehavior(),
attachBehaviors(),
attachClassBehavior(),
attachEventHandler(),
canGetProperty(),
canSetProperty(),
clearBehaviors(),
createdOnTemplate(),
detachBehavior(),
detachBehaviors(),
detachClassBehavior(),
detachEventHandler(),
disableBehavior(),
disableBehaviors(),
enableBehavior(),
enableBehaviors(),
evaluateExpression(),
evaluateStatements(),
fxAttachClassBehavior(),
fxDetachClassBehavior(),
getAutoGlobalListen(),
getBehaviorsEnabled(),
getClassHierarchy(),
getEventHandlers(),
getListeningToGlobalEvents(),
getSubProperty(),
hasEvent(),
hasEventHandler(),
hasProperty(),
isa(),
listen(),
raiseEvent(),
setSubProperty(),
unlisten()
|
Constants inherited from TControl
AUTOMATIC_ID_PREFIX,
CLIENT_ID_SEPARATOR,
CS_CHILD_INITIALIZED,
CS_CONSTRUCTED,
CS_INITIALIZED,
CS_LOADED,
CS_PRERENDERED,
CS_STATE_LOADED,
ID_FORMAT,
ID_SEPARATOR,
IS_CHILD_CREATED,
IS_CREATING_CHILD,
IS_DISABLE_THEMING,
IS_DISABLE_VIEWSTATE,
IS_ID_SET,
IS_SKIN_APPLIED,
IS_STYLESHEET_APPLIED,
RF_ADAPTER,
RF_AUTO_BINDINGS,
RF_CHILD_STATE,
RF_CONTROLS,
RF_CONTROLSTATE,
RF_DATA_BINDINGS,
RF_EVENTS,
RF_NAMED_CONTROLS,
RF_NAMED_CONTROLS_ID,
RF_NAMED_OBJECTS,
RF_SKIN_ID
|
|