/atk4/lib/Grid/Basic.php

<?php // vim:ts=4:sw=4:et:fdm=marker
/**
 * This is a Basic Grid implementation, which produces fully
 * functional HTML grid capable of filtering, sorting, paginating
 * and using multiple column formatters.
 * 
 * @link http://agiletoolkit.org/doc/grid
*//*
==ATK4===================================================
   This file is part of Agile Toolkit 4 
    http://agiletoolkit.org/
  
   (c) 2008-2011 Romans Malinovskis <atk@agiletech.ie>
   Distributed under Affero General Public License v3
   
   See http://agiletoolkit.org/about/license
 =====================================================ATK4=*/
class Grid_Basic extends CompleteLister {
    public $columns;
    protected $no_records_message="No matching records to display";

    public $last_column;
    public $sortby='0';
    public $sortby_db=null;
    public $not_found=false;

    public $displayed_rows=0;

    private $totals_title_field=null;
    private $totals_title="";
    public $totals_t=null;
    public $totals_value_na = '-';
    public $data=null;

    /**
     * Inline related property
     * If true - TAB key submits row and activates next row
     */
    protected $tab_moves_down=false;
    /**
     * Inline related property
     * Wether or not to show submit line
     */
    protected $show_submit=true;
    private $record_order=null;

    public $title_col=array();

    /**
     * $tdparam property is an array with cell parameters specified in td tag.
     * This should be a hash: 'param_name'=>'param_value'
     * Following parameters treated and processed in a special way:
     * 1) 'style': nested array, style parameter. items of this nested array converted to a form of
     * 		 style: style="param_name: param_value; param_name: param_value"
     * 2) OBSOLTE! wrap: possible values are true|false; if true, 'wrap' is added
     * 		use style/white-space property or simply format_wrap()
     *
     * All the rest are not checked and converted to a form of param_name="param_value"
     *
     * This is a tree-like array with the following structure:
     * array(
     * 		[level1]=>dataset_row=array(
     * 			[level2]=>field=array(
     * 				[level3]=>tdparam_elements=array(
     * 					param_name=>param_value
     * 				)
     * 			)
     * 		)
     * )
     */
    protected $tdparam=array();

    public $js_widget='ui.atk4_grid';
    public $js_widget_arguments=array();

