IUnitDocumentPresentation
| com.pnfsoftware.jeb.core.output.IUnitDocumentPresentation |
 Known Indirect Subclasses
|
Class Overview
This class holds a unit document and presentation elements for that document. Presentation elements are used by clients for display.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract IGenericDocument |
getDocument()
Get the 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 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.