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

TBulletedList class file

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

Définit 4 classes

TBulletedList:: (27 méthodes):
  raisePostBackEvent()
  getTagName()
  getClientClassName()
  addAttributesToRender()
  getBulletImageUrl()
  setBulletImageUrl()
  getBulletStyle()
  setBulletStyle()
  getDisplayMode()
  setDisplayMode()
  getFirstBulletNumber()
  setFirstBulletNumber()
  onClick()
  getTarget()
  setTarget()
  render()
  renderContents()
  renderBulletText()
  renderTextItem()
  renderHyperLinkItem()
  renderLinkButtonItem()
  getPostBackOptions()
  canCauseValidation()
  setAutoPostBack()
  setSelectedIndex()
  setSelectedIndices()
  setSelectedValue()

TBulletedListEventParameter:: (2 méthodes):
__construct()
getIndex()

TBulletStyle:: (0 méthodes):

TBulletedListDisplayMode:: (0 méthodes):

Classe: TBulletedList - X-Ref

TBulletedList class

TBulletedList displays items in a bullet format.
The bullet style is specified by {@link setBulletStyle BulletStyle}. When
the style is 'CustomImage', the {@link setBackImageUrl BulletImageUrl}
specifies the image used as bullets.

TBulletedList displays the item texts in three different modes, specified
via {@link setDisplayMode DisplayMode}. When the mode is Text, the item texts
are displayed as static texts; When the mode is 'HyperLink', each item
is displayed as a hyperlink whose URL is given by the item value, and the
{@link setTarget Target} property can be used to specify the target browser window;
When the mode is 'LinkButton', each item is displayed as a link button which
posts back to the page if a user clicks on that and the event {@link onClick OnClick}
will be raised under such a circumstance.

raisePostBackEvent($param) X-Ref

Raises the postback event.
This method is required by {@link IPostBackEventHandler} interface.
If {@link getCausesValidation CausesValidation} is true, it will
invoke the page's {@link TPage::validate validate} method first.
It will raise {@link onClick OnClick} events.
This method is mainly used by framework and control developers.

param: TEventParameter the event parameter

getTagName() X-Ref

return: string tag name of the bulleted list

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

addAttributesToRender($writer) X-Ref

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

param: THtmlWriter the writer used for the rendering purpose

getBulletImageUrl() X-Ref

return: string image URL used for bullets when {@link getBulletStyle BulletStyle} is 'CustomImage'.

setBulletImageUrl($value) X-Ref

param: string image URL used for bullets when {@link getBulletStyle BulletStyle} is 'CustomImage'.

getBulletStyle() X-Ref

return: TBulletStyle style of bullets. Defaults to TBulletStyle::NotSet.

setBulletStyle($value) X-Ref

param: TBulletStyle style of bullets.

getDisplayMode() X-Ref

return: TBulletedListDisplayMode display mode of the list. Defaults to TBulletedListDisplayMode::Text.

setDisplayMode($value) X-Ref

return: TBulletedListDisplayMode display mode of the list.

getFirstBulletNumber() X-Ref

return: integer starting index when {@link getBulletStyle BulletStyle} is one of

setFirstBulletNumber($value) X-Ref

param: integer starting index when {@link getBulletStyle BulletStyle} is one of

onClick($param) X-Ref

Raises 'OnClick' event.
This method is invoked when the {@link getDisplayMode DisplayMode} is 'LinkButton'
and end-users click on one of the buttons.

param: TBulletedListEventParameter event parameter.

getTarget() X-Ref

return: string the target window or frame to display the Web page content

setTarget($value) X-Ref

param: string the target window or frame to display the Web page content

render($writer) X-Ref

Renders the control.

param: THtmlWriter the writer for the rendering purpose.

renderContents($writer) X-Ref

Renders the body contents.

param: THtmlWriter the writer for the rendering purpose.

renderBulletText($writer,$item,$index) X-Ref

Renders each item

param: THtmlWriter writer for the rendering purpose
param: TListItem item to be rendered
param: integer index of the item being rendered

renderTextItem($writer, $item, $index) X-Ref

Pas de description

renderHyperLinkItem($writer, $item, $index) X-Ref

Pas de description

renderLinkButtonItem($writer, $item, $index) X-Ref

Pas de description

getPostBackOptions() X-Ref

return: array postback options used for linkbuttons.

canCauseValidation() X-Ref

Pas de description

setAutoPostBack($value) X-Ref

setSelectedIndex($index) X-Ref

setSelectedIndices($indices) X-Ref

setSelectedValue($value) X-Ref

Classe: TBulletedListEventParameter - X-Ref

TBulletedListEventParameter
Event parameter for {@link TBulletedList::onClick Click} event of the
bulleted list. The {@link getIndex Index} gives the zero-based index
of the item that is currently being clicked.

__construct($index) X-Ref

Constructor.

param: integer index of the item clicked

getIndex() X-Ref

return: integer zero-based index of the item (rendered as a link button) that is clicked

Classe: TBulletStyle - X-Ref

TBulletStyle class.
TBulletStyle defines the enumerable type for the possible bullet styles that may be used
for a {@link TBulletedList} control.

Classe: TBulletedListDisplayMode - X-Ref

TBulletedListDisplayMode class.
TBulletedListDisplayMode defines the enumerable type for the possible display mode
of a {@link TBulletedList} control.

The following enumerable values are defined:
- Text: the bulleted list items are displayed as plain texts
- HyperLink: the bulleted list items are displayed as hyperlinks
- LinkButton: the bulleted list items are displayed as link buttons that can cause postbacks

Code source de PRADO 3.0.6

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

Définit 4 classes