PHP Interface Prado\Web\UI\IButtonControl

IButtonControl specifies the common properties and events that must be implemented by a button control, such as {@link TButton}, {@link TLinkButton}, {@link TImageButton}.
Since: 3.0
Author: Qiang Xue ([email protected])
Show file Open project: pradosoft/prado

Public Methods

Method Description
getCausesValidation ( ) : boolean
getCommandName ( ) : string
getCommandParameter ( ) : string
getIsDefaultButton ( ) : boolean
getText ( ) : string
getValidationGroup ( ) : string
onClick ( $param ) Raises OnClick event.
onCommand ( $param ) Raises OnCommand event.
setCausesValidation ( $value )
setCommandName ( $value )
setCommandParameter ( $value )
setIsDefaultButton ( $value )
setText ( $value )
setValidationGroup ( $value )

Method Details

getCausesValidation() public method

public getCausesValidation ( ) : boolean
return boolean whether postback event trigger by this button will cause input validation

getCommandName() public method

public getCommandName ( ) : string
return string the command name associated with the {@link onCommand OnCommand} event.

getCommandParameter() public method

public getCommandParameter ( ) : string
return string the parameter associated with the {@link onCommand OnCommand} event

getIsDefaultButton() public method

public getIsDefaultButton ( ) : boolean
return boolean true if this button is registered as a default button for a panel.

getText() public method

public getText ( ) : string
return string caption of the button

getValidationGroup() public method

public getValidationGroup ( ) : string
return string the group of validators which the button causes validation upon postback

onClick() public method

Raises OnClick event.
public onClick ( $param )

onCommand() public method

Raises OnCommand event.
public onCommand ( $param )

setCausesValidation() public method

public setCausesValidation ( $value )

setCommandName() public method

public setCommandName ( $value )

setCommandParameter() public method

public setCommandParameter ( $value )

setIsDefaultButton() public method

public setIsDefaultButton ( $value )

setText() public method

public setText ( $value )

setValidationGroup() public method

public setValidationGroup ( $value )