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

TBulletedList displays items in a bullet format. The bullet style is specified by {@link setBulletStyle BulletStyle}. When the style is 'CustomImage', the {@link setBackImageUrl BulletImageUrl} specifies the image used as bullets. TBulletedList displays the item texts in three different modes, specified via {@link setDisplayMode DisplayMode}. When the mode is Text, the item texts are displayed as static texts; When the mode is 'HyperLink', each item is displayed as a hyperlink whose URL is given by the item value, and the {@link setTarget Target} property can be used to specify the target browser window; When the mode is 'LinkButton', each item is displayed as a link button which posts back to the page if a user clicks on that and the event {@link onClick OnClick} will be raised under such a circumstance.
부터: 3.0
저자: Qiang Xue ([email protected])
상속: extends TListControl, implements Prado\Web\UI\IPostBackEventHandler
파일 보기 프로젝트 열기: pradosoft/prado

공개 메소드들

메소드 설명
getBulletImageUrl ( ) : string
getBulletStyle ( ) : TBulletStyle
getDisplayMode ( ) : TBulletedListDisplayMode
getFirstBulletNumber ( ) : integer
getTarget ( ) : string
onClick ( $param ) Raises 'OnClick' event.
raisePostBackEvent ( $param ) Raises the postback event.
render ( $writer ) Renders the control.
renderContents ( $writer ) Renders the body contents.
setAutoPostBack ( $value )
setBulletImageUrl ( $value )
setBulletStyle ( $value )
setDisplayMode ( $value ) : TBulletedListDisplayMode
setFirstBulletNumber ( $value )
setSelectedIndex ( $index )
setSelectedIndices ( $indices )
setSelectedValue ( $value )
setSelectedValues ( $values )
setTarget ( $value )

보호된 메소드들

메소드 설명
addAttributesToRender ( $writer ) Adds attribute name-value pairs to renderer.
canCauseValidation ( )
getClientClassName ( ) : string Gets the name of the javascript class responsible for performing postback for this control.
getPostBackOptions ( ) : array
getTagName ( ) : string
renderBulletText ( $writer, $item, $index ) Renders each item
renderHyperLinkItem ( $writer, $item, $index )
renderLinkButtonItem ( $writer, $item, $index )
renderTextItem ( $writer, $item, $index )

메소드 상세

addAttributesToRender() 보호된 메소드

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

canCauseValidation() 보호된 메소드

protected canCauseValidation ( )

getBulletImageUrl() 공개 메소드

public getBulletImageUrl ( ) : string
리턴 string image URL used for bullets when {@link getBulletStyle BulletStyle} is 'CustomImage'.

getBulletStyle() 공개 메소드

public getBulletStyle ( ) : TBulletStyle
리턴 TBulletStyle style of bullets. Defaults to TBulletStyle::NotSet.

getClientClassName() 보호된 메소드

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

getDisplayMode() 공개 메소드

public getDisplayMode ( ) : TBulletedListDisplayMode
리턴 TBulletedListDisplayMode display mode of the list. Defaults to TBulletedListDisplayMode::Text.

getFirstBulletNumber() 공개 메소드

public getFirstBulletNumber ( ) : integer
리턴 integer starting index when {@link getBulletStyle BulletStyle} is one of the following: 'Numbered', 'LowerAlpha', 'UpperAlpha', 'LowerRoman', 'UpperRoman'. Defaults to 1.

getPostBackOptions() 보호된 메소드

protected getPostBackOptions ( ) : array
리턴 array postback options used for linkbuttons.

getTagName() 보호된 메소드

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

getTarget() 공개 메소드

public getTarget ( ) : string
리턴 string the target window or frame to display the Web page content linked to when {@link getDisplayMode DisplayMode} is 'HyperLink' and one of the hyperlinks is clicked.

onClick() 공개 메소드

This method is invoked when the {@link getDisplayMode DisplayMode} is 'LinkButton' and end-users click on one of the buttons.
public onClick ( $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} events. This method is mainly used by framework and control developers.
public raisePostBackEvent ( $param )

render() 공개 메소드

Renders the control.
public render ( $writer )

renderBulletText() 보호된 메소드

Renders each item
protected renderBulletText ( $writer, $item, $index )

renderContents() 공개 메소드

Renders the body contents.
public renderContents ( $writer )

renderHyperLinkItem() 보호된 메소드

protected renderHyperLinkItem ( $writer, $item, $index )

renderLinkButtonItem() 보호된 메소드

protected renderLinkButtonItem ( $writer, $item, $index )

renderTextItem() 보호된 메소드

protected renderTextItem ( $writer, $item, $index )

setAutoPostBack() 공개 메소드

public setAutoPostBack ( $value )

setBulletImageUrl() 공개 메소드

public setBulletImageUrl ( $value )

setBulletStyle() 공개 메소드

public setBulletStyle ( $value )

setDisplayMode() 공개 메소드

public setDisplayMode ( $value ) : TBulletedListDisplayMode
리턴 TBulletedListDisplayMode display mode of the list.

setFirstBulletNumber() 공개 메소드

public setFirstBulletNumber ( $value )

setSelectedIndex() 공개 메소드

public setSelectedIndex ( $index )

setSelectedIndices() 공개 메소드

public setSelectedIndices ( $indices )

setSelectedValue() 공개 메소드

public setSelectedValue ( $value )

setSelectedValues() 공개 메소드

public setSelectedValues ( $values )

setTarget() 공개 메소드

public setTarget ( $value )