public interface

IGenericDocument

com.pnfsoftware.jeb.core.output.IGenericDocument
Known Indirect Subclasses

Class Overview

Base interface for document types that may be returned by a IUnitFormatter.

Currently, a unit formatter may return text, table, and tree (including table tree) documents.

Note: Additional documents to be released: Graph and SVG.

Summary

Public Methods
abstract void dispose()
Dispose of resources and handles used by this document.
abstract IPropertyManager getPropertyManager()
Provide the optional property manager to customize rendering of the document.
abstract IUnit getUnit()
If available, retrieve the unit that backs up this document.

Public Methods

public abstract void dispose ()

Dispose of resources and handles used by this document. The object creator should call this method upon destruction.

public abstract IPropertyManager getPropertyManager ()

Provide the optional property manager to customize rendering of the document. Available properties can be retrieved by retrieving the PDM provided by the property manager.

Returns
  • a PM, null if none

public abstract IUnit getUnit ()

If available, retrieve the unit that backs up this document.

Returns
  • an optional unit reference (may be null)