list_base Class Reference

#include <list_base.hpp>

Inherited by Affiliate_List, Category_List, Color_List, Customer_List, Designer_List, Font_List, global_content_List, group_sites_List, groups_List, groups_List, groups_List, Manufacturer_List, menu_item_List, Order_Status_List, Ordered_Item_Option_List, Ordered_List, page_item_List, pages_List, Payment_Service_List, Payment_Type_Parameter_List, Product_Categories_List, Product_Line_List, Product_List, Promotion_List, Proofing_List, Query_Result_List, Report_Conditioning_List, Report_List, Report_Parameters_List, Report_Templates_List, Report_Type_List, roles_List, roles_List, roles_List, Scheme_Field_List, Scheme_Table_List, services_List, services_List, services_List, services_List, services_List, services_List, Size_List, Size_Price_List, Table_Field_List, Unit_List, users_List, users_List, users_List, users_List, users_List, Work_List, Work_List, WorkItems, and XXXX_List.

Collaboration diagram for list_base:

[legend]

List of all members.

Public Member Functions

string courtesyFormFields (void)

string courtesyQueryString (string start="")

void addCourtesyArg (string name, string value="")

void setPage (cgiInput &args)

string limitClause (void)

void setSort (cgiInput &args)

void reset (cgiInput &args)

void setFilter (cgiInput &args)

list_base (cgiScript &sc)

virtual ~list_base ()

bool loadListTemplates (string path)

list_base & copyListTemplates (const cgiTemplates &in)

bool getData (string sql)

string whereClause (ocString &filterTemplate)

void maxPageFixup (void)

bool getFilteredData (string rows, string table, ocString filterTemplate, string defaultSort="", string groupBy="", string countTable="")

list_base & emitFilter (string program, string label)

list_base & emitFilters (string program, ocString labels)

list_base & emitHeadings (string pipedelimited)

list_base & emitNavigation (string program)

list_base & emitEnd (void)

void setColFormat (string fmt, int pos)

list_base & emitData (void)

virtual void sendField (int iField, ocString &td)

virtual void sendHotField (int iField, ocString &td)

virtual void derived_commence_event (void)

virtual bool derived_predata_event (void)

virtual void derived_data_event (void)

virtual void derived_complete_event (void)

void setPage (cgiInput &args)

string limitClause (void)

void setSort (cgiInput &args)

void reset (cgiInput &args)

void reset (void)

void setFilter (cgiInput &args)

list_base (cgiScript &sc, Session_Obj &session, string sessionName="")

virtual ~list_base ()

bool loadListTemplates (string path)

list_base & copyListTemplates (const cgiTemplates &in)

bool getData (string sql)

string whereClause (ocString &filterTemplate)

void maxPageFixup (void)

bool getFilteredData (string rows, string table, ocString filterTemplate, string defaultSort="", string groupBy="", string countTable="")

list_base & emitFilter (string program, string label)

string filtersValue (int idx)

list_base & emitFilters (string program, ocString labels)

list_base & emitHeadings (string pipedelimited)

list_base & emitNavigation (string program)

list_base & emitEnd (void)

void setColFormat (string fmt, int pos)

list_base & emitData (void)

virtual void sendField (int iField, ocString &td)

virtual void sendHotField (int iField, ocString &td)

virtual void derived_commence_event (void)

virtual bool derived_predata_event (void)

virtual void derived_data_event (void)

virtual void derived_complete_event (void)

Public Attributes

bool opened

ocString editLink

an edit link in the form of "<a target="_self" href='$prog$?Id=$key$'>$col$"

int hotCol

-1 means no hot columns, -2 means all hot columns other-wise, the hot column is the ordinal final pos, MUST set edit link

int skipCol

