PHP Class 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.
Since: 3.0.5
Author: Qiang Xue ([email protected])
Inheritance: extends TDataGridColumn
Afficher le fichier Open project: pradosoft/prado

Méthodes publiques

Méthode Description
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 )

Method Details

dataBindColumn() public méthode

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 méthode

public getDataField ( ) : string
Résultat string the field name from the data source to bind to the column

getDataFormatString() public méthode

public getDataFormatString ( ) : string
Résultat string the formatting string used to control how the bound data will be displayed.

getEncode() public méthode

public getEncode ( ) : boolean
Résultat boolean whether the rendered text should be HTML-encoded. Defaults to false.

getText() public méthode

public getText ( ) : string
Résultat string static text to be displayed in the column. Defaults to empty.

initializeCell() public méthode

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

setDataField() public méthode

public setDataField ( $value )

setDataFormatString() public méthode

public setDataFormatString ( $value )

setEncode() public méthode

public setEncode ( $value )

setText() public méthode

public setText ( $value )