|
Class TCheckBoxList
TCheckBoxList class
TCheckBoxList displays a list of checkboxes on a Web page.
The layout of the checkbox list is specified via setRepeatLayout
RepeatLayout, 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', setCellPadding CellPadding and setCellSpacing CellSpacing can be used
to adjust the cellpadding and cellpadding of the table.
The number of columns used to display the checkboxes is specified via setRepeatColumns RepeatColumns property, while the setRepeatDirection
RepeatDirection governs the order of the items being rendered.
The alignment of the text besides each checkbox can be specified via setTextAlign TextAlign.
-
TComponent
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TWebControl
implements
IStyleable
-
TDataBoundControl
-
TListControl
implements
IDataRenderer
-
TCheckBoxList
implements
IRepeatInfoUser,
INamingContainer,
IPostBackDataHandler,
IValidatable
Methods summary
public
|
#
__construct( )
Constructor. Remember to call parent implementation if you override this
method
Constructor. Remember to call parent implementation if you override this
method
Overrides
|
protected
TControl
|
#
createRepeatedControl( )
Creates a control used for repetition (used as a template).
Creates a control used for repetition (used as a template).
Returns
|
public
TControl
|
#
findControl( string $id, mixed $real = false )
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.)
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.)
Parameters
- $id
string control ID
- $real
Returns
Throws
Overrides
|
protected
boolean
|
#
getIsMultiSelect( )
Returns
boolean whether this control supports multiple selection. Always true for checkbox list.
Overrides
|
protected
TStyle
|
#
createStyle( )
Creates a style object for the control. This method creates a TTableStyle to be used by checkbox list.
Creates a style object for the control. This method creates a TTableStyle to be used by checkbox list.
Returns
TStyle
control style to be used
Overrides
|
public
TTextAlign
|
#
getTextAlign( )
Returns
TTextAlign
the alignment of the text caption, defaults to TTextAlign::Right.
|
public
|
|
protected
TRepeatInfo
|
#
getRepeatInfo( )
Returns
TRepeatInfo
repeat information (primarily used by control developers)
|
public
integer
|
#
getRepeatColumns( )
Returns
integer the number of columns that the list should be displayed with. Defaults to 0
meaning not set.
|
public
|
#
setRepeatColumns( integer $value )
Parameters
- $value
integer the number of columns that the list should be displayed with.
|
public
string
|
#
getRepeatDirection( )
Returns
string the direction of traversing the list, defaults to 'Vertical'
|
public
|
#
setRepeatDirection( string $value )
Parameters
- $value
string the direction (Vertical, Horizontal) of traversing the list
|
public
string
|
#
getRepeatLayout( )
Returns
string how the list should be displayed, using table or using line breaks. Defaults to
'Table'.
|
public
|
#
setRepeatLayout( string $value )
Parameters
- $value
string how the list should be displayed, using table or using line breaks (Table, Flow)
|
public
integer
|
#
getCellSpacing( )
Returns
integer the cellspacing for the table keeping the checkbox list. Defaults to -1, meaning
not set.
|
public
|
#
setCellSpacing( integer $value )
Sets the cellspacing for the table keeping the checkbox list.
Sets the cellspacing for the table keeping the checkbox list.
Parameters
- $value
integer the cellspacing for the table keeping the checkbox list.
|
public
integer
|
#
getCellPadding( )
Returns
integer the cellpadding for the table keeping the checkbox list. Defaults to -1, meaning
not set.
|
public
|
#
setCellPadding( integer $value )
Sets the cellpadding for the table keeping the checkbox list.
Sets the cellpadding for the table keeping the checkbox list.
Parameters
- $value
integer the cellpadding for the table keeping the checkbox list.
|
public
boolean
|
#
getHasSeparators( )
Returns a value indicating whether this control contains separator items.
This method is required by IRepeatInfoUser interface.
Returns a value indicating whether this control contains separator items.
This method is required by IRepeatInfoUser interface.
Returns
boolean always false.
Implementation of
|
public
|
#
setEnabled( boolean $value )
Parameters
- $value
boolean whether the control is to be enabled.
Overrides
|
public
null
|
#
generateItemStyle( string $itemType, integer $index )
Returns a style used for rendering items. This method is required by IRepeatInfoUser interface.
Returns a style used for rendering items. This method is required by IRepeatInfoUser interface.
Parameters
- $itemType
string item type
(Header,Footer,Item,AlternatingItem,SelectedItem,EditItem,Separator,Pager)
- $index
integer index of the item being rendered
Returns
null
Implementation of
|
public
|
#
renderItem( THtmlWriter $writer, TRepeatInfo $repeatInfo, string $itemType, integer $index )
Renders an item in the list. This method is required by IRepeatInfoUser interface.
Renders an item in the list. This method is required by IRepeatInfoUser interface.
Parameters
- $writer
THtmlWriter
writer for rendering purpose
- $repeatInfo
TRepeatInfo
repeat information
- $itemType
string item type
(Header,Footer,Item,AlternatingItem,SelectedItem,EditItem,Separator,Pager)
- $index
integer zero-based index of the item in the item list
Implementation of
|
public
boolean
|
#
loadPostData( string $key, array $values )
Loads user input data. This method is primarly used by framework
developers.
Loads user input data. This method is primarly used by framework
developers.
Parameters
- $key
string the key that can be used to retrieve data from the input data collection
- $values
array the input data collection
Returns
boolean whether the data of the control has been changed
Implementation of
|
public
|
#
raisePostDataChangedEvent( )
Raises postdata changed event. This method is required by IPostBackDataHandler interface. It is invoked by the framework when getSelectedIndices SelectedIndices property is changed on postback. This method
is primarly used by framework developers.
Raises postdata changed event. This method is required by IPostBackDataHandler interface. It is invoked by the framework when getSelectedIndices SelectedIndices property is changed on postback. This method
is primarly used by framework developers.
Implementation of
|
public
|
#
onPreRender( mixed $param )
Registers for post data on postback. This method overrides the parent
implementation.
Registers for post data on postback. This method overrides the parent
implementation.
Parameters
- $param
mixed event parameter
Overrides
|
protected
boolean
|
#
getSpanNeeded( )
Wether the list should be rendered inside a span or not
Wether the list should be rendered inside a span or not
Returns
boolean true if we need a span
|
public
|
#
render( THtmlWriter $writer )
Renders the checkbox list control. This method overrides the parent
implementation.
Renders the checkbox list control. This method overrides the parent
implementation.
Parameters
Overrides
|
public
boolean
|
#
getDataChanged( )
Returns a value indicating whether postback has caused the control data
change. This method is required by the IPostBackDataHandler interface.
Returns a value indicating whether postback has caused the control data
change. This method is required by the IPostBackDataHandler interface.
Returns
boolean whether postback has caused the control data change. False if the page is not in
postback mode.
Implementation of
|
public
mixed
|
#
getValidationPropertyValue( )
Returns the value to be validated. This methid is required by IValidatable
interface.
Returns the value to be validated. This methid is required by IValidatable
interface.
Returns
mixed the value of the property to be validated.
Implementation of
|
public
boolean
|
#
getIsValid( )
Returns true if this control validated successfully. Defaults to true.
Returns true if this control validated successfully. Defaults to true.
Returns
boolean wether this control validated successfully.
Implementation of
|
public
boolean
|
#
setIsValid( boolean $value )
Parameters
- $value
boolean wether this control is valid.
Returns
boolean wether this control's validators validated successfully
Implementation of
|
protected
string
|
#
getClientClassName( )
Gets the name of the javascript class responsible for performing postback for
this control. This method overrides the parent implementation.
Gets the name of the javascript class responsible for performing postback for
this control. This method overrides the parent implementation.
Returns
string the javascript class name
Overrides
|
protected
array
|
#
getPostBackOptions( )
Gets the post back options for this checkbox.
Gets the post back options for this checkbox.
Returns
array
Overrides
|
Methods inherited from TListControl
addAttributesToRender(),
addParsedObject(),
clearSelection(),
createListItemCollection(),
formatDataValue(),
getAppendDataBoundItems(),
getAutoPostBack(),
getCausesValidation(),
getData(),
getDataGroupField(),
getDataTextField(),
getDataTextFormatString(),
getDataValueField(),
getEnableClientScript(),
getHasItems(),
getItemCount(),
getItems(),
getPromptText(),
getPromptValue(),
getSelectedIndex(),
getSelectedIndices(),
getSelectedItem(),
getSelectedValue(),
getSelectedValues(),
getTagName(),
getText(),
getValidationGroup(),
loadState(),
onSelectedIndexChanged(),
onTextChanged(),
performDataBinding(),
renderClientControlScript(),
renderContents(),
renderPrompt(),
saveState(),
setAppendDataBoundItems(),
setAutoPostBack(),
setCausesValidation(),
setData(),
setDataGroupField(),
setDataTextField(),
setDataTextFormatString(),
setDataValueField(),
setEnableClientScript(),
setPromptText(),
setPromptValue(),
setSelectedIndex(),
setSelectedIndices(),
setSelectedValue(),
setSelectedValues(),
setText(),
setValidationGroup()
|
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(),
pagePreLoad(),
setAllowCustomPaging(),
setAllowPaging(),
setCurrentPageIndex(),
setDataMember(),
setDataSource(),
setDataSourceID(),
setInitialized(),
setIsDataBound(),
setPageSize(),
setRequiresDataBinding(),
setVirtualItemCount(),
validateDataSource()
|
Methods inherited from TWebControl
clearStyle(),
copyBaseAttributes(),
getAccessKey(),
getBackColor(),
getBorderColor(),
getBorderStyle(),
getBorderWidth(),
getCssClass(),
getDecorator(),
getDisplay(),
getEnsureId(),
getFont(),
getForeColor(),
getHasStyle(),
getHeight(),
getStyle(),
getTabIndex(),
getToolTip(),
getWidth(),
renderBeginTag(),
renderEndTag(),
setAccessKey(),
setBackColor(),
setBorderColor(),
setBorderStyle(),
setBorderWidth(),
setCssClass(),
setDisplay(),
setEnsureId(),
setForeColor(),
setHeight(),
setStyle(),
setTabIndex(),
setToolTip(),
setWidth()
|
Methods inherited from TControl
__get(),
addToPostDataLoader(),
addedControl(),
applyStyleSheetSkin(),
autoBindProperty(),
autoDataBindProperties(),
bindProperty(),
broadcastEvent(),
bubbleEvent(),
clearChildState(),
clearControlState(),
clearNamingContainer(),
clearViewState(),
convertUniqueIdToClientId(),
createChildControls(),
createControlCollection(),
dataBindChildren(),
dataBindProperties(),
ensureChildControls(),
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(),
loadStateRecursive(),
onDataBinding(),
onLoad(),
onUnload(),
preRenderRecursive(),
raiseBubbleEvent(),
registerObject(),
removeAttribute(),
removedControl(),
renderChildren(),
renderControl(),
saveStateRecursive(),
setAdapter(),
setAttribute(),
setChildControlsCreated(),
setControlStage(),
setControlState(),
setCustomData(),
setEnableTheming(),
setEnableViewState(),
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
|
|