Column.phpView Source

Show: PublicProtectedPrivateinherited
Table of Contents
Package
Default  

\Webbtj\Clico\Column

Package: Default
The Clico Column class is utilized by the Table and Row classes.

It souldn't need to be accessed directly. It it used to fill Rows.

Properties

>VPropertyprivate$height = 1
Default value1Details
Type
n/a
>VPropertyprivate$lines = array()
Default valuearray()Details
Type
n/a
>VPropertyprivate$text = null
Default valuenullDetails
Type
n/a
>VPropertyprivate$textWriter
Details
Type
n/a
>VPropertyprivate$width = 0
Default value0Details
Type
n/a

Methods

methodpublic__construct(String $text) : void

Constructor. Sets the `$text` property on instantiation.

Parameters
NameTypeDescription
$textString
methodpublicgetHeight() : integer

Gets the height of the column (number of lines)

Returns
TypeDescription
integer
methodpublicgetLine(integer $i) : \Webbtj\Clico\Text

Gets a single line

Parameters
NameTypeDescription
$iinteger
Returns
TypeDescription
\Webbtj\Clico\Text
methodpublicgetLines() : Array

Returns all of the lines of text, undecorated

Returns
TypeDescription
Array
methodpublicgetText() : string

Gets the undecorated text

Returns
TypeDescription
string
methodpublicgetTextWriter() : \Webbtj\Clico\Text

Gets the Text class instance

Returns
TypeDescription
\Webbtj\Clico\Text
methodpublicgetWidth() : integer

Gets the width of the column in characters

Returns
TypeDescription
integer
methodprivatepopulateLines() : void

Split the `$text` property into substrings to fit within the set width

methodpublicsetText(String $text) : void

Sets the `$text` property

Parameters
NameTypeDescription
$textString
methodpublicsetWidth(integer $width) : void

Set the column width in characters

Parameters
NameTypeDescription
$widthinteger
methodpublicverticalPad(integer $height) : void

Add additional blank lines to the end of the column

Parameters
NameTypeDescription
$heightinteger
Documentation was generated by phpDocumentor 2.8.5.