    function init(){
        parent::init();
        //$this->add('Reloadable');
        $this->api->addHook('pre-render',array($this,'precacheTemplate'));

        $this->sortby=$this->learn('sortby',@$_GET[$this->name.'_sort']);
    }
    function defaultTemplate(){
        return array('grid','grid');
    }
    /**
     * Returns the ID value of the expanded content on the basis of GET parameters
     */
    function getExpanderId(){
        return $_GET['expanded'].'_expandedcontent_'.$_GET['id'];
    }
    function addColumn($type,$name=null,$descr=null){
        if($name===null){
            $name=$type;
            $type='text';
        }
        if($descr===null)$descr=ucwords(str_replace('_',' ',$name));
        $this->columns[$name]=array(
                'type'=>$type,
                );
        if(is_array($descr))
            $this->columns[$name]=array_merge($this->columns[$name],$descr);
        else
            $this->columns[$name]['descr']=$descr;

        $this->last_column=$name;

        $subtypes=explode(',',$type);
        foreach($subtypes as $subtype){
            if(method_exists($this,$m='init_'.$subtype))$this->$m($name,$descr);
        }

        return $this;
    }
    function getColumn($column){
        $this->last_column=$column;
        return $this;
    }
    function hasColumn($column){
        return isset($this->columns[$column]);
    }
    function removeColumn($name){
        unset($this->columns[$name]);
        if($this->last_column==$name)$this->last_column=null;
        return $this;
    }
    function addButton($label,$name=null,$return_button=false){
        $button=$this->add('Button','gbtn'.count($this->elements),'grid_buttons');
        $button->setLabel($label);
        if($return_button)return $button;
        return $button;
    }
    function addQuickSearch($fields,$class='QuickSearch'){
        return $this->add($class,null,'quick_search')
            ->useGrid($this)
            ->useFields($fields);
    }
    function makeSortable($db_sort=null){
        // Sorting
        $reverse=false;
        if(substr($db_sort,0,1)=='-'){
            $reverse=true;
            $db_sort=substr($db_sort,1);
        }
        if(!$db_sort)$db_sort=$this->last_column;

        if($this->sortby==$this->last_column){
            // we are already sorting by this column
            $info=array('1',$reverse?0:("-".$this->last_column));
            $this->sortby_db=$db_sort;
        }elseif($this->sortby=="-".$this->last_column){
            // We are sorted reverse by this column
            $info=array('2',$reverse?$this->last_column:'0');
            $this->sortby_db="-".$db_sort;
        }else{
            // we are not sorted by this column
            $info=array('0',$reverse?("-".$this->last_column):$this->last_column);
        }
        $this->columns[$this->last_column]['sortable']=$info;

        return $this;
    }
    function makeTitle(){
        $this->title_col[]=$this->last_column;
        return $this;
    }
    function format_number($field){
    }
    function format_text($field){
        $this->current_row[$field] = $this->current_row[$field];
    }
    function format_shorttext($field){
        $text=$this->current_row[$field];
        //TODO counting words, tags and trimming so that tags are not garbaged
        if(strlen($text)>60)$text=substr($text,0,28).' <b>~~~</b> '.substr($text,-28);;
        $this->current_row[$field]=$text;
        $this->tdparam[$this->getCurrentIndex()][$field]['title']=$this->current_row[$field.'_original'];
    }
    function format_html($field){
        $this->current_row[$field] = htmlspecialchars_decode($this->current_row[$field]);
    }
    function format_boolean($field){
        if($this->current_row[$field] && $this->current_row[$field]!='N'){
            $this->current_row[$field]='<div align=center><i class="atk-icon atk-icons-nobg atk-icon-basic-check"></i></div>';
        }else $this->current_row[$field]='';
    }
    function init_money($field){
        @$this->columns[$field]['thparam'].=' style="text-align: right"';
    }
    function init_real($field){
        @$this->columns[$field]['thparam'].=' style="text-align: right"';
    }
    function init_fullwidth($field){
        @$this->columns[$field]['thparam'].=' style="width: 100%"';
    }
    function format_fullwidth($field){}
    function format_money($field){
        $m=(float)$this->current_row[$field];
        $this->current_row[$field]=number_format($m,2);
        if($m<0){
            $this->setTDParam($field,'style/color','red');
        }else{
            $this->setTDParam($field,'style/color',null);
        }
        $this->setTDParam($field,'align','right');
    }
    function format_totals_number($field){
        return $this->format_number($field);
    }
    function format_totals_money($field){
        return $this->format_money($field);
    }
    function format_totals_real($field){
        return $this->format_real($field);
    }
    function format_totals_text($field){
        // This method is mainly for totals title displaying
        if($field==$this->totals_title_field){
            $this->setTDParam($field,'style/font-weight','bold');
            //$this->current_row[$field]=$this->totals_title.':';
        }
        else $this->current_row[$field]=$this->totals_value_na;
    }
    function format_time($field){
        $this->current_row[$field]=date($this->api->getConfig('locale/time','H:i:s'),
                strtotime($this->current_row[$field]));
    }
    function format_date($field){
        if(!$this->current_row[$field])$this->current_row[$field]='-'; else
            $this->current_row[$field]=date($this->api->getConfig('locale/date','d/m/Y'),
                    strtotime($this->current_row[$field]));
    }
    function format_datetime($field){
        if(!$this->current_row[$field])$this->current_row[$field]='-'; else
            $this->current_row[$field]=date($this->api->getConfig('locale/datetime','d/m/Y H:i:s'),
                    strtotime($this->current_row[$field]));
    }
    function format_timestamp($field){
        if(!$this->current_row[$field])$this->current_row[$field]='-';
        else{
            $format=$this->api->getConfig('locale/timestamp',$this->api->getConfig('locale/datetime','d/m/Y H:i:s'));
            $this->current_row[$field]=date($format,strtotime($this->current_row[$field]));
        }
    }
    function format_nowrap($field){
        $this->tdparam[$this->getCurrentIndex()][$field]['style']='nwhite-space: nowrap';
    }
    function format_wrap($field){
        $this->tdparam[$this->getCurrentIndex()][$field]['style']='white-space: wrap';
    }
    function format_template($field){
        if(!($t=$this->columns[$field]['template'])){
            throw new BaseException('use setTemplate() for field '.$field);
        }
        $this->current_row[$field]=$t
            ->set($this->current_row)
            ->trySet('_value_',$this->current_row[$field])
            ->render();
    }
    function format_widget($field, $widget, $params=array(), $widget_json=null){
        $class=$this->name.'_'.$field.'_expander';
        $params=array(
                'class'=>$class."_".$field." $widget lister_cell"
                )+$params;
        $this->js(true)->_tag('.'.$class.'_'.$field)->_load($widget)->activate($widget_json);
        /*
           $this->api->add('jUI')->addWidget($widget)->activate('.'.$class.'_'.$field,$widget_json);
         */
        $this->tdparam[$this->getCurrentIndex()][$field]=$params;
        if(!$this->current_row[$field]){
            $this->current_row[$field]=$this->columns[$field]['descr'];
        }
    }
    function format_expander_widget($field,$column){
        return $this->format_expander($field,$column);
    }
    function format_expander($field, $column){
        $class=$this->name.'_'.$field.'_expander';
        if(!@$this->current_row[$field]){
            $this->current_row[$field]=$column['descr'];
        }
        // TODO: 
        // reformat this using Button, once we have more advanced system to bypass rendering of
        // sub-elements.
        // $this->current_row[$field]=$this->add('Button',null,false)
        //  ->
        //
        @$this->current_row[$field]='<input type="checkbox" class="button_'.$field.' '.$class.'"
            id="'.$this->name.'_'.$field.'_'.$this->current_row[$column['idfield']?$column['idfield']:'id'].'"
            rel="'.$this->api->getDestinationURL($column['page']?$column['page']:'./'.$field,
            array('expander'=>$field,
                    'cut_page'=>1,
                    'expanded'=>$this->name,

                    // TODO: id is obsolete
                    'id'=>$this->current_row[$column['idfield']?$column['idfield']:'id'],
                    $this->columns[$field]['refid'].'_id'=>$this->current_row[$column['idfield']?$column['idfield']:'id']
                 )
                ).'"
                /><label for="'.$this->name.'_'.$field.'_'.$this->current_row[$column['idfield']?$column['idfield']:'id'].'">'.
                $this->current_row[$field].'</label>';
    }
    function init_expander_widget($field){
        @$this->columns[$field]['thparam'].=' style="width: 40px; text-align: center"';
        return $this->init_expander($field);
    }
    function init_expander($field){
        @$this->columns[$field]['thparam'].=' style="width: 40px; text-align: center"';
        $this->js(true)->find('.button_'.$field)->button();

        if(!isset($this->columns[$field]['refid'])){
            // TODO: test

            $refid=$this->getController();
            if($refid)$refid=$refid->getModel();
            //if($refid)$refid=$refid->entity_code;
            if($refid)$refid=$refid->getEntityCode();//Get Protected property Model::entity_code
            if($refid){
                $this->columns[$field]['refid']=$refid;
            }else{

                if($this->dq)
                    $refid=$this->dq->args['table'];

                if(!$refid)$refid=preg_replace('/.*_/','',$this->api->page);

                $this->columns[$field]['refid']=$refid;
            }
        }


        $class=$this->name.'_'.$field.'_expander';
        $this->js(true)->_selector('.'.$class)->_load('ui.atk4_expander')->atk4_expander();
    }
    function _getFieldType($field){
        return 'line';
    }
    function _inlineUpdate($field,$id,$value){
        $this->dq->set($field,$value)->where($this->dq->args['table'].'.id',$id)->do_update();
    }
    function format_inline($field, $idfield='id'){
        /**
         * Formats the InlineEdit: field that on click should substitute the text
         * in the columns of the row by the edit controls
         *
         * The point is to set an Id for each column of the row. To do this, we should
         * set a property showing that id should be added in prerender
         */
        $val=$this->current_row[$field];
        $this->current_row[$field]='<span id="'.($s=$this->name.'_'.$field.'_inline_'.
            $this->current_row['id']).'" >'.
            '<i style="float: left" class="atk-icon atk-icons-red atk-icon-office-pencil"></i>'.
            $this->current_row[$field].
            '</span>';
        $this->js(true)->_selector('#'.$s)->click(
                $this->js()->_enclose()->_selectorThis()->parent()->atk4_load($this->api->getDestinationURL(null,array($s=>true)))
                );
        if($_GET[$s]){
            // clicked on link
            $this->api->stickyGET($s);
            $f=$this->owner->add('Form',$s,null,array('form_empty','form'));
            $ff=$f->addField($this->_getFieldType($field),'e','');
            $ff->set($val);
            $ff->js('blur',$this->js()->atk4_grid('reloadRow',$this->current_row['id']));
            $ff->js(true)->css(array('width'=>'100%'));
            $_GET['cut_object']=$f->name;

            if($f->isSubmitted()){
                $this->_inlineUpdate($field,$this->current_row['id'],$f->get('e'));
                $this->js()->atk4_grid('reloadRow',$this->current_row['id'])->execute();
            }

            $f->recursiveRender();
        }
    }
    function format_nl2br($field) {
        $this->current_row[$field] = nl2br($this->current_row[$field]);
    }
    function format_order($field, $idfield='id'){
        $n=$this->name.'_'.$field.'_'.$this->current_row[$idfield];
        $this->tdparam[$this->getCurrentIndex()][$field]=array(
                'id'=>$n,
                'style'=>array(
                    'cursor'=>'hand'
                    )
                );
        $this->current_row[$field]=$this->record_order->getCell($this->current_row['id']);
    }
    function init_link($field){
        $this->setTemplate('<a href="<?'.'$_link?'.'>"><?'.'$'.$field.'?'.'></a>');
    }
    function format_link($field){
        $this->current_row['_link']=$this->api->getDestinationURL('./details',array('id'=>$this->current_row['id']));
        return $this->format_template($field);
        /*
           $this->current_row[$field]='<a href="'.$this->api->getDestinationURL($field,
           array('id'=>$this->current_row['id'])).'">'.
           $this->columns[$field]['descr'].'</a>';
         */
    }
    function _performDelete($id){
        $this->dq->where($this->dq->args['table'].'.id',$id)->do_delete();
    }
    function format_delete($field){
        if(!$this->dq)throw new BaseException('delete column requires $dq to be set');
        if($id=@$_GET[$this->name.'_'.$field]){
            // this was clicked
            $this->_performDelete($id);
            $this->js()->univ()->successMessage('Deleted Successfully')->getjQuery()->reload()->execute();
        }
        return $this->format_confirm($field);
    }
    function init_button($field){
        @$this->columns[$field]['thparam'].=' style="width: 40px; text-align: center"';
        $this->js(true)->find('.button_'.$field)->button();
    }
    function setButtonClass($class){
        $this->columns[$this->last_column]['button_class']=$class;
    }
    function init_delete($field){
        $this->columns[$field]['button_class']='red';
        $g=$this;
        $this->api->addHook('post-init',array($this,'_move_delete'),array($field));
        /*function() use($g,$field){
          });
         */
        return $this->init_confirm($field);
    }
    function _move_delete($field){
        if($this->hasColumn($field))$this->addOrder()->move($field,'last')->now();
    }
    function init_confirm($field){
        @$this->columns[$field]['thparam'].=' style="width: 40px; text-align: center"';
        $this->js(true)->find('.button_'.$field)->button();
    }
    function init_prompt($field){
        @$this->columns[$field]['thparam'].=' style="width: 40px; text-align: center"';
        $this->js(true)->find('.button_'.$field)->button();
    }
    function format_button($field){
        $this->current_row[$field]='<button type="button" class="'.$this->columns[$field]['button_class'].'button_'.$field.'" '.
            'onclick="$(this).univ().ajaxec(\''.$this->api->getDestinationURL(null,
            array($field=>$this->current_row['id'],$this->name.'_'.$field=>$this->current_row['id'])).'\')">'.
                (isset($this->columns[$field]['icon'])?$this->columns[$field]['icon']:'').
                $this->columns[$field]['descr'].'</button>';
    }
    function format_confirm($field){
        $this->current_row[$field]='<button type="button" class="'.$this->columns[$field]['button_class'].' button_'.$field.'" '.
            'onclick="$(this).univ().confirm(\'Are you sure?\').ajaxec(\''.$this->api->getDestinationURL(null,
            array($field=>$this->current_row['id'],$this->name.'_'.$field=>$this->current_row['id'])).'\')">'.
                (isset($this->columns[$field]['icon'])?$this->columns[$field]['icon']:'').
                $this->columns[$field]['descr'].'</button>';
    }
    function format_prompt($field){
        $this->current_row[$field]='<button type="button" class="'.$this->columns[$field]['button_class'].'button_'.$field.'" '.
            'onclick="value=prompt(\'Enter value: \');$(this).univ().ajaxec(\''.$this->api->getDestinationURL(null,
            array($field=>$this->current_row['id'],$this->name.'_'.$field=>$this->current_row['id'])).'&value=\'+value)">'.
                (isset($this->columns[$field]['icon'])?$this->columns[$field]['icon']:'').
                $this->columns[$field]['descr'].'</button>';
    }
    function format_checkbox($field){
        $this->current_row[$field] = '<input type="checkbox" id="cb_'.
            $this->current_row['id'].'" name="cb_'.$this->current_row['id'].
            '" value="'.$this->current_row['id'].'"'.
            ($this->current_row['selected']=='Y'?" checked ":" ").//'" onclick="'.
            //$this->onClick($field).
            '/>';
        $this->setTDParam($field,'width','10');
        $this->setTDParam($field,'align','center');
    }
    function format_image($field){
        $this->current_row[$field]='<img src="'.$this->current_row[$field].'"/>';
    }
    function addRecordOrder($field,$table=''){
        if(!$this->record_order){
            $this->record_order=$this->add('RecordOrder');
            $this->record_order->setField($field,$table);
        }
        return $this;
    }
    function staticSortCompare($row1,$row2){
        if($this->sortby[0]=='-'){
            return strcmp($row2[substr($this->sortby,1)],$row1[substr($this->sortby,1)]);
        }
        return strcmp($row1[$this->sortby],$row2[$this->sortby]);
    }
    function setStaticSource($data){
        $this->data=$data;
        if($this->sortby){
            usort($this->data,array($this,'staticSortCompare'));
        }
        return $this;
    }
    function setSource($table,$db_fields=null){
        parent::setSource($table,$db_fields);
        //we always need to calc rows
        $this->dq->calc_found_rows();
        return $this;
    }
    function processSorting(){
        if($this->sortby){
            $desc=false;
            $order=$this->sortby_db;
            if(substr($this->sortby_db,0,1)=='-'){
                $desc=true;
                $order=substr($order,1);
            }
            if($order)$this->dq->order($order,$desc);
        }
    }
    function execQuery(){
        $this->processSorting();
        return parent::execQuery();
    }
    function setTemplate($template){
        // This allows you to use Template
        $this->columns[$this->last_column]['template']=$this->add('SMlite')
            ->loadTemplateFromString($template);
        return $this;
    }
    function getFieldStyle($field,$id){
        /**
         * Returns the structured string with row styles. Used along with getRowContent()
         * in row redrawing
         */
        $style=$this->tdparam[$this->getCurrentIndex()][$field];
        $tdparam=null;
        if(is_array($style)){
            // now we should convert style elements' names to JS compatible
            $tdparam=array();
            foreach($style as $key=>$value){
                switch($key){
                    //case 'background-color':$tdparam[]="$key:$value";break;
                    case 'style': case 'css':
                        // style is a nested array
                        foreach($value as $k=>$v){
                            $tdparam[]="$k::$v";
                        }
                        break;

                    default:
                        $tdparam[]="$key::$value";
                }
            }
        }
        return (is_array($tdparam)?join($tdparam,'<s>'):'');
    }
    function getRowTitle(){
        $title=' ';
        foreach($this->title_col as $col){
            $title.=$this->current_row[$col];
        }
        if($title==' '){
            return "Row #".$this->current_row['id'];
        }
        return substr($title,1);
    }
    function getFieldContent($field,$id){
        /**
         * Returns the properly formatted field content.
         * Used firstly with Ajax::reloadExpandedField()
         */

        // *** Getting required record from DB ***
        $idfield=$this->dq->args['fields'][0];
        if($idfield=='*'||strpos($idfield,',')!==false)$idfield='id';
        $this->dq->where($idfield,$id);
        //we should switch off the limit or we won't get any value
        $this->dq->limit(1);
        $row_data=$this->api->db->getHash($this->dq->select());

        // *** Initializing template ***
        $this->precacheTemplate(false);

        // *** Rendering row ***
        $this->current_row=(array)$row_data;
        $row=$this->formatRow();

        // *** Returning required field value ***
        return $row[$field];
    }
    function formatRow(){
        // Support for StdObject grids
        if(!is_array($this->current_row))$this->current_row=(array)$this->current_row;
        if(!$this->columns)throw new BaseException('No column defined for grid');
        foreach($this->columns as $tmp=>$column){ 
            $this->current_row[$tmp.'_original']=@$this->current_row[$tmp];

            if($this->safe_html_output)
                $this->current_row[$tmp]=htmlspecialchars($this->current_row[$tmp]);

            $formatters = explode(',',$column['type']);
            foreach($formatters as $formatter){
                if(!$formatter)continue;
                if(method_exists($this,$m="format_".$formatter)){
                    $this->$m($tmp,$column);
                }else throw new BaseException("Grid does not know how to format type: ".$formatter);
            }
            // setting cell parameters (tdparam)
            $this->applyTDParams($tmp);
            if($this->current_row[$tmp]=='')$this->current_row[$tmp]='&nbsp;';
        }
        return $this->current_row;
    }
    function applyTDParams($field,$totals=false){
        // setting cell parameters (tdparam)
        $tdparam=@$this->tdparam[$this->getCurrentIndex()][$field];
        $tdparam_str='';
        if(is_array($tdparam)){
            // wrap is replaced by style property
            unset($tdparam['wrap']);
            if(is_array($tdparam['style'])){
                $tdparam_str.='style="';
                foreach($tdparam['style'] as $key=>$value)$tdparam_str.=$key.':'.$value.';';
                $tdparam_str.='" ';
                unset($tdparam['style']);
            }
            //walking and combining string
            foreach($tdparam as $id=>$value)$tdparam_str.=$id.'="'.$value.'" ';
            if($totals)$this->totals_t->set("tdparam_$field",trim($tdparam_str));
            else $this->row_t->trySet("tdparam_$field",trim($tdparam_str));
        }
    }
    function setTotalsTitle($field,$title="Total:"){
        $this->totals_title_field=$field;
        $this->totals_title=$title;
        return $this;
    }
    function formatTotalsRow(){
        foreach($this->columns as $tmp=>$column){
            $formatters = explode(',',$column['type']);
            $all_failed=true;
            foreach($formatters as $formatter){
                if(method_exists($this,$m="format_totals_".$formatter)){
                    $all_failed=false;
                    $this->$m($tmp);
                }
            }
            // setting cell parameters (tdparam)
            $this->applyTDParams($tmp,true);
            if($all_failed)$this->current_row[$tmp]=$this->totals_value_na;
        }
    }
    function updateTotals(){
        parent::updateTotals();
        foreach($this->current_row as $key=>$val){
            if ((!empty($this->totals_title_field)) and ($key==$this->totals_title_field)) {
                $this->totals[$key]=$this->totals_title;
            }
        }
    }
    /**
     * Adds paginator to the grid
     * @param $ipp row count per page
     * @param $name if set, paginator will get the name specified. Useful for saving
     * 		different page numbers for different filtering conditions
     */
    function addPaginator($ipp=25,$name=null){
        // adding ajax paginator
        $this->paginator=$this->add('Paginator', $name, 'paginator', array('paginator', 'ajax_paginator'));
        $this->paginator->region($this->name);
        $this->paginator->cutObject($this->name);
        $this->paginator->ipp($ipp);
        $this->current_row_index=$this->paginator->skip-1;
        return $this;
    }
    function precacheTemplate($full=true){
        // pre-cache our template for row
        // $full=false used for certain row init
        $row = $this->row_t;
        $col = $row->cloneRegion('col');

        $row->set('row_id','<?$id?>');
        $row->trySet('odd_even','<?$odd_even?>');
        $row->del('cols');

        if($full){
            $header = $this->template->cloneRegion('header');
            $header_col = $header->cloneRegion('col');
            $header_sort = $header_col->cloneRegion('sort');

            if($t_row = $this->totals_t){
                $t_col = $t_row->cloneRegion('col');
                $t_row->del('cols');
            }

            $header->del('cols');
        }

        if(count($this->columns)>0){
            foreach($this->columns as $name=>$column){
                $col->del('content');
                $col->set('content','<?$'.$name.'?>');

                if(isset($t_row)){
                    $t_col->del('content');
                    $t_col->set('content','<?$'.$name.'?>');
                    $t_col->trySet('tdparam','<?tdparam_'.$name.'?>style="white-space: nowrap"<?/?>');
                    $t_row->append('cols',$t_col->render());
                }

                // some types needs control over the td

                $col->set('tdparam','<?tdparam_'.$name.'?>style="white-space: nowrap"<?/?>');

                $row->append('cols',$col->render());

                if($full){
                    $header_col->set('descr',$column['descr']);
                    $header_col->trySet('type',$column['type']);
                    if(isset($column['sortable'])){
                        $s=$column['sortable'];
                        // calculate sortlink
                        $l = $this->api->getDestinationURL(null,array($this->name.'_sort'=>$s[1]));

                        $header_sort->trySet('order',$column['sortable'][0]);
                        $sicons=array('vertical','top','bottom');
                        $header_sort->trySet('sorticon',$sicons[$column['sortable'][0]]);
                        $header_sort->set('sortlink',$l);
                        $header_col->set('sort',$header_sort->render());
                    }else{
                        $header_col->del('sort');
                        $header_col->tryDel('sort_del');
                    }

                    if($column['thparam']){
                        $header_col->trySet('thparam',$column['thparam']);
                    }else{
                        $header_col->tryDel('thparam');
                    }

                    $header->append('cols',$header_col->render());

                }
            }
        }
        $this->row_t = $this->api->add('SMlite');
        $this->row_t->loadTemplateFromString($row->render());

        if(isset($t_row)){
            $this->totals_t = $this->api->add('SMlite');
            $this->totals_t->loadTemplateFromString($t_row->render());
        }

        if($full)$this->template->set('header',$header->render());
        // for certain row: required data is in $this->row_t
        //var_dump(htmlspecialchars($this->row_t->tmp_template));

    }
    function render(){

        if($this->js_widget){
            $fn=str_replace('ui.','',$this->js_widget);
            $this->js(true)->_load($this->js_widget)->$fn($this->js_widget_arguments);
        }

        if(($this->dq&&$this->dq->foundRows()==0)||(!isset($this->dq)&&empty($this->data))){
            $def_template = $this->defaultTemplate();
            //$not_found=$this->add('SMlite')->loadTemplate($def_template[0])->cloneRegion('not_found');
            //$this->template->set('no_records_message',$this->no_records_message);
            //$this->template->del('rows');
            //$this->template->del('totals');
            //$this->template->set('header','<tr class="header">'.$not_found->render().'</tr>');
            $this->totals=false;
            $this->template->del('full_table');
            //    		return true;
        }else{
            $this->template->del('not_found');
        }
        parent::render();

    }

    public function setWidth( $width ){
        $this->template->set('container_style', 'margin: 0 auto; width:'.$width.((!is_numeric($width))?'':'px'));
        return $this;
    }
    public function setNoRecords($message){
        $this->no_records_message=$message;
        return $this;
    }
    public function getCurrentIndex($idfield='id'){
        // TODO: think more to optimize this method
        if(is_array($this->data))return array_search(current($this->data),$this->data);
        // else it is dsql dataset...
        return $this->current_row[$idfield];
    }
    public function setTDParam($field,$path,$value){
        // adds a parameter. nested ones can be specified like 'style/color'
        $path=explode('/',$path);
        $current_position=&$this->tdparam[$this->getCurrentIndex()][$field];
        if(!is_array($current_position))$current_position=array();
        foreach($path as $part){
            if(array_key_exists($part,$current_position)){
                $current_position=&$current_position[$part];
            }else{
                $current_position[$part]=array();
                $current_position=&$current_position[$part];
            }
        }
        $current_position=$value;
    }
    public function setTabMovesDown($down=true){
        $this->tab_moves_down=$down;
        return $this;
    }
    public function setShowSubmit($show=true){
        $this->show_submit=$show;
        return $this;
    }
    /**
     * Sets inline properties.
     * @param $props - hash with properties: array('tab_moves_down'=>false/true,'show_submit'=>false/true,etc)
     * 	hash keys should replicate local properties names
     */
    public function setInlineProperties($props){
        foreach($props as $key=>$val){
            $this->$key=$val;
        }
        return $this;
    }
    function addOrder(){
        return $this->add('Order','columns')
            ->useArray($this->columns)
            ;
    }
    /**
     * Adds column on the basis of Model definition
     * If $type is passed - column type is replaced by this value
     */
    function addSelectable($field){
        $this->js_widget=null;
        $this->js(true)
            ->_load('ui.atk4_checkboxes')
            ->atk4_checkboxes(array('dst_field'=>$field));
        $this->addColumn('checkbox','selected');

        $this->addOrder()
            ->useArray($this->columns)
            ->move('selected','first')
            ->now();
    }
    function addFormatter($field,$formatter){
        /*
         * add extra formatter to existing field
         */
        if(!isset($this->columns[$field])){
            throw new BaseException('Cannot format nonexistant field '.$field);
        }
        $this->columns[$field]['type'].=','.$formatter;
        if(method_exists($this,$m='init_'.$formatter))$this->$m($field);
        return $this;
    }
    function setFormatter($field,$formatter){
        /*
         * replace current formatter for field
         */
        if(!isset($this->columns[$field])){
            throw new BaseException('Cannot format nonexistant field '.$field);
        }
        $this->columns[$field]['type']=$formatter;
        if(method_exists($this,$m='init_'.$formatter))$this->$m($field);
        $this->last_column=$field;
        return $this;
    }
    /* to reuse td params */
    function getAllTDParams(){
        return $this->tdparam;
    }
}