## Class TRepeatInfo

Description

TRepeatInfo class.

TRepeatInfo represents repeat information for controls like TCheckBoxList. The layout of the repeated items is specified via RepeatLayout, which can be either Table (default), Flow or Raw. A table layout uses HTML table cells to organize the items while a flow layout uses line breaks to organize the items. The number of columns used to display the items is specified via RepeatColumns property, while the RepeatDirection governs the order of the items being rendered.

Note, the Raw layout does not contain any formatting tags and thus ignores the column and repeat direction settings.

- since: 3.0
- version: $Id: TRepeatInfo.php 2541 2008-10-21 15:05:13Z qiang.xue $
- author: Qiang Xue <qiang.xue@gmail.com>

Located in /Web/UI/WebControls/TRepeatInfo.php (line 77)

    TComponent
       |
       --TRepeatInfo

Method Summary
string getCaption ()
TTableCaptionAlign getCaptionAlign ()
integer getRepeatColumns ()
TRepeatDirection getRepeatDirection ()
TRepeatLayout getRepeatLayout ()
void renderFooter (THtmlWriter $writer, IRepeatInfoUser $user, boolean $tableLayout, integer $columns)
void renderHeader (THtmlWriter $writer, IRepeatInfoUser $user, boolean $tableLayout, integer $columns, boolean $needBreak)
void renderHorizontalContents (THtmlWriter $writer, IRepeatInfoUser $user)
void renderRawContents (THtmlWriter $writer, IRepeatInfoUser $user)
void renderRepeater (THtmlWriter $writer, IRepeatInfoUser $user)
void renderVerticalContents (THtmlWriter $writer, IRepeatInfoUser $user)
void setCaption (string $value)
TTableCaptionAlign setCaptionAlign (mixed $value)
void setRepeatColumns (integer $value)
void setRepeatDirection (TRepeatDirection $value)
void setRepeatLayout (TRepeatLayout $value)
Methods
getCaption (line 103)

- return: caption of the table layout
- access: public

string getCaption ()
getCaptionAlign (line 119)

- return: alignment of the caption of the table layout. Defaults to TTableCaptionAlign::NotSet.
- access: public

TTableCaptionAlign getCaptionAlign ()
getRepeatColumns (line 135)

- return: the number of columns that the repeated items should be displayed in. Defaults to 0, meaning not set.
- access: public

integer getRepeatColumns ()
getRepeatDirection (line 153)

- return: the direction of traversing the repeated items, defaults to TRepeatDirection::Vertical
- access: public

TRepeatDirection getRepeatDirection ()
getRepeatLayout (line 169)

- return: how the repeated items should be displayed, using table or using line breaks. Defaults to TRepeatLayout::Table.
- access: public

TRepeatLayout getRepeatLayout ()
renderFooter (line 496)

Renders footer.

- access: protected

void renderFooter (THtmlWriter $writer, IRepeatInfoUser $user, boolean $tableLayout, integer $columns)

- THtmlWriter $writer: writer for the rendering purpose
- IRepeatInfoUser $user: repeat information user
- boolean $tableLayout: whether to render using table layout
- integer $columns: number of columns to be rendered

renderHeader (line 463)

Renders header.

- access: protected

void renderHeader (THtmlWriter $writer, IRepeatInfoUser $user, boolean $tableLayout, integer $columns, boolean $needBreak)

- THtmlWriter $writer: writer for the rendering purpose
- IRepeatInfoUser $user: repeat information user
- boolean $tableLayout: whether to render using table layout
- integer $columns: number of columns to be rendered
- boolean $needBreak: if a line break is needed at the end

renderHorizontalContents (line 248)

Renders contents in horizontal repeat direction.

- access: protected

void renderHorizontalContents (THtmlWriter $writer, IRepeatInfoUser $user)

- THtmlWriter $writer: writer for the rendering purpose
- IRepeatInfoUser $user: repeat information user

renderRawContents (line 225)

Renders contents in raw format.

- access: protected

void renderRawContents (THtmlWriter $writer, IRepeatInfoUser $user)

- THtmlWriter $writer: writer for the rendering purpose
- IRepeatInfoUser $user: repeat information user

renderRepeater (line 187)

Renders the repeated items.

- access: public

void renderRepeater (THtmlWriter $writer, IRepeatInfoUser $user)

- THtmlWriter $writer: writer for the rendering purpose
- IRepeatInfoUser $user: repeat information user

renderVerticalContents (line 330)

Renders contents in veritcal repeat direction.

- access: protected

void renderVerticalContents (THtmlWriter $writer, IRepeatInfoUser $user)

- THtmlWriter $writer: writer for the rendering purpose
- IRepeatInfoUser $user: repeat information user

setCaption (line 111)

- access: public

void setCaption (string $value)

- string $value: caption of the table layout

setCaptionAlign (line 127)

- return: alignment of the caption of the table layout.
- access: public

TTableCaptionAlign setCaptionAlign (mixed $value)
setRepeatColumns (line 143)

- access: public

void setRepeatColumns (integer $value)

- integer $value: the number of columns that the repeated items should be displayed in.

setRepeatDirection (line 161)

- access: public

void setRepeatDirection (TRepeatDirection $value)

- TRepeatDirection $value: the direction of traversing the repeated items

setRepeatLayout (line 177)

- access: public

void setRepeatLayout (TRepeatLayout $value)

- TRepeatLayout $value: how the repeated items should be displayed, using table or using line breaks.

#### Inherited Methods

Inherited From TComponent

> TComponent::addParsedObject()
> TComponent::attachEventHandler()
> TComponent::canGetProperty()
> TComponent::canSetProperty()
> TComponent::createdOnTemplate()
> TComponent::detachEventHandler()
> TComponent::evaluateExpression()
> TComponent::evaluateStatements()
> TComponent::getEventHandlers()
> TComponent::getSubProperty()
> TComponent::hasEvent()
> TComponent::hasEventHandler()
> TComponent::hasProperty()
> TComponent::raiseEvent()
> TComponent::setSubProperty()
> TComponent::__get()
> TComponent::__set()

Documentation generated on Mon, 22 Feb 2010 12:18:32 +0000 by phpDocumentor 1.3.0RC4