Table Column Decorators

Classes like Table and Card do not render their cell contents themselves. Instead they rely on Column Decorator class to position content within the cell.

This is in contrast to View and Lister which do not use Table/Cell and therefore Column decorator is not required.

All column decorators in Agile UI have a base class TableColumn\Generic. Decorators will often look at the content of the associated value, for example Money will add cell class negative only if monetary value is less than zero. The value is taken from Model’s Field object.

Column decorators can also function without associated value. Template may have no fields or perhaps display multiple field values. Action displays interractie buttons in the table. CheckBox makes grid rows selectable. Ordering displays a draggable handle for re-ordering rows within the table.

A final mention is about Multiformat, which is a column decorator that can swap-in any other decorator based on condition. This allows you to change button [Archive] for active records, but if record is already archived, use a template “Archived on {$archive_date}”.

Generic Column Decorator

class atk4\ui\TableColumn\Generic

Generic description of a column for atk4\ui\Table

Table object relies on a separate class: atk4uiTableColumnGeneric to present most of the values. The goals of the column object is to format anything around the actual values. The type = ‘money’ will result in a custom formatting of the value, but will also require column to be right-aligned. To simplify this, type = ‘money’ will use a different column class - TableColumnMoney. There are several others, but first we need to look at the generic column and understand it’s base capabilities:

A class resposnible for cell formatting. This class defines 3 main methods that is used by the Table when constructing HTML:

atk4\ui\TableColumn\Generic::getHeaderCellHTML(atk4dataField $f)

Must respond with HTML for the header cell (<th>) and an appropriate caption. If necessary will include “sorting” icons or any other controls that go in the header of the table.

atk4\ui\TableColumn\Generic::getTotalsCellHTML(atk4dataField $f, $value)

Provided with the field and the value, format the cell for the footer “totals” row. Table can rely on various strategies for calculating totals. See Table::addTotals.

atk4\ui\TableColumn\Generic::getDataCellHTML(atk4dataField f)

Provided with a field, this method will respond with HTML template. In order to keep performance of Web Application at the maximum, Table will execute getDataCellHTML for all the fields once. When iterating, a combined template will be used to display the values.

The template must not incorporate field values (simply because related model will not be loaded just yet), but instead should resort to tags and syntax compatible with Template.

A sample template could be:

<td><b>{$name}</b></td>

Note that the “name” here must correspond with the field name inside the Model. You may use multiple field names to format the column:

<td><b>{$year}-{$month}-{$day}</b></td>

The above 3 methods define first argument as a field, however it’s possible to define column without a physical field. This makes sense for situations when column contains multiple field values or if it doesn’t contain any values at all.

Sometimes you do want to inject HTML instead of using row values:

atk4\ui\TableColumn\Generic::getHTMLTags($model, $field = null)

Return array of HTML tags that will be injected into the row template. See Injecting HTML for further example.

Decorators for data types

In addition to TableColumnGeneric, Agile UI includes several column implementations.

Money

class atk4\ui\TableColumn\TableColumnMoney

Helps decorating monetary values. Will align value to the right and if value is less than zero will also use red text (td class “negative” for semantic ui). The money cells are not wrapped.

For the actual number formatting, see ui_persistence

Status

class atk4\ui\TableColumn\TableColumnStatus

Allow you to set highlight class and icon based on column value. This is most suitable for columns that contain pre-defined values.

If your column “status” can be one of the following “pending”, “declined”, “archived” and “paid” and you would like to use different icons and colors to emphasise status:

$states = [ 'positive'=>['paid', 'archived'], 'negative'=>['declined'] ];

$table->addColumn('status', new \atk4\ui\TableColumn\Status($states));

Current list of states supported:

  • positive (icon checkmark)
  • negative (icon close)
  • and the default/unspecified state (icon question)

(list of states may be expanded furteher)

Template

class atk4\ui\TableColumn\TableColumnTemplate

This column is suitable if you wish to have custom cell formatting but do not wish to go through the trouble of setting up your own class.

If you wish to display movie rating “4 out of 10” based around the column “rating”, you can use:

$table->addColumn('rating', new \atk4\ui\TableColumn\Template('{$rating} out of 10'));

Template may incorporate values from multiple fields in a data row, but current implementation will only work if you asign it to a primary column (by passing 1st argument to addColumn).

(In the future it may be optional with the ability to specify caption).

Interractive Derorators

Actions

class atk4\ui\TableColumn\Actions

