PRADO 3.0.6 : Vue détaillée de TListBox.php

TListBox class file

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

Définit 2 classes

TListBox:: (11 méthodes):
  addAttributesToRender()
  getClientClassName()
  onPreRender()
  loadPostData()
  raisePostDataChangedEvent()
  getIsMultiSelect()
  getRows()
  setRows()
  getSelectionMode()
  setSelectionMode()
  getValidationPropertyValue()

TListSelectionMode:: (0 méthodes):

Classe: TListBox - X-Ref

TListBox class

TListBox displays a list box on a Web page that allows single or multiple selection.
The list box allows multiple selections if {@link setSelectionMode SelectionMode}
is TListSelectionMode::Multiple. It takes single selection only if Single.
The property {@link setRows Rows} specifies how many rows of options are visible
at a time. See {@link TListControl} for inherited properties.

Since v3.0.3, TListBox starts to support optgroup. To specify an option group for
a list item, set a Group attribute with it,
<code>
$listitem->Attributes->Group="Group Name";
// or <com:TListItem Attributes.Group="Group Name" .../> in template
</code>

addAttributesToRender($writer) X-Ref

Adds attribute name-value pairs to renderer.
This method overrides the parent implementation with additional list box specific attributes.

param: THtmlWriter the writer used for the rendering purpose

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

onPreRender($param) X-Ref

Registers the list control to load post data on postback.
This method overrides the parent implementation.

param: mixed event parameter

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 component 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.

getIsMultiSelect() X-Ref

return: boolean whether this control allows multiple selection

getRows() X-Ref

return: integer the number of rows to be displayed in the list control

setRows($value) X-Ref

param: integer the number of rows to be displayed in the list control

getSelectionMode() X-Ref

return: TListSelectionMode the selection mode (Single, Multiple). Defaults to TListSelectionMode::Single.

setSelectionMode($value) X-Ref

param: TListSelectionMode the selection mode

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.

Classe: TListSelectionMode - X-Ref

TListSelectionMode class.
TListSelectionMode defines the enumerable type for the possible selection modes of a {@link TListBox}.

The following enumerable values are defined:
- Single: single selection
- Multiple: allow multiple selection

Code source de PRADO 3.0.6

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

Définit 2 classes