PHP Класс Prado\Web\UI\WebControls\TLiteralColumn

TLiteralColumn represents a static text column that is bound to a field in a data source. The cells in the column will be displayed with static texts using the data indexed by {@link setDataField DataField}. You can customize the display by setting {@link setDataFormatString DataFormatString}. If {@link setDataField DataField} is not specified, the cells will be filled with {@link setText Text}. If {@link setEncode Encode} is true, the static texts will be HTML-encoded.
С версии: 3.0.5
Автор: Qiang Xue ([email protected])
Наследование: extends TDataGridColumn
Показать файл Открыть проект

Открытые методы

Метод Описание
dataBindColumn ( $sender, $param ) Databinds a cell in the column.
getDataField ( ) : string
getDataFormatString ( ) : string
getEncode ( ) : boolean
getText ( ) : string
initializeCell ( $cell, $columnIndex, $itemType ) Initializes the specified cell to its initial values.
setDataField ( $value )
setDataFormatString ( $value )
setEncode ( $value )
setText ( $value )

Описание методов

dataBindColumn() публичный Метод

This method is invoked when datagrid performs databinding. It populates the content of the cell with the relevant data from data source.
public dataBindColumn ( $sender, $param )

getDataField() публичный Метод

public getDataField ( ) : string
Результат string the field name from the data source to bind to the column

getDataFormatString() публичный Метод

public getDataFormatString ( ) : string
Результат string the formatting string used to control how the bound data will be displayed.

getEncode() публичный Метод

public getEncode ( ) : boolean
Результат boolean whether the rendered text should be HTML-encoded. Defaults to false.

getText() публичный Метод

public getText ( ) : string
Результат string static text to be displayed in the column. Defaults to empty.

initializeCell() публичный Метод

This method overrides the parent implementation.
public initializeCell ( $cell, $columnIndex, $itemType )

setDataField() публичный Метод

public setDataField ( $value )

setDataFormatString() публичный Метод

public setDataFormatString ( $value )

setEncode() публичный Метод

public setEncode ( $value )

setText() публичный Метод

public setText ( $value )