PHP Class Prado\Web\UI\WebControls\TTabView

TTabView represents a view in a {@link TTabPanel} control. The content in a TTabView can be specified by the {@link setText Text} property or its child controls. In template syntax, the latter means enclosing the content within the TTabView component element. If both are set, {@link getText Text} takes precedence. Each TTabView is associated with a tab in the tab bar of the TTabPanel control. The tab caption is specified by {@link setCaption Caption}. If {@link setNavigateUrl NavigateUrl} is set, the tab will contain a hyperlink pointing to the specified URL. In this case, clicking on the tab will redirect the browser to the specified URL. TTabView may be toggled between visible (active) and invisible (inactive) by setting the {@link setActive Active} property.
Since: 3.1.1
Inheritance: extends TWebControl
Show file Open project: pradosoft/prado

Public Methods

Method Description
getActive ( ) : boolean
getCaption ( ) : string
getNavigateUrl ( ) : string
getText ( ) : string
renderContents ( $writer ) Renders body contents of the tab view.
renderTab ( $writer ) Renders the tab associated with the tab view.
setActive ( $value )
setCaption ( $value )
setNavigateUrl ( $value ) Sets the URL of the target page.
setText ( $value ) Sets the text content to be displayed on this view.

Protected Methods

Method Description
addAttributesToRender ( $writer ) Adds attributes to renderer.
getTagName ( ) : the
renderTabContent ( $writer ) Renders the content in the tab.

Method Details

addAttributesToRender() protected method

Adds attributes to renderer.
protected addAttributesToRender ( $writer )

getActive() public method

public getActive ( ) : boolean
return boolean whether this tab view is active. Defaults to false.

getCaption() public method

public getCaption ( ) : string
return string the caption displayed on this tab. Defaults to ''.

getNavigateUrl() public method

public getNavigateUrl ( ) : string
return string the URL of the target page. Defaults to ''.

getTagName() protected method

protected getTagName ( ) : the
return the tag name for the view element

getText() public method

public getText ( ) : string
return string the text content displayed on this view. Defaults to ''.

renderContents() public method

Renders body contents of the tab view.
public renderContents ( $writer )

renderTab() public method

Renders the tab associated with the tab view.
public renderTab ( $writer )

renderTabContent() protected method

By default, a hyperlink is displayed.
protected renderTabContent ( $writer )

setActive() public method

public setActive ( $value )

setCaption() public method

public setCaption ( $value )

setNavigateUrl() public method

If not empty, clicking on this tab will redirect the browser to the specified URL.
public setNavigateUrl ( $value )

setText() public method

If this is not empty, the child content of the view will be ignored.
public setText ( $value )