PHP 클래스 Prado\Web\UI\WebControls\TButton

TButton creates a click button on the page. It is mainly used to submit data to a page. TButton raises two server-side events, {@link onClick OnClick} and {@link onCommand OnCommand}, when it is clicked on the client-side. The difference between these two events is that the event {@link onCommand OnCommand} is bubbled up to the button's ancestor controls. And within the event parameter for {@link onCommand OnCommand} contains the reference to the {@link setCommandName CommandName} and {@link setCommandParameter CommandParameter} property values that are set for the button object. This allows you to create multiple TButton components on a Web page and programmatically determine which one is clicked with what parameter. Clicking on button can also trigger form validation, if {@link setCausesValidation CausesValidation} is true. The validation may be restricted within a certain group of validator controls by setting {@link setValidationGroup ValidationGroup} property. If validation is successful, the data will be post back to the same page. TButton displays the {@link setText Text} property as the button caption. TButton can be one of three {@link setButtonType ButtonType}: Submit, Button and Reset. By default, it is a Submit button and the form submission uses the browser's default submission capability. If it is Button or Reset, postback may occur if one of the following conditions is met: - an event handler is attached to {@link onClick OnClick} event; - an event handler is attached to {@link onCommand OnCommand} event; - the button is in a non-empty validation group. In addition, clicking on a Reset button will clear up all input fields if the button does not cause a postback.
부터: 3.0
저자: Qiang Xue ([email protected])
상속: extends TWebControl, implements Prado\Web\UI\IPostBackEventHandler, implements Prado\Web\UI\IButtonControl, implements Prado\IDataRenderer
파일 보기 프로젝트 열기: pradosoft/prado 1 사용 예제들

공개 메소드들

메소드 설명
getButtonTag ( ) : TButtonTag
getButtonType ( ) : TButtonType
getCausesValidation ( ) : boolean
getCommandName ( ) : string
getCommandParameter ( ) : string
getData ( ) : string Returns the caption of the button.
getEnableClientScript ( ) : boolean
getIsDefaultButton ( ) : boolean
getText ( ) : string
getValidationGroup ( ) : string
onClick ( $param ) This method is invoked when the button is clicked.
onCommand ( $param ) This method is invoked when the button is clicked.
raisePostBackEvent ( $param ) Raises the postback event.
renderContents ( $writer ) Renders the body content enclosed between the control tag.
setButtonTag ( $value )
setButtonType ( $value )
setCausesValidation ( $value )
setCommandName ( $value )
setCommandParameter ( $value )
setData ( $value ) Sets the caption of the button.
setEnableClientScript ( $value )
setIsDefaultButton ( $value )
setText ( $value )
setValidationGroup ( $value )

보호된 메소드들

메소드 설명
addAttributesToRender ( $writer ) Adds attribute name-value pairs to renderer.
canCauseValidation ( ) : boolean
getClientClassName ( ) : string Gets the name of the javascript class responsible for performing postback for this control.
getPostBackOptions ( ) : array Returns postback specifications for the button.
getTagName ( ) : string
needPostBackScript ( ) : boolean
renderClientControlScript ( $writer ) Renders the client-script code.

메소드 상세

addAttributesToRender() 보호된 메소드

This overrides the parent implementation with additional button specific attributes.
protected addAttributesToRender ( $writer )

canCauseValidation() 보호된 메소드

protected canCauseValidation ( ) : boolean
리턴 boolean whether to perform validation if the button is clicked

getButtonTag() 공개 메소드

public getButtonTag ( ) : TButtonTag
리턴 TButtonTag the tag name of the button. Defaults to TButtonType::Input.

getButtonType() 공개 메소드

public getButtonType ( ) : TButtonType
리턴 TButtonType the type of the button. Defaults to TButtonType::Submit.

getCausesValidation() 공개 메소드

public getCausesValidation ( ) : boolean
리턴 boolean whether postback event trigger by this button will cause input validation, default is true

getClientClassName() 보호된 메소드

This method overrides the parent implementation.
protected getClientClassName ( ) : string
리턴 string the javascript class name

getCommandName() 공개 메소드

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

getCommandParameter() 공개 메소드

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

getData() 공개 메소드

This method is required by {@link \Prado\IDataRenderer}. It is the same as {@link getText()}.
또한 보기: getText
부터: 3.1.0
public getData ( ) : string
리턴 string caption of the button.

getEnableClientScript() 공개 메소드

public getEnableClientScript ( ) : boolean
리턴 boolean whether to render javascript.

getIsDefaultButton() 공개 메소드

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

getPostBackOptions() 보호된 메소드

This method is used by framework and control developers.
protected getPostBackOptions ( ) : array
리턴 array parameters about how the button defines its postback behavior.

getTagName() 보호된 메소드

protected getTagName ( ) : string
리턴 string tag name of the button

getText() 공개 메소드

public getText ( ) : string
리턴 string caption of the button

getValidationGroup() 공개 메소드

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

needPostBackScript() 보호된 메소드

protected needPostBackScript ( ) : boolean
리턴 boolean whether the button needs javascript to do postback

onClick() 공개 메소드

The method raises 'OnClick' event to fire up the event handlers. If you override this method, be sure to call the parent implementation so that the event handler can be invoked.
public onClick ( $param )

onCommand() 공개 메소드

The method raises 'OnCommand' event to fire up the event handlers. If you override this method, be sure to call the parent implementation so that the event handlers can be invoked.
public onCommand ( $param )

raisePostBackEvent() 공개 메소드

This method is required by {@link IPostBackEventHandler} interface. If {@link getCausesValidation CausesValidation} is true, it will invoke the page's {@link TPage::validate validate} method first. It will raise {@link onClick OnClick} and {@link onCommand OnCommand} events. This method is mainly used by framework and control developers.
public raisePostBackEvent ( $param )

renderClientControlScript() 보호된 메소드

Renders the client-script code.
protected renderClientControlScript ( $writer )

renderContents() 공개 메소드

This overrides the parent implementation with nothing to be rendered for input tags, button tags are rendered normally.
public renderContents ( $writer )

setButtonTag() 공개 메소드

public setButtonTag ( $value )

setButtonType() 공개 메소드

public setButtonType ( $value )

setCausesValidation() 공개 메소드

public setCausesValidation ( $value )

setCommandName() 공개 메소드

public setCommandName ( $value )

setCommandParameter() 공개 메소드

public setCommandParameter ( $value )

setData() 공개 메소드

This method is required by {@link \Prado\IDataRenderer}. It is the same as {@link setText()}.
또한 보기: setText
부터: 3.1.0
public setData ( $value )

setEnableClientScript() 공개 메소드

public setEnableClientScript ( $value )

setIsDefaultButton() 공개 메소드

public setIsDefaultButton ( $value )

setText() 공개 메소드

public setText ( $value )

setValidationGroup() 공개 메소드

public setValidationGroup ( $value )