Can be used to add “action” column to your table:

$action = $table->addColumn(null, 'Actions');

If you want to have label above the action column, then:

$action = $table->addColumn(null, ['Actions', 'caption'=>'User Actions']);
atk4\ui\TableColumn\Actions::addAction($button, $action, $confirm = false)

Adds another button into “Actions” column which will perform a certain JavaScript action when clicked. See also atk4\ui\Grid::addAction():

$button = $action->addAction('Reload Table', $table->jsReload());

Normally you would also want to pass the ID of the row which was clicked. You can use atk4\ui\Table:jsRow() and jQuery’s data() method to reference it:

$button = $action->addAction('Reload Table', $table->jsReload(['clicked'=>$table->jsRow()->data('id')]));

Moreover you may pass $action argument as a PHP callback.

atk4\ui\TableColumn\Actions::addModal($button, $title, $callback)

Triggers a modal dialog when you click on the button. See description on atk4\ui\Grid::addModalAction():

$action->addAction('Say HI', function ($j, $id) use ($g) {
    return 'Loaded "'.$g->model->load($id)['name'].'" from ID='.$id;
});

Note that in this case ID is automatically passed to your call-back.

CheckBox

class atk4\ui\TableColumn\TableColumnCheckBox
atk4\ui\TableColumn\TableColumnCheckBox::jsChecked()

Adding this column will render checkbox for each row. This column must not be used on a field. CheckBox column provides you with a handy jsChecked() method, which you can use to reference current item selection. The next code will allow you to select the checkboxes, and when you click on the button, it will reload $segment component while passing all the id’s:

$box = $table->addColumn(new \atk4\ui\TableColumn\CheckBox());

$button->on('click', new jsReload($segment, ['ids'=>$box->jsChecked()]));

jsChecked expression represents a JavaScript string which you can place inside a form field, use as argument etc.

Multiformat

Sometimes your formatting may change depending on value. For example you may want to place link only on certain rows. For this you can use a ‘Multiformat’ decorator:

$table->addColumn('amount', ['Multiformat', function($a, $b) {

    if($a['is_invoiced'] > 0) {
        return ['Money', ['Link', 'invoice', ['invoice_id'=>'id']]];
    } elseif (abs($a['is_refunded']) < 50) {
        return [['Template', 'Amount was <b>refunded</b>']];
    }

    return 'Money';
}]);

You supply a callback to the Multiformat decorator, which will then be used to determine the actual set of decorators to be used on a given row. The example above will look at various fields of your models and will conditionally add Link on top of Money formatting.

Your callback can return things in varous ways:

  • return array of seeds: [[‘Link’], ‘Money’];
  • if string or object is returned it is wrapped inside array automatically

Multiple decorators will be created and merged.

Note

If you are operating with large tables, code your own decorator, which would be more CPU-efficient.

Column Menus and Popups

Table column may have a menu as seen in http://ui.agiletoolkit.org/demos/tablecolumnmenu.php. Menu is added into table column and can be linked with Popup or Menu.

Basic Use

The simplest way to use Menus and Popups is through a wrappers: atk4\ui\Grid::addDropdown and atk4\ui\Grid::addPopup:

$grid->addPopup('iso')
    ->add('View')
    ->set('Grid column popup text');

// OR

$grid->addDropdown('name', ['Sort A-Z', 'Sort by Relevance'], function ($item) {
    return $item;
});

Those wrappers will invoke methods TableColumn::addDropdown and TableColmun::addPopup for a specified column, which are documented below.

Popups

atk4\ui\TableColumn\TableColumnCheckBox::addPopup()

To create a popup, you need to get the column decorator object. This must be the first decorator, which is responsible for rendering of the TH box. If you are adding column manually, atk4\ui\Table::addColumn() will return it. When using model, use atk4\ui\Table::getColumnDecorators:

$table = $app->add(['Table', 'celled' => true]);
$table->setModel(new Country($app->db));

$name_column = $table->getColumnDecorators('name');
$name_column[0]->addPopup()->add('LoremIpsum');

Important

If content of a pop-up is too large, it may not be possible to display it on-screen. Watch for warning.

You may also use atk4\ui\Popup::set method to dynamically load the content:

$table = $app->add(['Table', 'celled' => true]);
$table->setModel(new Country($app->db));

$name_column = $table->getColumnDecorators('name');
$name_column[0]->addPopup()->set(function($p) {
    $p->add('HelloWorld');
});