Clico
Back to top  

The Clico Row class is utilized by the Table class.

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

package Default

 Methods

Constructor. Can optionally set the values of the columns

__construct(Array $data = null) 

Parameters

$data

Array

Renders the columns, decorated.

__toString() : string

Returns

string

Adds a column to the Row

addColumn(\Webbtj\Clico\Column $column) : void

Parameters

$column

\Webbtj\Clico\Column

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

distributeColumns(integer $maxWidth, integer $numCols) : void

Parameters

$maxWidth

integer

$numCols

integer

Get the columns

getColumns() : Array

Returns

Array

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

getHeaderLineCharacter() : \Webbtj\Clico\Text

Returns

\Webbtj\Clico\Text

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

getLineCharacter() : \Webbtj\Clico\Text

This will return either the headerLineCharacter or the rowLineCharacter

Returns

\Webbtj\Clico\Text

Get the character (decorated) used to separate columns

getPipeCharacter() : \Webbtj\Clico\Text

Returns

\Webbtj\Clico\Text

Get the character (decorated) used to separate body rows

getRowLineCharacter() : \Webbtj\Clico\Text

Returns

\Webbtj\Clico\Text

Get the number of columns wide

getWidth() : integer

Returns

integer

Check if this Row is the header row

isHeader() : boolean

Returns

boolean

Put data into Columns

populate(Array $data) : void

Parameters

$data

Array

Set this Row as the Table header

setHeader() : void

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

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

Parameters

$line

\Webbtj\Clico\Text

Set the (decorated) character used to separate columns

setPipeCharacter(\Webbtj\Clico\Text $pipe) : void

Parameters

$pipe

\Webbtj\Clico\Text

Set the (decorated) charater used to separate body rows

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

Parameters

$line

\Webbtj\Clico\Text

Make the row not the header

unsetHeader() : void

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

verticalConform() : void

 Properties

 

$columns

$columns 

Default

array()
 

$distributedWidth

$distributedWidth 

Default

0
 

$headerLineCharacter

$headerLineCharacter 

Default

 

$height

$height 

Default

 

$isHeader

$isHeader 

Default

false
 

$pipeCharacter

$pipeCharacter 

Default

 

$rowLineCharacter

$rowLineCharacter 

Default