Class TRepeatInfo
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.
| Method Summary |
|
string
|
|
|
TTableCaptionAlign
|
|
|
integer
|
|
|
TRepeatDirection
|
|
|
TRepeatLayout
|
|
|
protected
void
|
Renders footer.
|
|
protected
void
|
Renders header.
|
|
protected
void
|
Renders contents in horizontal repeat direction.
|
|
protected
void
|
Renders contents in raw format.
|
|
void
|
Renders the repeated items.
|
|
protected
void
|
Renders contents in veritcal repeat direction.
|
|
void
|
|
|
TTableCaptionAlign
|
|
|
void
|
|
|
void
|
|
|
void
|
|
| 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()
|
| Method Details |
getCaption
| public string getCaption |
() |
| Output |
|---|
|
string
| caption of the table layout |
| Exception |
|---|
|
getCaptionAlign
| Output |
|---|
|
TTableCaptionAlign
| alignment of the caption of the table layout. Defaults to TTableCaptionAlign::NotSet. |
| Exception |
|---|
|
getRepeatColumns
| public integer getRepeatColumns |
() |
| Output |
|---|
|
integer
| the number of columns that the repeated items should be displayed in. Defaults to 0, meaning not set. |
| Exception |
|---|
|
getRepeatDirection
| Output |
|---|
|
TRepeatDirection
| the direction of traversing the repeated items, defaults to TRepeatDirection::Vertical |
| Exception |
|---|
|
getRepeatLayout
| Output |
|---|
|
TRepeatLayout
| how the repeated items should be displayed, using table or using line breaks. Defaults to TRepeatLayout::Table. |
| Exception |
|---|
|
renderFooter
Renders footer.
| Input |
|---|
| 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 |
| Output |
|---|
| Exception |
|---|
|
renderHeader
| protected void renderHeader |
(THtmlWriter $writer , IRepeatInfoUser $user , boolean $tableLayout , integer $columns , boolean $needBreak ) |
Renders header.
| Input |
|---|
| 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 |
| Output |
|---|
| Exception |
|---|
|
renderHorizontalContents
Renders contents in horizontal repeat direction.
|
renderRawContents
Renders contents in raw format.
|
renderRepeater
| public void renderRepeater |
(THtmlWriter $writer , IRepeatInfoUser $user ) |
Renders the repeated items.
| Input |
|---|
| THtmlWriter | $writer | writer for the rendering purpose |
| IRepeatInfoUser | $user | repeat information user |
| Output |
|---|
| Exception |
|---|
|
renderVerticalContents
Renders contents in veritcal repeat direction.
|
setCaption
| public void setCaption |
(string $value ) |
| Input |
|---|
| string | $value | caption of the table layout |
| Output |
|---|
| Exception |
|---|
|
setCaptionAlign
| Input |
|---|
| mixed | $value | |
| Output |
|---|
|
TTableCaptionAlign
| alignment of the caption of the table layout. |
| Exception |
|---|
|
setRepeatColumns
| public void setRepeatColumns |
(integer $value ) |
| Input |
|---|
| integer | $value | the number of columns that the repeated items should be displayed in. |
| Output |
|---|
| Exception |
|---|
|
setRepeatDirection
| Input |
|---|
| TRepeatDirection | $value | the direction of traversing the repeated items |
| Output |
|---|
| Exception |
|---|
|
setRepeatLayout
| Input |
|---|
| TRepeatLayout | $value | how the repeated items should be displayed, using table or using line breaks. |
| Output |
|---|
| Exception |
|---|
|
|
