[ Index ]
 

Code source de PRADO 3.0.6

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/framework/Web/UI/WebControls/ -> TCheckBoxList.php (sommaire)

TCheckBoxList class file

Author: Qiang Xue <qiang.xue@gmail.com>
Copyright: Copyright © 2005 PradoSoft
License: http://www.pradosoft.com/license/
Version: $Id: TCheckBoxList.php 1397 2006-09-07 07:55:53Z wei $
Poids: 405 lignes (12 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 1 class

TCheckBoxList:: (29 méthodes):
  __construct()
  createRepeatedControl()
  findControl()
  getIsMultiSelect()
  createStyle()
  getClientClassName()
  getTextAlign()
  setTextAlign()
  getRepeatInfo()
  getRepeatColumns()
  setRepeatColumns()
  getRepeatDirection()
  setRepeatDirection()
  getRepeatLayout()
  setRepeatLayout()
  getCellSpacing()
  setCellSpacing()
  getCellPadding()
  setCellPadding()
  getHasHeader()
  getHasFooter()
  getHasSeparators()
  generateItemStyle()
  renderItem()
  loadPostData()
  raisePostDataChangedEvent()
  onPreRender()
  render()
  getValidationPropertyValue()


Classe: TCheckBoxList  - X-Ref

TCheckBoxList class

TCheckBoxList displays a list of checkboxes on a Web page.

The layout of the checkbox list is specified via {@link 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', {@link setCellPadding CellPadding} and
{@link 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
{@link setRepeatColumns RepeatColumns} property, while the {@link setRepeatDirection RepeatDirection}
governs the order of the items being rendered.

The alignment of the text besides each checkbox can be specified via {@link setTextAlign TextAlign}.

__construct()   X-Ref
Constructor.
Remember to call parent implementation if you override this method


createRepeatedControl()   X-Ref
Creates a control used for repetition (used as a template).

return: TControl the control to be repeated

findControl($id)   X-Ref
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.)

param: string control ID
return: TControl control being found

getIsMultiSelect()   X-Ref

return: boolean whether this control supports multiple selection. Always true for checkbox list.

createStyle()   X-Ref
Creates a style object for the control.
This method creates a {@link TTableStyle} to be used by checkbox list.

return: TStyle control style to be used

getClientClassName()   X-Ref
Gets the name of the javascript class responsible for performing postback for this control.
This method overrides the parent implementation.

return: string the javascript class name

getTextAlign()   X-Ref

return: TTextAlign the alignment of the text caption, defaults to TTextAlign::Right.

setTextAlign($value)   X-Ref

param: TTextAlign the text alignment of the checkboxes

getRepeatInfo()   X-Ref

return: TRepeatInfo repeat information (primarily used by control developers)

getRepeatColumns()   X-Ref

return: integer the number of columns that the list should be displayed with. Defaults to 0 meaning not set.

setRepeatColumns($value)   X-Ref

param: integer the number of columns that the list should be displayed with.

getRepeatDirection()   X-Ref

return: string the direction of traversing the list, defaults to 'Vertical'

setRepeatDirection($value)   X-Ref

param: string the direction (Vertical, Horizontal) of traversing the list

getRepeatLayout()   X-Ref

return: string how the list should be displayed, using table or using line breaks. Defaults to 'Table'.

setRepeatLayout($value)   X-Ref

param: string how the list should be displayed, using table or using line breaks (Table, Flow)

getCellSpacing()   X-Ref

return: integer the cellspacing for the table keeping the checkbox list. Defaults to -1, meaning not set.

setCellSpacing($value)   X-Ref
Sets the cellspacing for the table keeping the checkbox list.

param: integer the cellspacing for the table keeping the checkbox list.

getCellPadding()   X-Ref

return: integer the cellpadding for the table keeping the checkbox list. Defaults to -1, meaning not set.

setCellPadding($value)   X-Ref
Sets the cellpadding for the table keeping the checkbox list.

param: integer the cellpadding for the table keeping the checkbox list.

getHasHeader()   X-Ref
Returns a value indicating whether this control contains header item.
This method is required by {@link IRepeatInfoUser} interface.

return: boolean always false.

getHasFooter()   X-Ref
Returns a value indicating whether this control contains footer item.
This method is required by {@link IRepeatInfoUser} interface.

return: boolean always false.

getHasSeparators()   X-Ref
Returns a value indicating whether this control contains separator items.
This method is required by {@link IRepeatInfoUser} interface.

return: boolean always false.

generateItemStyle($itemType,$index)   X-Ref
Returns a style used for rendering items.
This method is required by {@link IRepeatInfoUser} interface.

param: string item type (Header,Footer,Item,AlternatingItem,SelectedItem,EditItem,Separator,Pager)
param: integer index of the item being rendered
return: null

renderItem($writer,$repeatInfo,$itemType,$index)   X-Ref
Renders an item in the list.
This method is required by {@link IRepeatInfoUser} interface.

param: THtmlWriter writer for rendering purpose
param: TRepeatInfo repeat information
param: string item type (Header,Footer,Item,AlternatingItem,SelectedItem,EditItem,Separator,Pager)
param: integer zero-based index of the item in the item list

loadPostData($key,$values)   X-Ref
Loads user input data.
This method is primarly used by framework developers.

param: string the key that can be used to retrieve data from the input data collection
param: array the input data collection
return: boolean whether the data of the control has been changed

raisePostDataChangedEvent()   X-Ref
Raises postdata changed event.
This method is required by {@link IPostBackDataHandler} interface.
It is invoked by the framework when {@link getSelectedIndices SelectedIndices} property
is changed on postback.
This method is primarly used by framework developers.


onPreRender($param)   X-Ref
Registers for post data on postback.
This method overrides the parent implementation.

param: mixed event parameter

render($writer)   X-Ref
Renders the checkbox list control.
This method overrides the parent implementation.

param: THtmlWriter writer for rendering purpose.

getValidationPropertyValue()   X-Ref
Returns the value to be validated.
This methid is required by IValidatable interface.

return: mixed the value of the property to be validated.



Généré le : Sun Feb 25 21:07:04 2007 par Balluche grâce à PHPXref 0.7