data.stdforms
Class SingleTableFormSheet

java.lang.Object
  sale.FormSheet
      data.stdforms.SingleTableFormSheet

All Implemented Interfaces:

Serializable

public class SingleTableFormSheet
extends FormSheet

A FormSheet displaying the contents of a Catalog, Stock or DataBasket.

The FormSheet will comprise one table that renders the contents of the container to be displayed. Additionally, there can be to extra buttons in the FormSheet's button bar that can be used to add or remove records to/from the container. The actions linked to these buttons will be represented as sub-processes to the process which displayed the FormSheet. The actual sub-process will be created by a strategy object.

SingleTableFormSheets assume to be displayed at a user interface gate. However, if you do not want to add editing capabilities, you may set this parameter to null and use the FormSheet as you would any other FormSheet. If you need editing capabilities, you must set the FormSheet at a UIGate.

Various create() methods are offered that cover the entire spectrum of possible SingleTableFormSheets. All you need to do is select the create() method that fits your purpose and use it in your application.

Since:

v2.0

Author:

Steffen Zschaler

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class sale.FormSheet

FormSheet.FormButton

Field Summary

static int	BTNID_ADD The button id that is used for the "Add" button.
static int	BTNID_REMOVE The button id that is used for the "Remove" button.

Fields inherited from class sale.FormSheet

BTNID_CANCEL, BTNID_OK, m_fCancelled

Constructor Summary

protected

SingleTableFormSheet(String sCaption, UIGate uigGate, FormSheetContentCreator fscc) Create a new SingleTableFormSheet.

Method Summary