allows you to skip 1 column (to skip more than 1, override sendField() or sendHotField()

string addedCriteria

retain added Criteria for listing here (this search criteria is not stored in the Session)

string cookiePrefix

string filter

string sort

string direction

int listPg

int itemsPerPg

int recCount

int colCount

int pgCount

int dsetCount

Protected Attributes

cgiTemplates listTemplate

cgiScript & webIO

cgiCookie cookie

courtesy_args crtsy_args

ocString td

cgiScript & webIO

Session_Obj & session

the means to retention of state is in the Session

string sessionName

set this to an application unique list name if you want to retain list state (pg, filter, and order.) for a local list

Detailed Description

Definition at line 17 of file list_base.hpp.

Constructor & Destructor Documentation

list_base::list_base ( cgiScript & sc ) [inline]

Definition at line 176 of file list_base.hpp.

References cgiEnvironment::ClientArguments(), reset(), setFilter(), setPage(), and setSort().

virtual list_base::~list_base ( ) [inline, virtual]

Definition at line 190 of file list_base.hpp.

list_base::list_base	(	cgiScript &	sc,
		Session_Obj &	session,
		string	sessionName = `""`
	)			`[inline]`

Definition at line 140 of file superlist_base.hpp.

References cgiEnvironment::ClientArguments(), reset(), setFilter(), setPage(), and setSort().

virtual list_base::~list_base ( ) [inline, virtual]

Definition at line 155 of file superlist_base.hpp.

References session, and Session_Obj::Synch().

Member Function Documentation

string list_base::courtesyFormFields ( void ) [inline]

Definition at line 38 of file list_base.hpp.

References crtsy_args.

Referenced by emitNavigation().

string list_base::courtesyQueryString ( string start = "" ) [inline]

Definition at line 58 of file list_base.hpp.

References crtsy_args.

Referenced by emitNavigation().

void list_base::addCourtesyArg	(	string	name,
		string	value = `""`
	)			`[inline]`

Definition at line 84 of file list_base.hpp.

References crtsy_args.

void list_base::setPage ( cgiInput & args ) [inline]

Definition at line 88 of file list_base.hpp.

References cookie, cgiInput::count(), cgiCookie::get(), and listPg.

Referenced by list_base().

string list_base::limitClause ( void ) [inline]

Definition at line 102 of file list_base.hpp.

References ocString::append(), read_base::db, openDB::getProvider(), itemsPerPg, listPg, MySQL, and PostGresQL.

Referenced by getFilteredData().

void list_base::setSort ( cgiInput & args ) [inline]

Definition at line 120 of file list_base.hpp.

References cookie, cgiInput::count(), direction, cgiCookie::get(), cgiCookie::set(), and sort.

Referenced by list_base().

void list_base::reset ( cgiInput & args ) [inline]

Definition at line 143 of file list_base.hpp.

References cookie, cgiInput::count(), and cgiCookie::set().

void list_base::setFilter ( cgiInput & args ) [inline]

Definition at line 160 of file list_base.hpp.

References cookie, cgiInput::count(), filter, cgiCookie::get(), cgiEnvironment::RequestMethod(), cgiCookie::set(), aString::upper(), and webIO.

Referenced by list_base().

bool list_base::loadListTemplates ( string path ) [inline]

Definition at line 192 of file list_base.hpp.

References listTemplate, and cgiTemplates::load().

Referenced by Table_Field_List::derived_data_event(), controlLayout::emit(), groups_Form::form_display(), site_form::form_display(), menu_form::form_display(), Category_form::form_display(), Affiliate_form::form_display(), groups_form::form_display(), Composite_Query_form::form_display(), intraMain(), ReportEmitter::listReports(), and main().

list_base& list_base::copyListTemplates ( const cgiTemplates & in ) [inline]

Definition at line 196 of file list_base.hpp.

References listTemplate.

Referenced by Work_List::sendField().

bool list_base::getData ( string sql ) [inline]

string list_base::whereClause ( ocString & filterTemplate ) [inline]

Definition at line 208 of file list_base.hpp.

References addedCriteria, ocString::endOfParse(), filter, ocString::parse(), ocString::parseInit(), and ocString::replace().

Referenced by getFilteredData().

void list_base::maxPageFixup ( void ) [inline]

Definition at line 234 of file list_base.hpp.

References itemsPerPg, listPg, pgCount, and recCount.

Referenced by getFilteredData().

bool list_base::getFilteredData	(	string	rows,
		string	table,
		ocString	filterTemplate,
		string	defaultSort = `""`,
		string	groupBy = `""`,
		string	countTable = `""`
	)			`[inline]`

Definition at line 239 of file list_base.hpp.

References openRS::close(), direction, dsetCount, basicField::format(), openRS::getField(), openRS::getRecordCount(), limitClause(), maxPageFixup(), openRS::open(), opened, recCount, read_base::rs, sort, webIO, and whereClause().

list_base& list_base::emitFilter	(	string	program,
		string	label
	)			`[inline]`

Definition at line 294 of file list_base.hpp.

References cgiEnvironment::ClientArguments(), cgiInput::count(), cgiTemplates::getParagraph(), listTemplate, ocString::replace(), ocString::replaceAll(), and webIO.

list_base& list_base::emitFilters	(	string	program,
		ocString	labels
	)			`[inline]`

Definition at line 311 of file list_base.hpp.

References cgiEnvironment::ClientArguments(), cgiInput::count(), ocString::endOfParse(), cgiTemplates::getParagraph(), label(), listTemplate, ocString::parse(), ocString::replace(), ocString::replaceAll(), and webIO.

list_base& list_base::emitHeadings ( string pipedelimited ) [inline]

Definition at line 351 of file list_base.hpp.

References colCount, ocString::endOfParse(), cgiTemplates::getParagraph(), listTemplate, ocString::parse(), ocString::replace(), and webIO.

list_base& list_base::emitNavigation ( string program ) [inline]

Definition at line 368 of file list_base.hpp.

References ocString::append(), colCount, courtesyFormFields(), courtesyQueryString(), crtsy_args, dsetCount, cgiTemplates::getParagraph(), listPg, listTemplate, pgCount, recCount, ocString::replace(), ocString::replaceAll(), and webIO.

list_base& list_base::emitEnd ( void ) [inline]

Definition at line 410 of file list_base.hpp.

References ocString::append(), cgiTemplates::getParagraph(), listPg, listTemplate, ocString::replace(), and webIO.

void list_base::setColFormat	(	string	fmt,
		int	pos
	)			`[inline]`

Definition at line 419 of file list_base.hpp.

References openRS::getField(), openRS::getFieldCount(), read_base::rs, and basicField::setFormatMask().

list_base& list_base::emitData ( void ) [inline]

Definition at line 427 of file list_base.hpp.

References derived_commence_event(), derived_complete_event(), derived_data_event(), derived_predata_event(), dsetCount, openRS::getFieldCount(), cgiTemplates::getParagraph(), openRS::getRecordCount(), hotCol, listTemplate, openRS::next(), opened, read_base::rs, sendField(), sendHotField(), skipCol, td, and webIO.

virtual void list_base::sendField	(	int	iField,
		ocString &	td
	)			`[inline, virtual]`

Reimplemented in Scheme_Field_List, Table_Field_List, WorkItems, Work_List, Ordered_List, Category_List, and menu_item_List.

Definition at line 463 of file list_base.hpp.

References basicField::format(), openRS::getField(), ocString::replace(), read_base::rs, and webIO.

Referenced by emitData(), and Table_Field_List::sendField().

virtual void list_base::sendHotField	(	int	iField,
		ocString &	td
	)			`[inline, virtual]`

Reimplemented in Report_List, Report_List, services_List, services_List, Category_List, Payment_Type_Parameter_List, Promotion_List, menu_item_List, page_item_List, global_content_List, and services_List.

Definition at line 469 of file list_base.hpp.

References editLink, basicField::format(), openRS::getField(), ocString::replace(), ocString::replaceAll(), read_base::rs, and webIO.

Referenced by emitData().

virtual void list_base::derived_commence_event ( void ) [inline, virtual]

Definition at line 477 of file list_base.hpp.

Referenced by emitData().

virtual bool list_base::derived_predata_event ( void ) [inline, virtual]

Reimplemented in Work_List.

Definition at line 478 of file list_base.hpp.

Referenced by emitData().

virtual void list_base::derived_data_event ( void ) [inline, virtual]

Reimplemented in Table_Field_List, XXXX_List, group_sites_List, groups_List, roles_List, services_List, and users_List.

Definition at line 479 of file list_base.hpp.

Referenced by emitData().

virtual void list_base::derived_complete_event ( void ) [inline, virtual]

Reimplemented in services_List, services_List, Ordered_List, menu_item_List, page_item_List, global_content_List, and services_List.

Definition at line 480 of file list_base.hpp.

Referenced by emitData().

void list_base::setPage ( cgiInput & args ) [inline]

Definition at line 43 of file superlist_base.hpp.

References cgiInput::count(), Session_Obj::GetData(), listPg, session, and sessionName.

string list_base::limitClause ( void ) [inline]

Definition at line 58 of file superlist_base.hpp.

References ocString::append(), read_base::db, openDB::getProvider(), itemsPerPg, listPg, MySQL, and PostGresQL.

void list_base::setSort ( cgiInput & args ) [inline]

Definition at line 77 of file superlist_base.hpp.

References cgiInput::count(), direction, Session_Obj::GetData(), session, sessionName, Session_Obj::SetData(), and sort.

void list_base::reset ( cgiInput & args ) [inline]

Definition at line 100 of file superlist_base.hpp.

References cgiInput::count(), and reset().

void list_base::reset ( void ) [inline]

Definition at line 105 of file superlist_base.hpp.

References session, sessionName, and Session_Obj::SetData().

Referenced by list_base(), and reset().

void list_base::setFilter ( cgiInput & args ) [inline]

Definition at line 120 of file superlist_base.hpp.

References cgiInput::count(), filter, Session_Obj::GetData(), cgiEnvironment::RequestMethod(), session, sessionName, Session_Obj::SetData(), aString::upper(), and webIO.

bool list_base::loadListTemplates ( string path ) [inline]

Definition at line 161 of file superlist_base.hpp.

References listTemplate, and cgiTemplates::load().

list_base& list_base::copyListTemplates ( const cgiTemplates & in ) [inline]

Definition at line 166 of file superlist_base.hpp.

References listTemplate.

bool list_base::getData ( string sql ) [inline]

Definition at line 172 of file superlist_base.hpp.

References openRS::getRecordCount(), openRS::open(), opened, recCount, and read_base::rs.

string list_base::whereClause ( ocString & filterTemplate ) [inline]

Definition at line 179 of file superlist_base.hpp.

References addedCriteria, ocString::endOfParse(), filter, ocString::parse(), ocString::parseInit(), ocString::replace(), and ocString::replaceAll().

void list_base::maxPageFixup ( void ) [inline]

Definition at line 215 of file superlist_base.hpp.

References ocString::append(), itemsPerPg, listPg, pgCount, recCount, session, sessionName, and Session_Obj::SetData().

bool list_base::getFilteredData	(	string	rows,
		string	table,
		ocString	filterTemplate,
		string	defaultSort = `""`,
		string	groupBy = `""`,
		string	countTable = `""`
	)			`[inline]`

Definition at line 223 of file superlist_base.hpp.

References openRS::close(), direction, dsetCount, basicField::format(), openRS::getField(), openRS::getRecordCount(), limitClause(), maxPageFixup(), openRS::open(), opened, recCount, read_base::rs, sort, webIO, and whereClause().

list_base& list_base::emitFilter	(	string	program,
		string	label
	)			`[inline]`

Definition at line 276 of file superlist_base.hpp.

References cgiEnvironment::ClientArguments(), cgiInput::count(), cgiTemplates::getParagraph(), listTemplate, ocString::replace(), ocString::replaceAll(), and webIO.

string list_base::filtersValue ( int idx ) [inline]

Definition at line 292 of file superlist_base.hpp.

References cgiEnvironment::ClientArguments(), cgiInput::count(), ocString::endOfParse(), ocString::parse(), and webIO.

list_base& list_base::emitFilters	(	string	program,
		ocString	labels
	)			`[inline]`

Definition at line 307 of file superlist_base.hpp.

References ocString::endOfParse(), filter, cgiTemplates::getParagraph(), label(), listTemplate, ocString::parse(), ocString::replace(), ocString::replaceAll(), and webIO.

list_base& list_base::emitHeadings ( string pipedelimited ) [inline]

Definition at line 345 of file superlist_base.hpp.

References colCount, ocString::endOfParse(), cgiTemplates::getParagraph(), listTemplate, ocString::parse(), ocString::replace(), and webIO.

list_base& list_base::emitNavigation ( string program ) [inline]

Definition at line 362 of file superlist_base.hpp.

References ocString::append(), colCount, dsetCount, cgiTemplates::getParagraph(), listPg, listTemplate, pgCount, recCount, ocString::replaceAll(), and webIO.

list_base& list_base::emitEnd ( void ) [inline]

Definition at line 382 of file superlist_base.hpp.

References ocString::append(), cgiTemplates::getParagraph(), listPg, listTemplate, ocString::replace(), and webIO.

void list_base::setColFormat	(	string	fmt,
		int	pos
	)			`[inline]`

Definition at line 391 of file superlist_base.hpp.

References openRS::getField(), openRS::getFieldCount(), read_base::rs, and basicField::setFormatMask().

list_base& list_base::emitData ( void ) [inline]

Definition at line 399 of file superlist_base.hpp.

References derived_commence_event(), derived_complete_event(), derived_data_event(), derived_predata_event(), dsetCount, openRS::getFieldCount(), cgiTemplates::getParagraph(), openRS::getRecordCount(), hotCol, listTemplate, openRS::next(), opened, read_base::rs, sendField(), sendHotField(), skipCol, td, and webIO.

virtual void list_base::sendField	(	int	iField,
		ocString &	td
	)			`[inline, virtual]`

Reimplemented in Scheme_Field_List, Table_Field_List, WorkItems, Work_List, Ordered_List, Category_List, and menu_item_List.

Definition at line 438 of file superlist_base.hpp.

References basicField::format(), openRS::getField(), ocString::replace(), read_base::rs, and webIO.

virtual void list_base::sendHotField	(	int	iField,
		ocString &	td
	)			`[inline, virtual]`

Reimplemented in Report_List, Report_List, services_List, services_List, Category_List, Payment_Type_Parameter_List, Promotion_List, menu_item_List, page_item_List, global_content_List, and services_List.

Definition at line 444 of file superlist_base.hpp.

References editLink, basicField::format(), openRS::getField(), ocString::replace(), ocString::replaceAll(), read_base::rs, and webIO.

virtual void list_base::derived_commence_event ( void ) [inline, virtual]

Definition at line 453 of file superlist_base.hpp.

virtual bool list_base::derived_predata_event ( void ) [inline, virtual]

Reimplemented in Work_List.

Definition at line 454 of file superlist_base.hpp.

virtual void list_base::derived_data_event ( void ) [inline, virtual]

Reimplemented in Table_Field_List, XXXX_List, group_sites_List, groups_List, roles_List, services_List, and users_List.

Definition at line 455 of file superlist_base.hpp.

virtual void list_base::derived_complete_event ( void ) [inline, virtual]

Reimplemented in services_List, services_List, Ordered_List, menu_item_List, page_item_List, global_content_List, and services_List.

Definition at line 456 of file superlist_base.hpp.

Member Data Documentation

cgiTemplates list_base::listTemplate [protected]

Definition at line 20 of file list_base.hpp.

cgiScript& list_base::webIO [protected]

Definition at line 21 of file list_base.hpp.

cgiCookie list_base::cookie [protected]

Definition at line 22 of file list_base.hpp.

Referenced by reset(), setFilter(), setPage(), and setSort().

courtesy_args list_base::crtsy_args [protected]

Definition at line 23 of file list_base.hpp.

Referenced by addCourtesyArg(), courtesyFormFields(), courtesyQueryString(), and emitNavigation().

ocString list_base::td [protected]

Definition at line 24 of file list_base.hpp.

Referenced by emitData().

bool list_base::opened

Definition at line 26 of file list_base.hpp.

Referenced by emitData(), getData(), and getFilteredData().

ocString list_base::editLink

an edit link in the form of "<a target="_self" href='$prog$?Id=$key$'>$col$"

Definition at line 28 of file list_base.hpp.

int list_base::hotCol

-1 means no hot columns, -2 means all hot columns other-wise, the hot column is the ordinal final pos, MUST set edit link

Definition at line 30 of file list_base.hpp.

int list_base::skipCol

allows you to skip 1 column (to skip more than 1, override sendField() or sendHotField()

Definition at line 31 of file list_base.hpp.

Referenced by emitData(), WorkItems::emitHeadings(), page_item_List::list_display(), Work_List::list_display(), WorkItems::list_display(), and Report_List::list_display().

string list_base::addedCriteria

retain added Criteria for listing here (this search criteria is not stored in the Session)

Definition at line 32 of file list_base.hpp.

Referenced by addListCriteria(), ReportEmitter::addListCriteria(), users_List::list_display(), pages_List::list_display(), Report_Templates_List::list_display(), Report_List::list_display(), main(), and whereClause().

string list_base::cookiePrefix

Definition at line 76 of file list_base.hpp.

string list_base::filter

Definition at line 77 of file list_base.hpp.

Referenced by emitFilters(), setFilter(), and whereClause().

string list_base::sort

Definition at line 77 of file list_base.hpp.

Referenced by getFilteredData(), and setSort().

string list_base::direction

Definition at line 77 of file list_base.hpp.

Referenced by getFilteredData(), and setSort().

int list_base::listPg

Definition at line 78 of file list_base.hpp.

Referenced by emitEnd(), emitNavigation(), limitClause(), maxPageFixup(), and setPage().

int list_base::itemsPerPg

Definition at line 78 of file list_base.hpp.

Referenced by limitClause(), Size_List::list_display(), pages_List::list_display(), maxPageFixup(), Product_List::Product_List(), Work_List::Work_List(), and WorkItems::WorkItems().

int list_base::recCount

Definition at line 78 of file list_base.hpp.

Referenced by emitNavigation(), getData(), getFilteredData(), and maxPageFixup().

int list_base::colCount

Definition at line 78 of file list_base.hpp.

Referenced by emitHeadings(), and emitNavigation().

int list_base::pgCount

Definition at line 78 of file list_base.hpp.

Referenced by emitNavigation(), and maxPageFixup().

int list_base::dsetCount

Definition at line 78 of file list_base.hpp.

Referenced by emitData(), emitNavigation(), and getFilteredData().

cgiScript& list_base::webIO [protected]

Definition at line 19 of file superlist_base.hpp.

Session_Obj& list_base::session [protected]

the means to retention of state is in the Session

Definition at line 22 of file superlist_base.hpp.

Referenced by maxPageFixup(), reset(), WorkItems::roleFilter(), Work_List::sendField(), setFilter(), setPage(), setSort(), and ~list_base().

string list_base::sessionName [protected]

set this to an application unique list name if you want to retain list state (pg, filter, and order.) for a local list

Definition at line 24 of file superlist_base.hpp.

Referenced by maxPageFixup(), reset(), setFilter(), setPage(), and setSort().

The documentation for this class was generated from the following files:

openForms/list_base.hpp
openForms/superlist_base.hpp


Public Member Functions
string	courtesyFormFields (void)
string	courtesyQueryString (string start="")
void	addCourtesyArg (string name, string value="")
void	setPage (cgiInput &args)
string	limitClause (void)
void	setSort (cgiInput &args)
void	reset (cgiInput &args)
void	setFilter (cgiInput &args)
	list_base (cgiScript &sc)
virtual	~list_base ()
bool	loadListTemplates (string path)
list_base &	copyListTemplates (const cgiTemplates &in)
bool	getData (string sql)
string	whereClause (ocString &filterTemplate)
void	maxPageFixup (void)
bool	getFilteredData (string rows, string table, ocString filterTemplate, string defaultSort="", string groupBy="", string countTable="")
list_base &	emitFilter (string program, string label)
list_base &	emitFilters (string program, ocString labels)
list_base &	emitHeadings (string pipedelimited)
list_base &	emitNavigation (string program)
list_base &	emitEnd (void)
void	setColFormat (string fmt, int pos)
list_base &	emitData (void)
virtual void	sendField (int iField, ocString &td)
virtual void	sendHotField (int iField, ocString &td)
virtual void	derived_commence_event (void)
virtual bool	derived_predata_event (void)
virtual void	derived_data_event (void)
virtual void	derived_complete_event (void)
void	setPage (cgiInput &args)
string	limitClause (void)
void	setSort (cgiInput &args)
void	reset (cgiInput &args)
void	reset (void)
void	setFilter (cgiInput &args)
	list_base (cgiScript &sc, Session_Obj &session, string sessionName="")
virtual	~list_base ()
bool	loadListTemplates (string path)
list_base &	copyListTemplates (const cgiTemplates &in)
bool	getData (string sql)
string	whereClause (ocString &filterTemplate)
void	maxPageFixup (void)
bool	getFilteredData (string rows, string table, ocString filterTemplate, string defaultSort="", string groupBy="", string countTable="")
list_base &	emitFilter (string program, string label)
string	filtersValue (int idx)
list_base &	emitFilters (string program, ocString labels)
list_base &	emitHeadings (string pipedelimited)
list_base &	emitNavigation (string program)
list_base &	emitEnd (void)
void	setColFormat (string fmt, int pos)
list_base &	emitData (void)
virtual void	sendField (int iField, ocString &td)
virtual void	sendHotField (int iField, ocString &td)
virtual void	derived_commence_event (void)
virtual bool	derived_predata_event (void)
virtual void	derived_data_event (void)
virtual void	derived_complete_event (void)
Public Attributes
bool	opened
ocString	editLink
	an edit link in the form of "<a target="_self" href='$prog$?Id=$key$'>$col$"
int	hotCol
	-1 means no hot columns, -2 means all hot columns other-wise, the hot column is the ordinal final pos, MUST set edit link
int	skipCol
	allows you to skip 1 column (to skip more than 1, override sendField() or sendHotField()
string	addedCriteria
	retain added Criteria for listing here (this search criteria is not stored in the Session)
string	cookiePrefix
string	filter
string	sort
string	direction
int	listPg
int	itemsPerPg
int	recCount
int	colCount
int	pgCount
int	dsetCount
Protected Attributes
cgiTemplates	listTemplate
cgiScript &	webIO
cgiCookie	cookie
courtesy_args	crtsy_args
ocString	td
cgiScript &	webIO
Session_Obj &	session
	the means to retention of state is in the Session
string	sessionName
	set this to an application unique list name if you want to retain list state (pg, filter, and order.) for a local list