Row.phpView Source

Show: PublicProtectedPrivateinherited
Table of Contents
Package
Default  

\Webbtj\Clico\Row

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

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

Properties

>VPropertyprivate$columns = array()
Default valuearray()Details
Type
n/a
>VPropertyprivate$distributedWidth = 0
Default value0Details
Type
n/a
>VPropertyprivate$headerLineCharacter
Details
Type
n/a
>VPropertyprivate$height
Details
Type
n/a
>VPropertyprivate$isHeader = false
Default valuefalseDetails
Type
n/a
>VPropertyprivate$pipeCharacter
Details
Type
n/a
>VPropertyprivate$rowLineCharacter
Details
Type
n/a

Methods

methodpublic__construct(Array $data = null) : void

Constructor. Can optionally set the values of the columns

Parameters
NameTypeDescription
$dataArray
methodpublic__toString() : string

Renders the columns, decorated.

Returns
TypeDescription
string
methodpublicaddColumn(\Webbtj\Clico\Column $column) : void

Adds a column to the Row

Parameters
NameTypeDescription
$column\Webbtj\Clico\Column
methodpublicdistributeColumns(integer $maxWidth, integer $numCols) : void

Sets the widths of each column to fit within `$maxWidth`

Parameters
NameTypeDescription
$maxWidthinteger
$numColsinteger
methodpublicgetColumns() : Array

Get the columns

Returns
TypeDescription
Array
methodpublicgetHeaderLineCharacter() : \Webbtj\Clico\Text

Get the character (decorated) used to separate the header row from the body

Returns
TypeDescription
\Webbtj\Clico\Text
methodpublicgetLineCharacter() : \Webbtj\Clico\Text

Get the character (decorated) used to separate this row from other.

This will return either the headerLineCharacter or the rowLineCharacter

Returns
TypeDescription
\Webbtj\Clico\Text
methodpublicgetPipeCharacter() : \Webbtj\Clico\Text

Get the character (decorated) used to separate columns

Returns
TypeDescription
\Webbtj\Clico\Text
methodpublicgetRowLineCharacter() : \Webbtj\Clico\Text

Get the character (decorated) used to separate body rows

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

Get the number of columns wide

Returns
TypeDescription
integer
methodpublicisHeader() : boolean

Check if this Row is the header row

Returns
TypeDescription
boolean
methodpublicpopulate(Array $data) : void

Put data into Columns

Parameters
NameTypeDescription
$dataArray
methodpublicsetHeader() : void

Set this Row as the Table header

methodpublicsetHeaderLineCharacter(\Webbtj\Clico\Text $line) : void

Set the (decorated) character used to separate the header row from the body

Parameters
NameTypeDescription
$line\Webbtj\Clico\Text
methodpublicsetPipeCharacter(\Webbtj\Clico\Text $pipe) : void

Set the (decorated) character used to separate columns

Parameters
NameTypeDescription
$pipe\Webbtj\Clico\Text
methodpublicsetRowLineCharacter(\Webbtj\Clico\Text $line) : void

Set the (decorated) charater used to separate body rows

Parameters
NameTypeDescription
$line\Webbtj\Clico\Text
methodpublicunsetHeader() : void

Make the row not the header

methodpublicverticalConform() : void

Make all columns in the row the same height (stretch shorter columns)

Documentation was generated by phpDocumentor 2.8.5.