phpDocumentor pond
[ class tree: pond ] [ index: pond ] [ all elements ]

Class: Table

Source Location: /qp_inc/_core/ui/_uiwidget.class.php

Class Table

Descendants
Child Class Description
Results Results class

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Widget

Widget::$global_icons
Widget::$params
Widget::$title

Inherited From Widget

Widget::Widget()
Constructor
Widget::disp_template_raw()
Display a template param without replacing variables
Widget::disp_template_replaced()
Display a template param with its variables replaced
Widget::gen_global_icons()
Generate img tags for registered icons, through global_icon().
Widget::global_icon()
Registers a global action icon
Widget::replace_callback()
Callback function used to replace only necessary values in template.
Widget::replace_callback_wrapper()
This is an additional wrapper to replace_vars() that allows to react on the return value of it.
Widget::replace_vars()
Replaces $vars$ with appropriate values.

[ Top ]
Property Summary
mixed   $displayed_cols_count   Number of cols already displayed (in current line)
mixed   $displayed_lines_count   Number of lines already displayed
array   $fadeout_array  
mixed   $fadeout_count  
mixed   $filter_area   Parameters for the filter area:
boolean   $is_fadeout_line  
mixed   $nb_cols   Number of cols.
mixed   $no_results_text  
mixed   $param_prefix   URL param names
mixed   $total_pages   Total number of pages

[ Top ]
Method Summary
Table   Table()   Constructor
void   display_body_end()  
void   display_body_start()  
void   display_colselect()   Display the column selection
void   display_col_end()  
void   display_col_headers()   Display column headers
void   display_col_start()  
void   display_filters()   Display the filtering form
void   display_head()   Display list/table head.
void   display_init()   Initialize things in order to be ready for displaying.
void   display_line_end()  
void   display_line_start()  
void   display_list_end()   Display list/table end.
void   display_list_start()   Display list/table start.
void   display_option_area()   Display options area
string   replace_callback()   Widget callback for template vars.

[ Top ]
Properties
mixed   $displayed_cols_count [line 261]

Number of cols already displayed (in current line)


[ Top ]
mixed   $displayed_lines_count [line 256]

Number of lines already displayed


[ Top ]
array   $fadeout_array [line 266]

[ Top ]
mixed   $fadeout_count = 0 [line 268]

[ Top ]
mixed   $filter_area [line 287]

Parameters for the filter area:


[ Top ]
boolean   $is_fadeout_line [line 273]

[ Top ]
mixed   $nb_cols [line 251]

Number of cols.


[ Top ]
mixed   $no_results_text [line 275]

[ Top ]
mixed   $param_prefix [line 281]

URL param names


[ Top ]
mixed   $total_pages = 1 [line 246]

Total number of pages


[ Top ]
Methods
Constructor Table  [line 296]

  Table Table( [string $ui_template = NULL], [string $param_prefix = '']  )

Constructor

Parameters:
string   $ui_template:  template name to get from $AdminUI
string   $param_prefix:  prefix to differentiate page/order/filter params


[ Top ]
display_body_end  [line 878]

  void display_body_end( )



[ Top ]
display_body_start  [line 866]

  void display_body_start( )



[ Top ]
display_colselect  [line 489]

  void display_colselect( )

Display the column selection



[ Top ]
display_col_end  [line 973]

  void display_col_end( )



[ Top ]
display_col_headers  [line 595]

  void display_col_headers( )

Display column headers



[ Top ]
display_col_start  [line 924]

  void display_col_start( )



[ Top ]
display_filters  [line 505]

  void display_filters( )

Display the filtering form



[ Top ]
display_head  [line 560]

  void display_head( )

Display list/table head.

This includes list head/title and column headers. EXPERIMENTAL: also dispays <tfoot>



[ Top ]
display_init  [line 314]

  void display_init( [array $display_params = NULL], [array $fadeout = NULL]  )

Initialize things in order to be ready for displaying.

Lazy fills $this->params

Parameters:
array   $display_params:  ***please document***
array   $fadeout:  Fadeout settings array( 'key column' => array of values ) or 'session'


Redefined in descendants as:

[ Top ]
display_line_end  [line 913]

  void display_line_end( )



[ Top ]
display_line_start  [line 887]

  void display_line_start( [ $is_last = false], [ $is_fadeout_line = false]  )

Parameters:
   $is_last: 
   $is_fadeout_line: 


[ Top ]
display_list_end  [line 541]

  void display_list_end( )

Display list/table end.

Typically outputs </ul> or </table>



Redefined in descendants as:

[ Top ]
display_list_start  [line 523]

  void display_list_start( )

Display list/table start.

Typically outputs UL or TABLE tags.



Redefined in descendants as:

[ Top ]
display_option_area  [line 375]

  void display_option_area( string $option_name, string $area_name, string $option_title, string $submit_title, [string $default_folde_state = 'expanded']  )

Display options area

Parameters:
string   $option_name:  name of the option ( ma_colselect, tsk_filter....)
string   $area_name:  area name ( colselect_area, filter_area )
string   $option_title:  option title
string   $submit_title:  submit button title
string   $default_folde_state:  default folde state when is empty in the session


[ Top ]
replace_callback  [line 988]

  string replace_callback( $matches  )

Widget callback for template vars.

This allows to replace template vars, see Widget::replace_callback().

Parameters:
   $matches: 


Redefinition of:
Widget::replace_callback()
Callback function used to replace only necessary values in template.

Redefined in descendants as:

[ Top ]