PHP Class PhpSchool\CliMenu\MenuStyle

Author: Michael Woodward ([email protected])

Afficher le fichier Open project: php-school/cli-menu Class Usage Examples

Protected Properties

Свойство	Type	Description
$bg	string
$contentWidth	integer
$fg	string
$margin	integer
$padding	integer
$terminal	PhpSchool\CliMenu\Terminal\TerminalInterface
$width	integer

Méthodes publiques

Méthode	Description
__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

Méthodes protégées

Méthode	Description
calculateContentWidth ( )	Calculate the contents width

Method Details

__construct() public méthode

Initialise style

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

calculateContentWidth() protected méthode

Calculate the contents width

protected calculateContentWidth ( )

getAvailableColours() public static méthode

public static getAvailableColours ( ) : array
Résultat	array

getBg() public méthode

public getBg ( ) : string
Résultat	string

getContentWidth() public méthode

public getContentWidth ( ) : integer
Résultat	integer

getDefaultStyleValues() public static méthode

public static getDefaultStyleValues ( ) : array
Résultat	array

getDisabledItemText() public méthode

public getDisabledItemText ( string $text ) : string
$text	string
Résultat	string

getDisplaysExtra() public méthode

public getDisplaysExtra ( ) : boolean
Résultat	boolean

getFg() public méthode

public getFg ( ) : string
Résultat	string

getItemExtra() public méthode

public getItemExtra ( ) : string
Résultat	string

getMargin() public méthode

public getMargin ( ) : integer
Résultat	integer

getMarker() public méthode

Get the correct marker for the item

public getMarker ( boolean $selected ) : string
$selected	boolean
Résultat	string

getPadding() public méthode

public getPadding ( ) : integer
Résultat	integer

getRightHandPadding() public méthode

Get padding for right had side of content

public getRightHandPadding ( $contentLength ) : integer
$contentLength
Résultat	integer

getSelectedMarker() public méthode

public getSelectedMarker ( ) : string
Résultat	string

getSelectedSetCode() public méthode

Get the colour code set for Bg and Fg

public getSelectedSetCode ( ) : string
Résultat	string

getSelectedUnsetCode() public méthode

Get the colour unset code for Bg and Fg

public getSelectedUnsetCode ( ) : string
Résultat	string

getTitleSeparator() public méthode

public getTitleSeparator ( ) : string
Résultat	string

getUnselectedMarker() public méthode

public getUnselectedMarker ( ) : string
Résultat	string

getUnselectedSetCode() public méthode

Get the inverted colour code

public getUnselectedSetCode ( ) : string
Résultat	string

getUnselectedUnsetCode() public méthode

Get the inverted colour unset code

public getUnselectedUnsetCode ( ) : string
Résultat	string

getWidth() public méthode

public getWidth ( ) : integer
Résultat	integer

setBg() public méthode

public setBg ( string $bg ) : MenuStyle
$bg	string
Résultat	MenuStyle

setDisplaysExtra() public méthode

public setDisplaysExtra ( boolean $displaysExtra )
$displaysExtra	boolean

setFg() public méthode

public setFg ( string $fg ) : MenuStyle
$fg	string
Résultat	MenuStyle

setItemExtra() public méthode

public setItemExtra ( string $itemExtra )
$itemExtra	string

setMargin() public méthode

public setMargin ( integer $margin ) : MenuStyle
$margin	integer
Résultat	MenuStyle

setPadding() public méthode

public setPadding ( integer $padding ) : MenuStyle
$padding	integer
Résultat	MenuStyle

setSelectedMarker() public méthode

public setSelectedMarker ( string $marker )
$marker	string

setTitleSeparator() public méthode

public setTitleSeparator ( string $actionSeparator )
$actionSeparator	string

setUnselectedMarker() public méthode

public setUnselectedMarker ( string $marker )
$marker	string

setWidth() public méthode

public setWidth ( integer $width ) : MenuStyle
$width	integer
Résultat	MenuStyle

Property Details

$bg protected_oe property

protected string $bg
Résultat	string

$contentWidth protected_oe property

protected int $contentWidth
Résultat	integer

$fg protected_oe property

protected string $fg
Résultat	string

$margin protected_oe property

protected int $margin
Résultat	integer

$padding protected_oe property

protected int $padding
Résultat	integer

$terminal protected_oe property

protected TerminalInterface,PhpSchool\CliMenu\Terminal $terminal
Résultat	PhpSchool\CliMenu\Terminal\TerminalInterface

$width protected_oe property

protected int $width
Résultat	integer