Marmot Manual

IX. The MU_Tabulator Class

Introduction

The MU_Tabulator class provides extensive facilities for presenting tabular data to the user. This data will be presented in a pageable view with optional sorting. This table of data may also be made editable, and the developer has simple access to the modified rows.

Properties

Read/write properties

These properties can be set by the developer after instantiating an MU_Tabulator object.

  • title - the title of the Tabulator

  • navigation - 'on' or 'off' (default 'off'), whether the Tabulator should display navigation widgets (start, show, next/prev)

  • show_choices -array of integers (default (10,25,50)) that will be displayed as options for the Show: pulldown menu

  • suppress_sort_direction - set to 1 to hide the Sort Direction pulldown menu

  • number - 'on' or 'off' (default 'off'), whether the Tabulator should number each row

  • row_select - 'on' or 'off' (default 'off'), whether the Tabulator should provide checkboxes to allow rows to be selected.

Read-only properties

These properties are set by the MU_Tabulator class .

  • wants_records - TRUE if the Tabulator needs to be populated with records

  • user_action - contains the name of the action that caused tabulator submission. (This only applies to actions created by the add_user_action() function and not sorting or navigation buttons.)

Table of Contents

MU_Tabulator::MU_Tabulator - Create a new Tabulator object
MU_Tabulator::set_default - Set a default navigation setting for the Tabulator.
MU_Tabulator::set_row_callback - Define a callback function that will be applied to each row as it is added
MU_Tabulator::set_summary_callback - Define a callback function that will be called to generate a summary row at the bottom of the Tabulator
MU_Tabulator::link_row - Add a link to every row
MU_Tabulator::add_hidden - Add a hidden input element to an MU_Tabulator object
MU_Tabulator::add_column - Define a Tabulator coulmn
MU_Tabulator::add_row - Add a row to a Tabulator
MU_Tabulator::add_input_item - Purpose
MU_Tabulator::add_user_action - Add an action button to a Tabulator
MU_Tabulator::value - Retrieve a value from a submitted tabulator
MU_Tabulator::selected - Retrieve selected rows
MU_Tabulator::changed - Retrieve changed rows
MU_Tabulator::refresh - Force the Tabulatorto refresh its data
MU_Tabulator::reset - Reset a tabulator
mu_tabulator_refresh - Clear the cache for a given named Tabulator
mu_tabulator_reset - Completely reset the cache for a given named Tabulator
MU_Tabulator::clear_changed - Forget any changed rows
MU_Tabulator::clear_selected - Forget any selected rows
Prev Up Next
MU_Move_List::removed Home MU_Tabulator::MU_Tabulator