SalesPoint v3.3 API

data.stdforms
Class DescriptiveFormSheet

java.lang.Object
  extended by sale.FormSheet
      extended by data.stdforms.DescriptiveFormSheet
All Implemented Interfaces:
Serializable

public class DescriptiveFormSheet
extends FormSheet

A FormSheet that can extend Single- and TwoTableFormSheets by a description element. The element will be placed underneath the table(s) and have the given caption.

In order to display the actual description, the records of the data containers modelled by the table are considered to implement the Descriptive interface. If so, their getDescription() method will be called to get the actual description. If they do not, nothing will be displayed.

Author:
Thomas Ryssel
See Also:
Descriptive, Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class sale.FormSheet
FormSheet.FormButton
 
Field Summary
 
Fields inherited from class sale.FormSheet
BTNID_CANCEL, BTNID_OK, m_fCancelled
 
Constructor Summary
DescriptiveFormSheet(SingleTableFormSheet stfs, String caption)
          Construct a new DescriptiveFormSheet from the given SingleTableFormSheet.
DescriptiveFormSheet(TwoTableFormSheet ttfs, String caption)
          Construct a new DescriptiveFormSheet from the given TwoTableFormSheet.
 
Method Summary
 SingleTableFormSheet getSingleTableFormSheet()
          Get the SingleTableFormSheet this formsheet was constructed with (if so), or null in any other case.
 TwoTableFormSheet getTwoTableFormSheet()
          Get the TwoTableFormSheet this formsheet was constructed with (if so), or null in any other case.
 
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
 

Constructor Detail

DescriptiveFormSheet

public DescriptiveFormSheet(SingleTableFormSheet stfs,
                            String caption)
Construct a new DescriptiveFormSheet from the given SingleTableFormSheet.

Parameters:
stfs - The SingleTableFormSheet which to extend.
caption - Caption of the description box at the bottom.

DescriptiveFormSheet

public DescriptiveFormSheet(TwoTableFormSheet ttfs,
                            String caption)
Construct a new DescriptiveFormSheet from the given TwoTableFormSheet.

Parameters:
ttfs - The TwoTableFormSheet which to extend.
caption - Caption of the description box at the bottom.
Method Detail

getSingleTableFormSheet

public SingleTableFormSheet getSingleTableFormSheet()
Get the SingleTableFormSheet this formsheet was constructed with (if so), or null in any other case.

Returns:
The original SingleTableFormSheet.

getTwoTableFormSheet

public TwoTableFormSheet getTwoTableFormSheet()
Get the TwoTableFormSheet this formsheet was constructed with (if so), or null in any other case.

Returns:
The original TwoTableFormSheet.

SalesPoint v3.3 API