PHP Class Prado\Web\UI\WebControls\TPanelStyle

TPanelStyle represents the CSS style specific for panel HTML tag.
Since: 3.0
Author: Qiang Xue ([email protected])
Inheritance: extends TStyle
Show file Open project: pradosoft/prado Class Usage Examples

Public Methods

Method Description
addAttributesToRender ( $writer ) Adds attributes related to CSS styles to renderer.
copyFrom ( $style ) Copies the fields in a new style to this style.
getBackImageUrl ( ) : string
getDirection ( ) : TContentDirection
getHorizontalAlign ( ) : THorizontalAlign
getScrollBars ( ) : TScrollBars
getWrap ( ) : boolean
mergeWith ( $style ) Merges the style with a new one.
reset ( ) Sets the style attributes to default values.
setBackImageUrl ( $value ) Sets the URL of the background image for the panel component.
setDirection ( $value )
setHorizontalAlign ( $value ) Sets the horizontal alignment of the contents within the panel.
setScrollBars ( $value )
setWrap ( $value ) Sets the value indicating whether the content wraps within the panel.

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 )

addAttributesToRender() public method

This method overrides the parent implementation.
public addAttributesToRender ( $writer )

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 )

getBackImageUrl() public method

public getBackImageUrl ( ) : string
return string the URL of the background image for the panel component.

getDirection() public method

public getDirection ( ) : TContentDirection
return TContentDirection alignment of the content in the panel. Defaults to TContentDirection::NotSet.

getHorizontalAlign() public method

public getHorizontalAlign ( ) : THorizontalAlign
return THorizontalAlign the horizontal alignment of the contents within the panel, defaults to THorizontalAlign::NotSet.

getScrollBars() public method

public getScrollBars ( ) : TScrollBars
return TScrollBars the visibility and position of scroll bars in a panel control, defaults to TScrollBars::None.

getWrap() public method

public getWrap ( ) : boolean
return boolean whether the content wraps within the panel. 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

This method overrides the parent implementation by resetting additional TPanelStyle specific attributes.
public reset ( )

setBackImageUrl() public method

Sets the URL of the background image for the panel component.
public setBackImageUrl ( $value )

setDirection() public method

public setDirection ( $value )

setHorizontalAlign() public method

Sets the horizontal alignment of the contents within the panel.
public setHorizontalAlign ( $value )

setScrollBars() public method

public setScrollBars ( $value )

setWrap() public method

Sets the value indicating whether the content wraps within the panel.
public setWrap ( $value )