PHP 클래스 PhpSchool\CliMenu\MenuStyle

저자: Michael Woodward ([email protected])
파일 보기 프로젝트 열기: php-school/cli-menu 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$bg string
$contentWidth integer
$fg string
$margin integer
$padding integer
$terminal PhpSchool\CliMenu\Terminal\TerminalInterface
$width integer

공개 메소드들

메소드 설명
__construct ( PhpSchool\CliMenu\Terminal\TerminalInterface $terminal = null ) Initialise style
getAvailableColours ( ) : array
getBg ( ) : string
getContentWidth ( ) : integer
getDefaultStyleValues ( ) : array
getDisabledItemText ( string $text ) : string
getDisplaysExtra ( ) : boolean
getFg ( ) : string
getItemExtra ( ) : string
getMargin ( ) : integer
getMarker ( boolean $selected ) : string Get the correct marker for the item
getPadding ( ) : integer
getRightHandPadding ( $contentLength ) : integer Get padding for right had side of content
getSelectedMarker ( ) : string
getSelectedSetCode ( ) : string Get the colour code set for Bg and Fg
getSelectedUnsetCode ( ) : string Get the colour unset code for Bg and Fg
getTitleSeparator ( ) : string
getUnselectedMarker ( ) : string
getUnselectedSetCode ( ) : string Get the inverted colour code
getUnselectedUnsetCode ( ) : string Get the inverted colour unset code
getWidth ( ) : integer
setBg ( string $bg ) : MenuStyle
setDisplaysExtra ( boolean $displaysExtra )
setFg ( string $fg ) : MenuStyle
setItemExtra ( string $itemExtra )
setMargin ( integer $margin ) : MenuStyle
setPadding ( integer $padding ) : MenuStyle
setSelectedMarker ( string $marker )
setTitleSeparator ( string $actionSeparator )
setUnselectedMarker ( string $marker )
setWidth ( integer $width ) : MenuStyle

보호된 메소드들

메소드 설명
calculateContentWidth ( ) Calculate the contents width

메소드 상세

__construct() 공개 메소드

Initialise style
public __construct ( PhpSchool\CliMenu\Terminal\TerminalInterface $terminal = null )
$terminal PhpSchool\CliMenu\Terminal\TerminalInterface

calculateContentWidth() 보호된 메소드

Calculate the contents width
protected calculateContentWidth ( )

getAvailableColours() 공개 정적인 메소드

public static getAvailableColours ( ) : array
리턴 array

getBg() 공개 메소드

public getBg ( ) : string
리턴 string

getContentWidth() 공개 메소드

public getContentWidth ( ) : integer
리턴 integer

getDefaultStyleValues() 공개 정적인 메소드

public static getDefaultStyleValues ( ) : array
리턴 array

getDisabledItemText() 공개 메소드

public getDisabledItemText ( string $text ) : string
$text string
리턴 string

getDisplaysExtra() 공개 메소드

public getDisplaysExtra ( ) : boolean
리턴 boolean

getFg() 공개 메소드

public getFg ( ) : string
리턴 string

getItemExtra() 공개 메소드

public getItemExtra ( ) : string
리턴 string

getMargin() 공개 메소드

public getMargin ( ) : integer
리턴 integer

getMarker() 공개 메소드

Get the correct marker for the item
public getMarker ( boolean $selected ) : string
$selected boolean
리턴 string

getPadding() 공개 메소드

public getPadding ( ) : integer
리턴 integer

getRightHandPadding() 공개 메소드

Get padding for right had side of content
public getRightHandPadding ( $contentLength ) : integer
$contentLength
리턴 integer

getSelectedMarker() 공개 메소드

public getSelectedMarker ( ) : string
리턴 string

getSelectedSetCode() 공개 메소드

Get the colour code set for Bg and Fg
public getSelectedSetCode ( ) : string
리턴 string

getSelectedUnsetCode() 공개 메소드

Get the colour unset code for Bg and Fg
public getSelectedUnsetCode ( ) : string
리턴 string

getTitleSeparator() 공개 메소드

public getTitleSeparator ( ) : string
리턴 string

getUnselectedMarker() 공개 메소드

public getUnselectedMarker ( ) : string
리턴 string

getUnselectedSetCode() 공개 메소드

Get the inverted colour code
public getUnselectedSetCode ( ) : string
리턴 string

getUnselectedUnsetCode() 공개 메소드

Get the inverted colour unset code
public getUnselectedUnsetCode ( ) : string
리턴 string

getWidth() 공개 메소드

public getWidth ( ) : integer
리턴 integer

setBg() 공개 메소드

public setBg ( string $bg ) : MenuStyle
$bg string
리턴 MenuStyle

setDisplaysExtra() 공개 메소드

public setDisplaysExtra ( boolean $displaysExtra )
$displaysExtra boolean

setFg() 공개 메소드

public setFg ( string $fg ) : MenuStyle
$fg string
리턴 MenuStyle

setItemExtra() 공개 메소드

public setItemExtra ( string $itemExtra )
$itemExtra string

setMargin() 공개 메소드

public setMargin ( integer $margin ) : MenuStyle
$margin integer
리턴 MenuStyle

setPadding() 공개 메소드

public setPadding ( integer $padding ) : MenuStyle
$padding integer
리턴 MenuStyle

setSelectedMarker() 공개 메소드

public setSelectedMarker ( string $marker )
$marker string

setTitleSeparator() 공개 메소드

public setTitleSeparator ( string $actionSeparator )
$actionSeparator string

setUnselectedMarker() 공개 메소드

public setUnselectedMarker ( string $marker )
$marker string

setWidth() 공개 메소드

public setWidth ( integer $width ) : MenuStyle
$width integer
리턴 MenuStyle

프로퍼티 상세

$bg 보호되어 있는 프로퍼티

protected string $bg
리턴 string

$contentWidth 보호되어 있는 프로퍼티

protected int $contentWidth
리턴 integer

$fg 보호되어 있는 프로퍼티

protected string $fg
리턴 string

$margin 보호되어 있는 프로퍼티

protected int $margin
리턴 integer

$padding 보호되어 있는 프로퍼티

protected int $padding
리턴 integer

$terminal 보호되어 있는 프로퍼티

protected TerminalInterface,PhpSchool\CliMenu\Terminal $terminal
리턴 PhpSchool\CliMenu\Terminal\TerminalInterface

$width 보호되어 있는 프로퍼티

protected int $width
리턴 integer