IUnitDocumentPresentation
| com.pnfsoftware.jeb.core.output.IUnitDocumentPresentation |
 Known Indirect Subclasses
|
Class Overview
Presentation elements are used by clients for display of unit data. They provide on or more
documents. Implementations of this interface may be document factories, holding multiple
documents of the same presentation. It is important to call dispose() when the
presentation is no longer needed.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void |
dispose()
Dispose this presentation.
| ||||||||||
| abstract IGenericDocument |
getDocument()
Get a document.
| ||||||||||
| abstract long |
getId()
Get a unique identifier for the document across all documents generated by the unit
formatter.
| ||||||||||
| abstract String |
getLabel()
Get the label for that document.
| ||||||||||
| abstract boolean |
isDefaultRepresentation()
Determine if the document is the default representation for that unit.
| ||||||||||
Public Methods
public abstract void dispose ()
Dispose this presentation. All created documents held in the presentation shall be destroyed. This method is a fail-safe, calling it is not good practice. Good practice is to let the code that created a document dispose of it.
public abstract IGenericDocument getDocument ()
Get a document. It is implementation-dependent whether the document is a freshly created or a singleton provided by the presentation.
Returns
- the document
public abstract long getId ()
Get a unique identifier for the document across all documents generated by the unit formatter.
Planned extension: Document identifiers will be used by plugins to provide inter-document navigation information to clients. Additional information: Currently, inter-document navigation is entirely the client's responsibility, which may or may not decide, based on knowledge and unit-specific data, incomplete or partial, to add support for it. When the extension is implemented, plugins implementors will have a formal way to specify how documents are linked to one another, and how a client may navigate through them.
Returns
- the optional identifier, 0 if none
public abstract String getLabel ()
Get the label for that document.
Returns
- the optional label
public abstract boolean isDefaultRepresentation ()
Determine if the document is the default representation for that unit.
Returns
- true if this presentation is the default, false otherwise.