## 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: $Revision: $ $Date: $
- author: Qiang Xue <qiang.xue@gmail.com>

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

    TComponent
       |
       --TRepeatInfo

Method Summary
string getCaption ()
string getCaptionAlign ()
integer getRepeatColumns ()
string getRepeatDirection ()
string 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)
string setCaptionAlign (mixed $value)
void setRepeatColumns (integer $value)
void setRepeatDirection (string $value)
void setRepeatLayout (string $value)
Methods
getCaption (line 101)

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

string getCaption ()
getCaptionAlign (line 117)

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

string getCaptionAlign ()
getRepeatColumns (line 134)

- 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 152)

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

string getRepeatDirection ()
getRepeatLayout (line 169)

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

string getRepeatLayout ()
renderFooter (line 497)

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 464)

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 249)

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 226)

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 188)

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 331)

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 109)

- access: public

void setCaption (string $value)

- string $value: caption of the table layout

setCaptionAlign (line 126)

- return: alignment of the caption of the table layout. Valid values include 'NotSet','Top','Bottom','Left','Right'.
- access: public

string setCaptionAlign (mixed $value)
setRepeatColumns (line 142)

- access: public

void setRepeatColumns (integer $value)

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

setRepeatDirection (line 161)

Sets the direction of traversing the repeated items (Vertical, Horizontal)

- access: public

void setRepeatDirection (string $value)

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

setRepeatLayout (line 178)

- access: public

void setRepeatLayout (string $value)

- string $value: how the repeated items should be displayed, using table or using line breaks. Valid values include 'Table', 'Flow' and 'Raw'.

#### Inherited Methods

Inherited From TComponent

> TComponent::attachEventHandler()
> TComponent::canGetProperty()
> TComponent::canSetProperty()
> 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 Sun, 04 Jun 2006 19:00:15 -0400 by phpDocumentor 1.3.0RC4