PHP Class Prado\Web\UI\WebControls\TDataGridPagerStyle

TDataGridPagerStyle specifies the styles available for a datagrid pager.
Since: 3.0
Author: Qiang Xue ([email protected])
Inheritance: extends TPanelStyle
Mostrar archivo Open project: pradosoft/prado

Public Methods

Method Description
copyFrom ( $style ) Copies the fields in a new style to this style.
getButtonType ( ) : TDataGridPagerButtonType
getFirstPageText ( ) : string
getLastPageText ( ) : string
getMode ( ) : TDataGridPagerMode
getNextPageText ( ) : string
getPageButtonCount ( ) : integer
getPosition ( ) : TDataGridPagerPosition
getPrevPageText ( ) : string
getVisible ( ) : boolean
mergeWith ( $style ) Merges the style with a new one.
reset ( ) Resets the style to the original empty state.
setButtonType ( $value )
setFirstPageText ( $value )
setLastPageText ( $value )
setMode ( $value )
setNextPageText ( $value )
setPageButtonCount ( $value )
setPosition ( $value )
setPrevPageText ( $value )
setVisible ( $value )

Protected Methods

Method Description
_getZappableSleepProps ( &$exprops ) Returns an array with the names of all variables of this object that should NOT be serialized because their value is the default one or useless to be cached for the next page loads.

Method Details

_getZappableSleepProps() protected method

Reimplement in derived classes to add new variables, but remember to also to call the parent implementation first.
protected _getZappableSleepProps ( &$exprops )

copyFrom() public method

If a style field is set in the new style, the corresponding field in this style will be overwritten.
public copyFrom ( $style )

getButtonType() public method

public getButtonType ( ) : TDataGridPagerButtonType
return TDataGridPagerButtonType the type of command button. Defaults to TDataGridPagerButtonType::LinkButton.

getFirstPageText() public method

public getFirstPageText ( ) : string
return string text for the first page button. Defaults to '<<'.

getLastPageText() public method

public getLastPageText ( ) : string
return string text for the last page button. Defaults to '>>'.

getMode() public method

public getMode ( ) : TDataGridPagerMode
return TDataGridPagerMode pager mode. Defaults to TDataGridPagerMode::NextPrev.

getNextPageText() public method

public getNextPageText ( ) : string
return string text for the next page button. Defaults to '>'.

getPageButtonCount() public method

public getPageButtonCount ( ) : integer
return integer maximum number of pager buttons to be displayed. Defaults to 10.

getPosition() public method

public getPosition ( ) : TDataGridPagerPosition
return TDataGridPagerPosition where the pager is to be displayed. Defaults to TDataGridPagerPosition::Bottom.

getPrevPageText() public method

public getPrevPageText ( ) : string
return string text for the previous page button. Defaults to '<'.

getVisible() public method

public getVisible ( ) : boolean
return boolean whether the pager is visible. Defaults to true.

mergeWith() public method

If a style field is not set in this style, it will be overwritten by the new one.
public mergeWith ( $style )

reset() public method

Resets the style to the original empty state.
public reset ( )

setButtonType() public method

public setButtonType ( $value )

setFirstPageText() public method

public setFirstPageText ( $value )

setLastPageText() public method

public setLastPageText ( $value )

setMode() public method

public setMode ( $value )

setNextPageText() public method

public setNextPageText ( $value )

setPageButtonCount() public method

public setPageButtonCount ( $value )

setPosition() public method

public setPosition ( $value )

setPrevPageText() public method

public setPrevPageText ( $value )

setVisible() public method

public setVisible ( $value )