This class is the Default phpHtmlLib GUI interface child of the DataList class. This child simply does the job of rendering the html/layout for a DataList.
You can use this as an example of how to build your own look/feel for your DataList.
Located in Program_Root/widgets/data_list/DefaultGUIDataList.inc (line 28)
Container | --BaseWidget | --DataList | --DefaultGUIDatalist
This holds the action column settings if any.
holds the cntr for the action
checkbox name
The overall alignment
DEFAULT: "center"
This variable tells us whether to display
select all checkbox
This variable holds the array of default
selected items. This is populated inside the user_setup() function to pre-populate the list of selected items for a the checkbox action column.
This array holds the list of hidden checkbox[] items.
this array holds some strings for the search functionality. This enables some level of localization for other languages.
Do we show action bar row?
this array keeps track of the list of rendered visible checkbox[] items. So we can not render the hidden version of it.
for a reference so the row_filter affects the paging information.
Inherited from DataList
DataList::$alternating_row_colors
DataList::$_advanced_search_flag
DataList::$_columns
DataList::$_datasource
DataList::$_default_orderby
DataList::$_default_reverseorder
DataList::$_default_rows_per_page
DataList::$_form_attributes
DataList::$_form_render_flag
DataList::$_global_prefix
DataList::$_image_path
DataList::$_max_rows
DataList::$_num_columns
DataList::$_num_pages
DataList::$_save_vars
DataList::$_search_flag
DataList::$_search_table
DataList::$_show_results_flag
DataList::$_simple_search_modifier
DataList::$_vars
Inherited from BaseWidget
BaseWidget::$title
BaseWidget::$width
Inherited from Container
Container::$_flags
this is the method that builds the contents for the middle actionbar td cell.
NOTE this function is meant to be overriden by the child class.
This function builds an action button that will modify the form action, to post to a different script to handle the data
- the button name
- the script that gets called.
This function adds an action column. This adds a column of either checkboxes or radio buttons.
- type of column 'checkbox' or 'radio'
- which column it lives in 'FIRST' or 'LAST'
- which db field is associated with this.
- the title to use for the column. NOTE: if this is set, then there will NOT be a global checkbox that can be used to select/deslect all at once.
Sets the flag for rendering the select all checkbox
flag
This function builds the object/text
to be used for a column header. It can either be an href because its sortable, or it can just be text, because its not sortable.
- the column name to build from the headers.
- the column's data.
the column # we are working on.
Override the parent's method so we can wrap everything in a div to hold it all together when we change the alignment
This builds the table that holds the search capability.
This function returns the array of default checked items to be marked as checked in the checkbox action column
This function is provided to give the child class the ability to precheck/select a particular column.
- the item to look for.
- the row's data.
This function is provided to give the child class the ability to enable/disable a particular checkbox.
- the item to look for.
- the row's data.
set the flag to tell the object to
save the checked items
This allows the caller to turn on/off the rendering of the bottom action bar row
- TRUE = on FALSE = off
this function is used to set the overall alignment of the widget
- the align value
This function is used to set the default list
of selected checkbox items. This is used so the user can pre-populate the list of checked items in the checkbox action column
- the array of checked items
This function sets a prefix for all variables that are used in the item list table on a page. This allows you to have multiple itemlists on a single html page.
- the prefix for all vars.
This function gets the current value of the show actionbar flag setting.
This function ensures that the data we place in a column is aligned according to what the user wants.
- $odd_row - tells us if this cell lives in an odd # row (for alternating row colors)
- the column # we are working on.
- $obj - the data for the td.
- $col_name - the name of the column header for this row to render.
This function renders the action bar at the bottom of the data list.
This function builds a TD with the appropriate action arrow.
- FIRST or LAST
This function builds the user's data cell
This builds an action column cell
- the column to test for FIRST or LAST
- lets us know this is for the header or a cell.
- the row's data.
This function builds the search title table
This function builds the simple search TD
This function builds the JS needed for the checkbox action column
This function tests to see if the child wants to render an action column
- the column to test for FIRST or LAST
This method checks to see if a particular row has been checked in the action column
- the item to look for
- the row's data.
This function returns any Javascript required for this widget
This tests the object flag to
see if the child class wants to automatically save the checked items
Inherited From DataList
DataList::DataList()
DataList::add_header_item()
DataList::advanced_search_disable()
DataList::advanced_search_enable()
DataList::build_base_url()
DataList::build_column_item()
DataList::build_column_url()
DataList::build_gui()
DataList::build_orderby_querystring()
DataList::build_reverseorder_querystring()
DataList::build_searchfield_querystring()
DataList::build_searchvalue_querystring()
DataList::build_state_vars_query_string()
DataList::build_tool_link()
DataList::child_add_row_cell()
DataList::child_build_column_header()
DataList::child_build_search_table()
DataList::child_get_gui()
DataList::data_prefetch()
DataList::do_action()
DataList::filter_column_string()
DataList::get_current_page()
DataList::get_data_source()
DataList::get_default_num_rows()
DataList::get_form_action()
DataList::get_form_method()
DataList::get_form_name()
DataList::get_form_render()
DataList::get_form_target()
DataList::get_global_prefix()
DataList::get_image_path()
DataList::get_last_page()
DataList::get_max_rows()
DataList::get_num_pages()
DataList::get_page_info()
DataList::get_simple_search_modifier()
DataList::gui_init()
DataList::is_advanced_search_enabled()
DataList::is_search_enabled()
DataList::numrows()
DataList::offset()
DataList::orderby()
DataList::render()
DataList::reverseorder()
DataList::search_disable()
DataList::search_enable()
DataList::search_field()
DataList::search_type()
DataList::search_value()
DataList::search_value_filter()
DataList::setup_columns()
DataList::set_data_source()
DataList::set_default_num_rows()
DataList::set_form_action()
DataList::set_form_method()
DataList::set_form_name()
DataList::set_form_render()
DataList::set_form_target()
DataList::set_global_prefix()
DataList::set_image_path()
DataList::set_max_rows()
DataList::set_not_found_message()
DataList::set_numrows()
DataList::set_offset()
DataList::set_reverseorder()
DataList::set_save_vars()
DataList::set_search_type()
DataList::set_show_results()
DataList::set_simple_search_modifier()
DataList::showall()
DataList::simple_search_modifier_value()
DataList::user_setup()
DataList::_build_default_vars()
DataList::_build_save_vars()
DataList::_build_simple_search_modifier()
DataList::_build_tool_url()
DataList::_check_datasource()
DataList::_clean_string()
DataList::_filter_column_string()
DataList::_get()
DataList::_get_searchable_fields()
DataList::_javascript()
DataList::_save_mozilla_nav_link()
DataList::_set()
DataList::_show_results()
Inherited From BaseWidget
BaseWidget::get_align()
BaseWidget::get_css()
BaseWidget::get_javascript()
BaseWidget::get_title()
BaseWidget::get_width()
BaseWidget::set_align()
BaseWidget::set_title()
BaseWidget::set_width()
Inherited From Container
Container::Container()
Container::add()
Container::add_reference()
Container::count_content()
Container::get_indent_flag()
Container::push()
Container::push_reference()
Container::render()
Container::reset_content()
Container::set_collapse()
Container::set_indent_flag()
Container::_set_flags()
Documention generated on Thu, 31 Jul 2003 18:32:24 -0700 by phpDocumentor 1.2.0