PHP Class Prado\Web\UI\WebControls\TRepeatInfo

TRepeatInfo represents repeat information for controls like {@link TCheckBoxList}. The layout of the repeated items is specified via {@link setRepeatLayout 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 {@link setRepeatColumns RepeatColumns} property, while the {@link setRepeatDirection 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
Author: Qiang Xue ([email protected])
Inheritance: extends Prado\TComponent
显示文件 Open project: pradosoft/prado

Public Methods

Method Description
getCaption ( ) : string
getCaptionAlign ( ) : TTableCaptionAlign
getRepeatColumns ( ) : integer
getRepeatDirection ( ) : TRepeatDirection
getRepeatLayout ( ) : TRepeatLayout
renderRepeater ( $writer, IRepeatInfoUser $user ) Renders the repeated items.
setCaption ( $value )
setCaptionAlign ( $value ) : TTableCaptionAlign
setRepeatColumns ( $value )
setRepeatDirection ( $value )
setRepeatLayout ( $value )

Protected Methods

Method Description
renderFooter ( $writer, $user, $tableLayout, $columns ) Renders footer.
renderHeader ( $writer, $user, $tableLayout, $columns, $needBreak ) Renders header.
renderHorizontalContents ( $writer, $user ) Renders contents in horizontal repeat direction.
renderRawContents ( $writer, $user ) Renders contents in raw format.
renderVerticalContents ( $writer, $user ) Renders contents in veritcal repeat direction.

Method Details

getCaption() public method

public getCaption ( ) : string
return string caption of the table layout

getCaptionAlign() public method

public getCaptionAlign ( ) : TTableCaptionAlign
return TTableCaptionAlign alignment of the caption of the table layout. Defaults to TTableCaptionAlign::NotSet.

getRepeatColumns() public method

public getRepeatColumns ( ) : integer
return integer the number of columns that the repeated items should be displayed in. Defaults to 0, meaning not set.

getRepeatDirection() public method

public getRepeatDirection ( ) : TRepeatDirection
return TRepeatDirection the direction of traversing the repeated items, defaults to TRepeatDirection::Vertical

getRepeatLayout() public method

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

renderFooter() protected method

Renders footer.
protected renderFooter ( $writer, $user, $tableLayout, $columns )

renderHeader() protected method

Renders header.
protected renderHeader ( $writer, $user, $tableLayout, $columns, $needBreak )

renderHorizontalContents() protected method

Renders contents in horizontal repeat direction.
protected renderHorizontalContents ( $writer, $user )

renderRawContents() protected method

Renders contents in raw format.
protected renderRawContents ( $writer, $user )

renderRepeater() public method

Renders the repeated items.
public renderRepeater ( $writer, IRepeatInfoUser $user )
$user IRepeatInfoUser

renderVerticalContents() protected method

Renders contents in veritcal repeat direction.
protected renderVerticalContents ( $writer, $user )

setCaption() public method

public setCaption ( $value )

setCaptionAlign() public method

public setCaptionAlign ( $value ) : TTableCaptionAlign
return TTableCaptionAlign alignment of the caption of the table layout.

setRepeatColumns() public method

public setRepeatColumns ( $value )

setRepeatDirection() public method

public setRepeatDirection ( $value )

setRepeatLayout() public method

public setRepeatLayout ( $value )