PHP Class Prado\Web\UI\WebControls\TWizardNavigationButtonStyle

TWizardNavigationButtonStyle defines the style applied to a wizard navigation button. The button type can be specified via {@link setButtonType ButtonType}, which can be 'Button', 'Image' or 'Link'. If the button is an image button, {@link setImageUrl ImageUrl} will be used to load the image for the button. Otherwise, {@link setButtonText ButtonText} will be displayed as the button caption.
Since: 3.0
Author: Qiang Xue ([email protected])
Inheritance: extends TStyle
Show file Open project: pradosoft/prado Class Usage Examples

Public Methods

Method Description
apply ( $button ) Applies this style to the specified button
copyFrom ( $style ) Copies the fields in a new style to this style.
getButtonText ( ) : string
getButtonType ( ) : TWizardNavigationButtonType
getImageUrl ( ) : string
mergeWith ( $style ) Merges the style with a new one.
reset ( ) Sets the style attributes to default values.
setButtonText ( $value )
setButtonType ( $value )
setImageUrl ( $value )

Method Details

apply() public method

Applies this style to the specified button
public apply ( $button )

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 )

getButtonText() public method

public getButtonText ( ) : string
return string button caption

getButtonType() public method

public getButtonType ( ) : TWizardNavigationButtonType
return TWizardNavigationButtonType button type. Default to TWizardNavigationButtonType::Button.

getImageUrl() public method

public getImageUrl ( ) : string
return string image URL for the image button

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 TWizardNavigationButtonStyle specific attributes.
public reset ( )

setButtonText() public method

public setButtonText ( $value )

setButtonType() public method

public setButtonType ( $value )

setImageUrl() public method

public setImageUrl ( $value )