void	addAddButton(EditButtonStrategy ebsAdd) Add to the FormSheet a button that will allow the user to add records to the container being displayed.
void	addEditingButtons(EditButtonStrategy ebsAdd, EditButtonStrategy ebsRemove) Convenience method.
void	addRemoveButton(EditButtonStrategy ebsRemove) Add to the FormSheet a button that will allow the user to remove the currently selected record from the container being displayed.
static SingleTableFormSheet	create(String sCaption, Catalog c, UIGate uigGate) Create and return a new SingleTableFormSheet that will display the contents of a Catalog.
static SingleTableFormSheet	create(String sCaption, Catalog c, UIGate uigGate, Comparator<CatalogItem> cmp) Create and return a new SingleTableFormSheet that will display the contents of a Catalog.
static SingleTableFormSheet	create(String sCaption, Catalog c, UIGate uigGate, Comparator<CatalogItem> cmp, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a Catalog.
static SingleTableFormSheet	create(String sCaption, Catalog c, UIGate uigGate, DataBasket db) Create and return a new SingleTableFormSheet that will display the contents of a Catalog.
static SingleTableFormSheet	create(String sCaption, Catalog c, UIGate uigGate, DataBasket db, Comparator<CatalogItem> cmp) Create and return a new SingleTableFormSheet that will display the contents of a Catalog.
static SingleTableFormSheet	create(String sCaption, Catalog c, UIGate uigGate, DataBasket db, Comparator<CatalogItem> cmp, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a Catalog.
static SingleTableFormSheet	create(String sCaption, Catalog c, UIGate uigGate, DataBasket db, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a Catalog.
static SingleTableFormSheet	create(String sCaption, Catalog c, UIGate uigGate, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a Catalog.
static SingleTableFormSheet	create(String sCaption, CountingStock cs, UIGate uigGate) Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.
static SingleTableFormSheet	create(String sCaption, CountingStock cs, UIGate uigGate, boolean fShowZeros) Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.
static SingleTableFormSheet	create(String sCaption, CountingStock cs, UIGate uigGate, boolean fShowZeros, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.
static SingleTableFormSheet	create(String sCaption, CountingStock cs, UIGate uigGate, Comparator<CatalogItem> cmp) Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.
static SingleTableFormSheet	create(String sCaption, CountingStock cs, UIGate uigGate, Comparator<CatalogItem> cmp, boolean fShowZeros) Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.
static SingleTableFormSheet	create(String sCaption, CountingStock cs, UIGate uigGate, Comparator<CatalogItem> cmp, boolean fShowZeros, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.
static SingleTableFormSheet	create(String sCaption, CountingStock cs, UIGate uigGate, Comparator<CatalogItem> cmp, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.
static SingleTableFormSheet	create(String sCaption, CountingStock cs, UIGate uigGate, DataBasket db) Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.
static SingleTableFormSheet	create(String sCaption, CountingStock cs, UIGate uigGate, DataBasket db, boolean fShowZeros) Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.
static SingleTableFormSheet	create(String sCaption, CountingStock cs, UIGate uigGate, DataBasket db, boolean fShowZeros, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.
static SingleTableFormSheet	create(String sCaption, CountingStock cs, UIGate uigGate, DataBasket db, Comparator<CatalogItem> cmp) Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.
static SingleTableFormSheet	create(String sCaption, CountingStock cs, UIGate uigGate, DataBasket db, Comparator<CatalogItem> cmp, boolean fShowZeros) Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.
static SingleTableFormSheet	create(String sCaption, CountingStock cs, UIGate uigGate, DataBasket db, Comparator<CatalogItem> cmp, boolean fShowZeros, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.
static SingleTableFormSheet	create(String sCaption, CountingStock cs, UIGate uigGate, DataBasket db, Comparator<CatalogItem> cmp, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.
static SingleTableFormSheet	create(String sCaption, CountingStock cs, UIGate uigGate, DataBasket db, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.
static SingleTableFormSheet	create(String sCaption, CountingStock cs, UIGate uigGate, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.
static SingleTableFormSheet	create(String sCaption, DataBasket db, UIGate uigGate, Comparator<DataBasketEntry> cmp, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a DataBasket.
static SingleTableFormSheet	create(String sCaption, DataBasket db, UIGate uigGate, DataBasketCondition dbc, Comparator<DataBasketEntry> cmp, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a DataBasket.
static SingleTableFormSheet	create(String sCaption, DataBasket db, UIGate uigGate, DataBasketCondition dbc, DataBasketEntryGrouper dbeg, Comparator<DataBasketEntry> cmp, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a DataBasket.
static SingleTableFormSheet	create(String sCaption, DataBasket db, UIGate uigGate, DataBasketCondition dbc, DataBasketEntryGrouper dbeg, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a DataBasket.
static SingleTableFormSheet	create(String sCaption, DataBasket db, UIGate uigGate, DataBasketCondition dbc, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a DataBasket.
static SingleTableFormSheet	create(String sCaption, DataBasket db, UIGate uigGate, DataBasketEntryGrouper dbeg, Comparator<DataBasketEntry> cmp, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a DataBasket.
static SingleTableFormSheet	create(String sCaption, DataBasket db, UIGate uigGate, DataBasketEntryGrouper dbeg, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a DataBasket.
static SingleTableFormSheet	create(String sCaption, DataBasket db, UIGate uigGate, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a DataBasket.
static SingleTableFormSheet	create(String sCaption, StoringStock ss, UIGate uigGate) Create and return a new SingleTableFormSheet that will display the contents of a StoringStock.
static SingleTableFormSheet	create(String sCaption, StoringStock ss, UIGate uigGate, Comparator<StockItem> cmp) Create and return a new SingleTableFormSheet that will display the contents of a StoringStock.
static SingleTableFormSheet	create(String sCaption, StoringStock ss, UIGate uigGate, Comparator<StockItem> cmp, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a StoringStock.
static SingleTableFormSheet	create(String sCaption, StoringStock ss, UIGate uigGate, DataBasket db) Create and return a new SingleTableFormSheet that will display the contents of a StoringStock.
static SingleTableFormSheet	create(String sCaption, StoringStock ss, UIGate uigGate, DataBasket db, Comparator<StockItem> cmp) Create and return a new SingleTableFormSheet that will display the contents of a StoringStock.
static SingleTableFormSheet	create(String sCaption, StoringStock ss, UIGate uigGate, DataBasket db, Comparator<StockItem> cmp, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a StoringStock.
static SingleTableFormSheet	create(String sCaption, StoringStock ss, UIGate uigGate, DataBasket db, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a StoringStock.
static SingleTableFormSheet	create(String sCaption, StoringStock ss, UIGate uigGate, TableEntryDescriptor ted) Create and return a new SingleTableFormSheet that will display the contents of a StoringStock.
DataBasket	getDataBasket() Get the currently attached DataBasket.
UIGate	getGate() Get the Gate this FormSheet is currently being displayed at.
Object	getSelectedRecord() Get the record currently selected.
JTable	getTable() Get the table.
Object	getTableSource() Get the table's source.
void	removeEditButtons() Convenience method for removing the "Add" and the "Remove" button.
void	setGate(UIGate uigGate) Set the gate at which to display the FormSheet.
void	setTableModel(AbstractTableModel tm) Changes the TableModel of a table.

Methods inherited from class sale.FormSheet

addButton, addButton, addContentCreator, attach, attach, attach, buttonIterator, buttonIterator, cancel, close, detachDisplay, detachProcess, detachSalesPoint, fillBtnPanel, getButton, getButtonsLock, getCaption, getComponent, getComponentLock, getDisplay, getDisplayLock, getProcess, getSalesPoint, isCancelled, ok, removeAllButtons, removeButton, setCaption, setComponent, setWaitResponse, toString, waitResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BTNID_ADD

public static final int BTNID_ADD

The button id that is used for the "Add" button.

See Also:

Constant Field Values

BTNID_REMOVE

public static final int BTNID_REMOVE

The button id that is used for the "Remove" button.

See Also:

Constant Field Values

Constructor Detail

SingleTableFormSheet

protected SingleTableFormSheet(String sCaption,
                               UIGate uigGate,
                               FormSheetContentCreator fscc)

Create a new SingleTableFormSheet. The "FormSheet.waitResponse()" property will default to true.

Instead of calling this method, call one of the create() methods provided.

Parameters:

sCaption - the FormSheet's caption.

uigGate - the Gate at which the FormSheet is displayed.

fscc - the content creator to be used to create the FormSheet's contents.

Method Detail

setGate

public void setGate(UIGate uigGate)

Set the gate at which to display the FormSheet. This will also move the FormSheet to that gate, i.e. make the FormSheet the FormSheet of the given gate.

Parameters:

uigGate - the new Gate.

See Also:

UIGate.setFormSheet(sale.FormSheet)

Override:

Never

getGate

public UIGate getGate()

Get the Gate this FormSheet is currently being displayed at.

Override:

Never

getSelectedRecord

public Object getSelectedRecord()

Get the record currently selected.

The actual class of the record depends on the concrete type of TableModel used. See the TableModel's getRecord() method for details. To find out, which TableModel is used by your specific instance of SingleTableFormSheet refer to the documentation of the create() method you used to instantiate it.

getDataBasket

public DataBasket getDataBasket()

Get the currently attached DataBasket.

Override:

Never

getTableSource

public Object getTableSource()

Get the table's source.

Override:

Never

getTable

public JTable getTable()

Get the table.

Override:

Never

setTableModel

public void setTableModel(AbstractTableModel tm)

Changes the TableModel of a table.

Parameters:

tm - the new TableModel

addEditingButtons

public void addEditingButtons(EditButtonStrategy ebsAdd,
                              EditButtonStrategy ebsRemove)

Convenience method. Equivalent to:

 addAddButton (ebsAdd);
 addRemoveButton (ebsRemove);
 

This method must be called from within a content creator if you need serializability.

Override:

Never

addAddButton

public void addAddButton(EditButtonStrategy ebsAdd)

Add to the FormSheet a button that will allow the user to add records to the container being displayed.

The button will by default have a caption of "Add" and a button id of BTNID_ADD. The button's action will trigger the sub-process defined by ebsAdd.

This method must be called from within a content creator if you need serializability.

Parameters:

ebsAdd - a strategy defining the sub-process to be used for adding a record. For a SingleTableFormSheet displaying a Catalog, AbstractAddCatalogItemStrategy is already part of the Framework.

Override:

Never

addRemoveButton

public void addRemoveButton(EditButtonStrategy ebsRemove)

Add to the FormSheet a button that will allow the user to remove the currently selected record from the container being displayed.

The button will by default have a caption of "Remove" and a button id of BTNID_REMOVE. The button's action will trigger the sub-process defined by ebsRemove.

This method must be called from within a content creator if you need serializability.

Parameters:

ebsRemove - a strategy defining the sub-process to be used for removing a record. For a SingleTableFormSheet displaying a Catalog, DefaultRemoveCatalogItemStrategy is already part of the Framework.

Override:

Never

removeEditButtons

public void removeEditButtons()

Convenience method for removing the "Add" and the "Remove" button.

Override:

Never

create

public static SingleTableFormSheet create(String sCaption,
                                          Catalog c,
                                          UIGate uigGate)

Create and return a new SingleTableFormSheet that will display the contents of a Catalog.

The FormSheet will contain a JCatalogTable, the individual records are CatalogItems.

The DataBasket used to determine visibility will default to null, the sorting order defaults to the natural ordering of the CatalogItems. If c is a Currency, the TableEntryDescriptor defaults to a DefaultCurrencyItemTED using c to format values. Otherwise, it defaults to a DefaultCatalogItemTED.

Parameters:

sCaption - the caption of the new FormSheet.

c - the Catalog whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

create

public static SingleTableFormSheet create(String sCaption,
                                          Catalog c,
                                          UIGate uigGate,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a Catalog.

The FormSheet will contain a JCatalogTable, the individual records are CatalogItems.

The DataBasket used to determine visibility will default to null, the sorting order defaults to the natural ordering of the CatalogItems.

Parameters:

sCaption - the caption of the new FormSheet.

c - the Catalog whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

ted - a TableEntryDescriptor that can split individual CatalogItems into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          Catalog c,
                                          UIGate uigGate,
                                          Comparator<CatalogItem> cmp)

Create and return a new SingleTableFormSheet that will display the contents of a Catalog.

The FormSheet will contain a JCatalogTable, the individual records are CatalogItems.

The DataBasket used to determine visibility will default to null. If c is a Currency, the TableEntryDescriptor defaults to a DefaultCurrencyItemTED using c to format values. Otherwise, it defaults to a DefaultCatalogItemTED.

Parameters:

sCaption - the caption of the new FormSheet.

c - the Catalog whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

cmp - a comparator defining the order in which to display the individual items. If null the natural ordering of the CatalogItems will be followed.

create

public static SingleTableFormSheet create(String sCaption,
                                          Catalog c,
                                          UIGate uigGate,
                                          Comparator<CatalogItem> cmp,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a Catalog.

The FormSheet will contain a JCatalogTable, the individual records are CatalogItems.

The DataBasket used to determine visibility will default to null.

Parameters:

sCaption - the caption of the new FormSheet.

c - the Catalog whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

cmp - a comparator defining the order in which to display the individual items. If null the natural ordering of the CatalogItems will be followed.

ted - a TableEntryDescriptor that can split individual CatalogItems into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          Catalog c,
                                          UIGate uigGate,
                                          DataBasket db)

Create and return a new SingleTableFormSheet that will display the contents of a Catalog.

The FormSheet will contain a JCatalogTable, the individual records are CatalogItems.

The sorting order defaults to the natural ordering of the CatalogItems. If c is a Currency, the TableEntryDescriptor defaults to a DefaultCurrencyItemTED using c to format values. Otherwise, it defaults to a DefaultCatalogItemTED.

Parameters:

sCaption - the caption of the new FormSheet.

c - the Catalog whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

db - the DataBasket that is used to determine visibility of items.

create

public static SingleTableFormSheet create(String sCaption,
                                          Catalog c,
                                          UIGate uigGate,
                                          DataBasket db,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a Catalog.

The FormSheet will contain a JCatalogTable, the individual records are CatalogItems.

The sorting order defaults to the natural ordering of the CatalogItems.

Parameters:

sCaption - the caption of the new FormSheet.

c - the Catalog whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

db - the DataBasket that is used to determine visibility of items.

ted - a TableEntryDescriptor that can split individual CatalogItems into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          Catalog c,
                                          UIGate uigGate,
                                          DataBasket db,
                                          Comparator<CatalogItem> cmp)

Create and return a new SingleTableFormSheet that will display the contents of a Catalog.

The FormSheet will contain a JCatalogTable, the individual records are CatalogItems.

If c is a Currency, the TableEntryDescriptor defaults to a DefaultCurrencyItemTED using c to format values. Otherwise, it defaults to a DefaultCatalogItemTED.

Parameters:

sCaption - the caption of the new FormSheet.

c - the Catalog whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

db - the DataBasket that is used to determine visibility of items.

cmp - a comparator defining the order in which to display the individual items. If null the natural ordering of the CatalogItems will be followed.

create

public static SingleTableFormSheet create(String sCaption,
                                          Catalog c,
                                          UIGate uigGate,
                                          DataBasket db,
                                          Comparator<CatalogItem> cmp,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a Catalog.

The FormSheet will contain a JCatalogTable, the individual records are CatalogItems.

Parameters:

sCaption - the caption of the new FormSheet.

c - the Catalog whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

db - the DataBasket that is used to determine visibility of items.

cmp - a comparator defining the order in which to display the individual items. If null the natural ordering of the CatalogItems will be followed.

ted - a TableEntryDescriptor that can split individual CatalogItems into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          CountingStock cs,
                                          UIGate uigGate)

Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.

The FormSheet will contain a JCountingStockTable, the individual records are CountingStockTableModel records.

The DataBasket used to determine visibility will default to null, the sorting order defaults to the natural ordering of the keys. Lines containing '0' in the "Count" column will by default be hidden. If cs is a MoneyBag, the TableEntryDescriptor defaults to a DefaultMoneyBagItemTED using cs.getCatalog() to format values. Otherwise, it defaults to a DefaultCountingStockItemTED.

Parameters:

sCaption - the caption of the new FormSheet.

cs - the CountingStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

create

public static SingleTableFormSheet create(String sCaption,
                                          CountingStock cs,
                                          UIGate uigGate,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.

The FormSheet will contain a JCountingStockTable, the individual records are CountingStockTableModel records.

The DataBasket used to determine visibility will default to null, the sorting order defaults to the natural ordering of the keys. Lines containing '0' in the "Count" column will by default be hidden.

Parameters:

sCaption - the caption of the new FormSheet.

cs - the CountingStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

ted - a TableEntryDescriptor that can split individual CountingStockTableModel records into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          CountingStock cs,
                                          UIGate uigGate,
                                          boolean fShowZeros)

Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.

The FormSheet will contain a JCountingStockTable, the individual records are CountingStockTableModel records.

The DataBasket used to determine visibility will default to null, the sorting order defaults to the natural ordering of the keys. If cs is a MoneyBag, the TableEntryDescriptor defaults to a DefaultMoneyBagItemTED using cs.getCatalog() to format values. Otherwise, it defaults to a DefaultCountingStockItemTED.

Parameters:

sCaption - the caption of the new FormSheet.

cs - the CountingStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

fShowZeros - if false, lines containing a '0' in the "Count" field will be hidden.

create

public static SingleTableFormSheet create(String sCaption,
                                          CountingStock cs,
                                          UIGate uigGate,
                                          boolean fShowZeros,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.

The FormSheet will contain a JCountingStockTable, the individual records are CountingStockTableModel records.

The DataBasket used to determine visibility will default to null, the sorting order defaults to the natural ordering of the keys.

Parameters:

sCaption - the caption of the new FormSheet.

cs - the CountingStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

fShowZeros - if false, lines containing a '0' in the "Count" field will be hidden.

ted - a TableEntryDescriptor that can split individual CountingStockTableModel records into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          CountingStock cs,
                                          UIGate uigGate,
                                          Comparator<CatalogItem> cmp)

Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.

The FormSheet will contain a JCountingStockTable, the individual records are CountingStockTableModel records.

The DataBasket used to determine visibility will default to null. Lines containing '0' in the "Count" column will by default be hidden. If cs is a MoneyBag, the TableEntryDescriptor defaults to a DefaultMoneyBagItemTED using cs.getCatalog() to format values. Otherwise, it defaults to a DefaultCountingStockItemTED.

Parameters:

sCaption - the caption of the new FormSheet.

cs - the CountingStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

cmp - a comparator defining the order in which to display the individual items. If null the records will be ordered by their keys.

create

public static SingleTableFormSheet create(String sCaption,
                                          CountingStock cs,
                                          UIGate uigGate,
                                          Comparator<CatalogItem> cmp,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.

The FormSheet will contain a JCountingStockTable, the individual records are CountingStockTableModel records.

The DataBasket used to determine visibility will default to null. Lines containing '0' in the "Count" column will by default be hidden.

Parameters:

sCaption - the caption of the new FormSheet.

cs - the CountingStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

cmp - a comparator defining the order in which to display the individual items. If null the records will be ordered by their keys.

ted - a TableEntryDescriptor that can split individual CountingStockTableModel records into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          CountingStock cs,
                                          UIGate uigGate,
                                          Comparator<CatalogItem> cmp,
                                          boolean fShowZeros)

Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.

The FormSheet will contain a JCountingStockTable, the individual records are CountingStockTableModel records.

The DataBasket used to determine visibility will default to null. If cs is a MoneyBag, the TableEntryDescriptor defaults to a DefaultMoneyBagItemTED using cs.getCatalog() to format values. Otherwise, it defaults to a DefaultCountingStockItemTED.

Parameters:

sCaption - the caption of the new FormSheet.

cs - the CountingStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

cmp - a comparator defining the order in which to display the individual items. If null the records will be ordered by their keys.

fShowZeros - if false, lines containing a '0' in the "Count" field will be hidden.

create

public static SingleTableFormSheet create(String sCaption,
                                          CountingStock cs,
                                          UIGate uigGate,
                                          Comparator<CatalogItem> cmp,
                                          boolean fShowZeros,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.

The FormSheet will contain a JCountingStockTable, the individual records are CountingStockTableModel records.

The DataBasket used to determine visibility will default to null.

Parameters:

sCaption - the caption of the new FormSheet.

cs - the CountingStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

cmp - a comparator defining the order in which to display the individual items. If null the records will be ordered by their keys.

fShowZeros - if false, lines containing a '0' in the "Count" field will be hidden.

ted - a TableEntryDescriptor that can split individual CountingStockTableModel records into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          CountingStock cs,
                                          UIGate uigGate,
                                          DataBasket db)

Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.

The FormSheet will contain a JCountingStockTable, the individual records are CountingStockTableModel records.

The sorting order defaults to the natural ordering of the keys. Lines containing '0' in the "Count" column will by default be hidden. If cs is a MoneyBag, the TableEntryDescriptor defaults to a DefaultMoneyBagItemTED using cs.getCatalog() to format values. Otherwise, it defaults to a DefaultCountingStockItemTED.

Parameters:

sCaption - the caption of the new FormSheet.

cs - the CountingStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

db - the DataBasket that is used to determine visibility of items.

create

public static SingleTableFormSheet create(String sCaption,
                                          CountingStock cs,
                                          UIGate uigGate,
                                          DataBasket db,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.

The FormSheet will contain a JCountingStockTable, the individual records are CountingStockTableModel records.

The sorting order defaults to the natural ordering of the keys. Lines containing '0' in the "Count" column will by default be hidden.

Parameters:

sCaption - the caption of the new FormSheet.

cs - the CountingStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

db - the DataBasket that is used to determine visibility of items.

ted - a TableEntryDescriptor that can split individual CountingStockTableModel records into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          CountingStock cs,
                                          UIGate uigGate,
                                          DataBasket db,
                                          boolean fShowZeros)

Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.

The FormSheet will contain a JCountingStockTable, the individual records are CountingStockTableModel records.

The sorting order defaults to the natural ordering of the keys. If cs is a MoneyBag, the TableEntryDescriptor defaults to a DefaultMoneyBagItemTED using cs.getCatalog() to format values. Otherwise, it defaults to a DefaultCountingStockItemTED.

Parameters:

sCaption - the caption of the new FormSheet.

cs - the CountingStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

db - the DataBasket that is used to determine visibility of items.

fShowZeros - if false, lines containing a '0' in the "Count" field will be hidden.

create

public static SingleTableFormSheet create(String sCaption,
                                          CountingStock cs,
                                          UIGate uigGate,
                                          DataBasket db,
                                          boolean fShowZeros,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.

The FormSheet will contain a JCountingStockTable, the individual records are CountingStockTableModel records.

The sorting order defaults to the natural ordering of the keys.

Parameters:

sCaption - the caption of the new FormSheet.

cs - the CountingStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

db - the DataBasket that is used to determine visibility of items.

fShowZeros - if false, lines containing a '0' in the "Count" field will be hidden.

ted - a TableEntryDescriptor that can split individual CountingStockTableModel records into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          CountingStock cs,
                                          UIGate uigGate,
                                          DataBasket db,
                                          Comparator<CatalogItem> cmp)

Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.

The FormSheet will contain a JCountingStockTable, the individual records are CountingStockTableModel records.

Lines containing '0' in the "Count" column will by default be hidden. If cs is a MoneyBag, the TableEntryDescriptor defaults to a DefaultMoneyBagItemTED using cs.getCatalog() to format values. Otherwise, it defaults to a DefaultCountingStockItemTED.

Parameters:

sCaption - the caption of the new FormSheet.

cs - the CountingStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

db - the DataBasket that is used to determine visibility of items.

cmp - a comparator defining the order in which to display the individual items. If null the records will be ordered by their keys.

create

public static SingleTableFormSheet create(String sCaption,
                                          CountingStock cs,
                                          UIGate uigGate,
                                          DataBasket db,
                                          Comparator<CatalogItem> cmp,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.

The FormSheet will contain a JCountingStockTable, the individual records are CountingStockTableModel records.

Lines containing '0' in the "Count" column will by default be hidden.

Parameters:

sCaption - the caption of the new FormSheet.

cs - the CountingStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

db - the DataBasket that is used to determine visibility of items.

cmp - a comparator defining the order in which to display the individual items. If null the records will be ordered by their keys.

ted - a TableEntryDescriptor that can split individual CountingStockTableModel records into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          CountingStock cs,
                                          UIGate uigGate,
                                          DataBasket db,
                                          Comparator<CatalogItem> cmp,
                                          boolean fShowZeros)

Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.

The FormSheet will contain a JCountingStockTable, the individual records are CountingStockTableModel records.

If cs is a MoneyBag, the TableEntryDescriptor defaults to a DefaultMoneyBagItemTED using cs.getCatalog() to format values. Otherwise, it defaults to a DefaultCountingStockItemTED.

Parameters:

sCaption - the caption of the new FormSheet.

cs - the CountingStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

db - the DataBasket that is used to determine visibility of items.

cmp - a comparator defining the order in which to display the individual items. If null the records will be ordered by their keys.

fShowZeros - if false, lines containing a '0' in the "Count" field will be hidden.

create

public static SingleTableFormSheet create(String sCaption,
                                          CountingStock cs,
                                          UIGate uigGate,
                                          DataBasket db,
                                          Comparator<CatalogItem> cmp,
                                          boolean fShowZeros,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a CountingStock.

The FormSheet will contain a JCountingStockTable, the individual records are CountingStockTableModel records.

Parameters:

sCaption - the caption of the new FormSheet.

cs - the CountingStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

db - the DataBasket that is used to determine visibility of items.

cmp - a comparator defining the order in which to display the individual items. If null the records will be ordered by their keys.

fShowZeros - if false, lines containing a '0' in the "Count" field will be hidden.

ted - a TableEntryDescriptor that can split individual CountingStockTableModel records into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          StoringStock ss,
                                          UIGate uigGate)

Create and return a new SingleTableFormSheet that will display the contents of a StoringStock.

The FormSheet will contain a JStoringStockTable, the individual records are StockItems.

The DataBasket used to determine visibility will default to null, the sorting order defaults to the natural ordering of the StockItems. The TableEntryDescriptor defaults to a DefaultStockItemTED.

Parameters:

sCaption - the caption of the new FormSheet.

ss - the StoringStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

create

public static SingleTableFormSheet create(String sCaption,
                                          StoringStock ss,
                                          UIGate uigGate,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a StoringStock.

The FormSheet will contain a JStoringStockTable, the individual records are StockItems.

The DataBasket used to determine visibility will default to null, the sorting order defaults to the natural ordering of the StockItems.

Parameters:

sCaption - the caption of the new FormSheet.

ss - the StoringStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

ted - a TableEntryDescriptor that can split individual StockItems into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          StoringStock ss,
                                          UIGate uigGate,
                                          Comparator<StockItem> cmp)

Create and return a new SingleTableFormSheet that will display the contents of a StoringStock.

The FormSheet will contain a JStoringStockTable, the individual records are StockItems.

The DataBasket used to determine visibility will default to null. The TableEntryDescriptor defaults to a DefaultStockItemTED.

Parameters:

sCaption - the caption of the new FormSheet.

ss - the StoringStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

cmp - a comparator defining the order in which to display the individual items. If null the natural order of the StockItems will be applied.

create

public static SingleTableFormSheet create(String sCaption,
                                          StoringStock ss,
                                          UIGate uigGate,
                                          Comparator<StockItem> cmp,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a StoringStock.

The FormSheet will contain a JStoringStockTable, the individual records are StockItems.

The DataBasket used to determine visibility will default to null.

Parameters:

sCaption - the caption of the new FormSheet.

ss - the StoringStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

cmp - a comparator defining the order in which to display the individual items. If null the natural order of the StockItems will be applied.

ted - a TableEntryDescriptor that can split individual StockItems into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          StoringStock ss,
                                          UIGate uigGate,
                                          DataBasket db)

Create and return a new SingleTableFormSheet that will display the contents of a StoringStock.

The FormSheet will contain a JStoringStockTable, the individual records are StockItems.

The sorting order defaults to the natural ordering of the StockItems. The TableEntryDescriptor defaults to a DefaultStockItemTED.

Parameters:

sCaption - the caption of the new FormSheet.

ss - the StoringStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

db - the DataBasket that is used to determine visibility of items.

create

public static SingleTableFormSheet create(String sCaption,
                                          StoringStock ss,
                                          UIGate uigGate,
                                          DataBasket db,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a StoringStock.

The FormSheet will contain a JStoringStockTable, the individual records are StockItems.

The sorting order defaults to the natural ordering of the StockItems.

Parameters:

sCaption - the caption of the new FormSheet.

ss - the StoringStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

db - the DataBasket that is used to determine visibility of items.

ted - a TableEntryDescriptor that can split individual StockItems into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          StoringStock ss,
                                          UIGate uigGate,
                                          DataBasket db,
                                          Comparator<StockItem> cmp)

Create and return a new SingleTableFormSheet that will display the contents of a StoringStock.

The FormSheet will contain a JStoringStockTable, the individual records are StockItems.

The TableEntryDescriptor defaults to a DefaultStockItemTED.

Parameters:

sCaption - the caption of the new FormSheet.

ss - the StoringStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

db - the DataBasket that is used to determine visibility of items.

cmp - a comparator defining the order in which to display the individual items. If null the natural order of the StockItems will be applied.

create

public static SingleTableFormSheet create(String sCaption,
                                          StoringStock ss,
                                          UIGate uigGate,
                                          DataBasket db,
                                          Comparator<StockItem> cmp,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a StoringStock.

The FormSheet will contain a JStoringStockTable, the individual records are StockItems.

Parameters:

sCaption - the caption of the new FormSheet.

ss - the StoringStock whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

db - the DataBasket that is used to determine visibility of items.

cmp - a comparator defining the order in which to display the individual items. If null the natural order of the StockItems will be applied.

ted - a TableEntryDescriptor that can split individual StockItems into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          DataBasket db,
                                          UIGate uigGate,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a DataBasket.

The FormSheet will contain a JDataBasketTable, the individual records are DataBasketEntries.

The default is to show all entries and apply no grouping. The default sorting order sorts entries by their main keys and then by their secondary keys.

Parameters:

sCaption - the caption of the new FormSheet.

db - the DataBasket whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

ted - a TableEntryDescriptor that can split individual DataBasketEntries into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          DataBasket db,
                                          UIGate uigGate,
                                          Comparator<DataBasketEntry> cmp,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a DataBasket.

The FormSheet will contain a JDataBasketTable, the individual records are DataBasketEntries.

The default is to show all entries and apply no grouping.

Parameters:

sCaption - the caption of the new FormSheet.

db - the DataBasket whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

cmp - a comparator defining the order in which to display the individual items. If null entries will be sorted first by their main and then by their secondary keys.

ted - a TableEntryDescriptor that can split individual DataBasketEntries into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          DataBasket db,
                                          UIGate uigGate,
                                          DataBasketEntryGrouper dbeg,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a DataBasket.

The FormSheet will contain a JDataBasketTable, the individual records are DataBasketEntries.

The default is to show all entries. The default sorting order sorts entries by their main keys and then by their secondary keys.

Parameters:

sCaption - the caption of the new FormSheet.

db - the DataBasket whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

dbeg - a grouper that can be used to combine several entries into one for display.

ted - a TableEntryDescriptor that can split individual DataBasketEntries into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          DataBasket db,
                                          UIGate uigGate,
                                          DataBasketEntryGrouper dbeg,
                                          Comparator<DataBasketEntry> cmp,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a DataBasket.

The FormSheet will contain a JDataBasketTable, the individual records are DataBasketEntries.

The default is to show all entries.

Parameters:

sCaption - the caption of the new FormSheet.

db - the DataBasket whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

dbeg - a grouper that can be used to combine several entries into one for display.

cmp - a comparator defining the order in which to display the individual items. If null entries will be sorted first by their main and then by their secondary keys.

ted - a TableEntryDescriptor that can split individual DataBasketEntries into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          DataBasket db,
                                          UIGate uigGate,
                                          DataBasketCondition dbc,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a DataBasket.

The FormSheet will contain a JDataBasketTable, the individual records are DataBasketEntries.

The default is to apply no grouping. The default sorting order sorts entries by their main keys and then by their secondary keys.

Parameters:

sCaption - the caption of the new FormSheet.

db - the DataBasket whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

dbc - a condition specifying the entries to be displayed.

ted - a TableEntryDescriptor that can split individual DataBasketEntries into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          DataBasket db,
                                          UIGate uigGate,
                                          DataBasketCondition dbc,
                                          Comparator<DataBasketEntry> cmp,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a DataBasket.

The FormSheet will contain a JDataBasketTable, the individual records are DataBasketEntries.

The default is to apply no grouping.

Parameters:

sCaption - the caption of the new FormSheet.

db - the DataBasket whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

dbc - a condition specifying the entries to be displayed.

cmp - a comparator defining the order in which to display the individual items. If null entries will be sorted first by their main and then by their secondary keys.

ted - a TableEntryDescriptor that can split individual DataBasketEntries into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          DataBasket db,
                                          UIGate uigGate,
                                          DataBasketCondition dbc,
                                          DataBasketEntryGrouper dbeg,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a DataBasket.

The FormSheet will contain a JDataBasketTable, the individual records are DataBasketEntries.

The default sorting order sorts entries by their main keys and then by their secondary keys.

Parameters:

sCaption - the caption of the new FormSheet.

db - the DataBasket whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

dbc - a condition specifying the entries to be displayed.

dbeg - a grouper that can be used to combine several entries into one for display.

ted - a TableEntryDescriptor that can split individual DataBasketEntries into a table's cells. Must not be null.

create

public static SingleTableFormSheet create(String sCaption,
                                          DataBasket db,
                                          UIGate uigGate,
                                          DataBasketCondition dbc,
                                          DataBasketEntryGrouper dbeg,
                                          Comparator<DataBasketEntry> cmp,
                                          TableEntryDescriptor ted)

Create and return a new SingleTableFormSheet that will display the contents of a DataBasket.

The FormSheet will contain a JDataBasketTable, the individual records are DataBasketEntries.

Parameters:

sCaption - the caption of the new FormSheet.

db - the DataBasket whose contents are to be displayed.

uigGate - the gate at which to display the FormSheet. May be null only if no editing is performed through the FormSheet.

dbc - a condition specifying the entries to be displayed.

dbeg - a grouper that can be used to combine several entries into one for display.

cmp - a comparator defining the order in which to display the individual items. If null entries will be sorted first by their main and then by their secondary keys.

ted - a TableEntryDescriptor that can split individual DataBasketEntries into a table's cells. Must not be null.