PHP Class Prado\Web\UI\WebControls\TAccordionView

TAccordionView represents a single view in a {@link TAccordion}. TAccordionView is represented inside the {@link TAccordion} with an header label whose text is defined by the {@link setCaption Caption} property; optionally the label can be an hyperlink: use the {@link setNavigateUrl NavigateUrl} property to define the destination url.
Since: 3.2
Author: Gabor Berczi, DevWorx Hungary ([email protected])
Inheritance: extends TWebControl
Afficher le fichier Open project: pradosoft/prado

Méthodes publiques

Méthode Description
getActive ( ) : boolean
getCaption ( ) : string
getNavigateUrl ( ) : string
getText ( ) : string
renderContents ( $writer ) Renders body contents of the accordion view.
renderHeader ( $writer ) Renders the header associated with the accordion 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.

Méthodes protégées

Méthode Description
addAttributesToRender ( $writer ) Adds attributes to renderer.
getTagName ( ) : the
renderHeaderContent ( $writer ) Renders the content in the header.

Method Details

addAttributesToRender() protected méthode

Adds attributes to renderer.
protected addAttributesToRender ( $writer )

getActive() public méthode

public getActive ( ) : boolean
Résultat boolean whether this accordion view is active. Defaults to false.

getCaption() public méthode

public getCaption ( ) : string
Résultat string the caption displayed on this header. Defaults to ''.

getNavigateUrl() public méthode

public getNavigateUrl ( ) : string
Résultat string the URL of the target page. Defaults to ''.

getTagName() protected méthode

protected getTagName ( ) : the
Résultat the tag name for the view element

getText() public méthode

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

renderContents() public méthode

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

renderHeader() public méthode

Renders the header associated with the accordion view.
public renderHeader ( $writer )

renderHeaderContent() protected méthode

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

setActive() public méthode

public setActive ( $value )

setCaption() public méthode

public setCaption ( $value )

setNavigateUrl() public méthode

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

setText() public méthode

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