PHP Classes

File: docs/classes/Webbtj_Clico_Row.xhtml

Recommend this page to a friend!
  Classes of TJ Webb  >  Clico PHP CLI Color Text Output  >  docs/classes/Webbtj_Clico_Row.xhtml  >  Download  
File: docs/classes/Webbtj_Clico_Row.xhtml
Role: Auxiliary data
Content type: text/plain
Description: Auxiliary data
Class: Clico PHP CLI Color Text Output
Format text to display on a CLI console
Author: By
Last change:
Date: 3 years ago
Size: 10,562 bytes
 

Contents

Class file image Download
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html SYSTEM "about:legacy-compat"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> <head> <title>phpDox - Webbtj\Clico\Row</title> <link rel="stylesheet" type="text/css" href="../css/style.css" media="screen"/> <meta http-equiv="content-type" content="text/html; charset=utf-8"/> </head> <body> <nav class="topnav"> <ul> <li> <div class="logo"><span>/**</span>phpDox</div> </li> <li class="separator"> <a href="../index.xhtml">Overview</a> </li> <li class="separator"> <a href="../namespaces.xhtml">Namespaces</a> </li> <li> <a href="../classes.xhtml">Classes</a> </li> <li class="separator"> <a href="../source/index.xhtml">Source</a> </li> </ul> </nav> <div id="mainstage"> <div class="box"> <ul class="breadcrumb"> <li> <a href="../index.xhtml">Overview</a> </li> <li class="separator"> <a href="../classes.xhtml">Classes</a> </li> <li class="separator"> <a href="../classes.xhtml#Webbtj_Clico">Webbtj\Clico</a> </li> <li class="separator">Row</li> </ul> </div> <nav class="box"> <ul> <li> <a href="#introduction">Introduction</a> </li> <li> <a href="#synopsis">Synopsis</a> </li> <li> <a href="#members">Members</a> </li> <li> <a href="#methods">Methods</a> </li> <li> <a href="../source/Row.php.xhtml#line13">Source</a> </li> </ul> </nav> <section> <h1 id="introduction"><small>Webbtj\Clico\</small>Row</h1> <h4>The Clico Row class is utilized by the Table class.</h4> <p>It souldn't need to be accessed directly. It it used to fill Tables.</p> <ul/> <h2 id="synopsis">Synopsis</h2> <div class="synopsis">class Row {<br/><ul class="none"><li>// members</li><li>private array <a href="#members">$columns</a> = ; </li><li>private integer <a href="#members">$distributedWidth</a> = 0; </li><li>private  <a href="#members">$headerLineCharacter</a>; </li><li>private  <a href="#members">$height</a>; </li><li>private boolean <a href="#members">$isHeader</a> = false; </li><li>private  <a href="#members">$pipeCharacter</a>; </li><li>private  <a href="#members">$rowLineCharacter</a>; </li></ul><ul class="none"><li>// methods</li><li>public void <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/__construct.xhtml">__construct</a>() </li><li>public string <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/__toString.xhtml">__toString</a>() </li><li>public void <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/addColumn.xhtml">addColumn</a>() </li><li>public void <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/distributeColumns.xhtml">distributeColumns</a>() </li><li>public Array <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/getColumns.xhtml">getColumns</a>() </li><li>public Text <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/getHeaderLineCharacter.xhtml">getHeaderLineCharacter</a>() </li><li>public Text <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/getLineCharacter.xhtml">getLineCharacter</a>() </li><li>public Text <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/getPipeCharacter.xhtml">getPipeCharacter</a>() </li><li>public Text <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/getRowLineCharacter.xhtml">getRowLineCharacter</a>() </li><li>public integer <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/getWidth.xhtml">getWidth</a>() </li><li>public boolean <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/isHeader.xhtml">isHeader</a>() </li><li>public void <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/populate.xhtml">populate</a>() </li><li>public void <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/setHeader.xhtml">setHeader</a>() </li><li>public void <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/setHeaderLineCharacter.xhtml">setHeaderLineCharacter</a>() </li><li>public void <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/setPipeCharacter.xhtml">setPipeCharacter</a>() </li><li>public void <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/setRowLineCharacter.xhtml">setRowLineCharacter</a>() </li><li>public void <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/unsetHeader.xhtml">unsetHeader</a>() </li><li>public void <a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/verticalConform.xhtml">verticalConform</a>() </li></ul> }<br/></div> <h2 id="members">Members</h2> <div class="styled members"> <h4>private</h4> <ul class="members"> <li id="columns"> <strong>$columns</strong> </li> <li id="distributedWidth"> <strong>$distributedWidth</strong> </li> <li id="headerLineCharacter"> <strong>$headerLineCharacter</strong> </li> <li id="height"> <strong>$height</strong> </li> <li id="isHeader"> <strong>$isHeader</strong> </li> <li id="pipeCharacter"> <strong>$pipeCharacter</strong> </li> <li id="rowLineCharacter"> <strong>$rowLineCharacter</strong> </li> </ul> </div> <h2 id="methods">Methods</h2> <div class="styled"> <h4>public</h4> <ul> <li id="__construct"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/__construct.xhtml">__construct()</a> ? Constructor. Can optionally set the values of the columns</li> <li id="__toString"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/__toString.xhtml">__toString()</a> ? Renders the columns, decorated.</li> <li id="addColumn"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/addColumn.xhtml">addColumn()</a> ? Adds a column to the Row</li> <li id="distributeColumns"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/distributeColumns.xhtml">distributeColumns()</a> ? Sets the widths of each column to fit within `$maxWidth`</li> <li id="getColumns"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/getColumns.xhtml">getColumns()</a> ? Get the columns</li> <li id="getHeaderLineCharacter"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/getHeaderLineCharacter.xhtml">getHeaderLineCharacter()</a> ? Get the character (decorated) used to separate the header row from the body</li> <li id="getLineCharacter"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/getLineCharacter.xhtml">getLineCharacter()</a> ? Get the character (decorated) used to separate this row from other.</li> <li id="getPipeCharacter"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/getPipeCharacter.xhtml">getPipeCharacter()</a> ? Get the character (decorated) used to separate columns</li> <li id="getRowLineCharacter"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/getRowLineCharacter.xhtml">getRowLineCharacter()</a> ? Get the character (decorated) used to separate body rows</li> <li id="getWidth"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/getWidth.xhtml">getWidth()</a> ? Get the number of columns wide</li> <li id="isHeader"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/isHeader.xhtml">isHeader()</a> ? Check if this Row is the header row</li> <li id="populate"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/populate.xhtml">populate()</a> ? Put data into Columns</li> <li id="setHeader"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/setHeader.xhtml">setHeader()</a> ? Set this Row as the Table header</li> <li id="setHeaderLineCharacter"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/setHeaderLineCharacter.xhtml">setHeaderLineCharacter()</a> ? Set the (decorated) character used to separate the header row from the body</li> <li id="setPipeCharacter"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/setPipeCharacter.xhtml">setPipeCharacter()</a> ? Set the (decorated) character used to separate columns</li> <li id="setRowLineCharacter"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/setRowLineCharacter.xhtml">setRowLineCharacter()</a> ? Set the (decorated) charater used to separate body rows</li> <li id="unsetHeader"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/unsetHeader.xhtml">unsetHeader()</a> ? Make the row not the header</li> <li id="verticalConform"><a title="Webbtj\Clico\Row" href="../classes/Webbtj_Clico_Row/verticalConform.xhtml">verticalConform()</a> ? Make all columns in the row the same height (stretch shorter columns)</li> </ul> </div> </section> </div> <footer> <span>Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2019 by Arne Blankerts and Contributors</span> </footer> </body> </html>