Package com.pnfsoftware.jeb.core.output

Interface IGenericDocument

All Known Subinterfaces:
IDexDisassemblyDocument, INativeDisassemblyDocument, ITableDocument, ITextDocument, ITreeDocument
All Known Implementing Classes:
AbstractTableDocument, AbstractTextDocument, AbstractTextPartAsDocumentProxy, AbstractTreeDocument, AsciiDocument, CDocument, CodeDocument, HexDumpDocument, JavaDocument, StaticTableDocument, StaticTextDocument, StaticTreeDocument
@Ser public interface IGenericDocument
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.

  • Method Summary

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

  • Method Details

    • dispose

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

    • getPropertyManager

      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

    • getUnit

      default IUnit getUnit()
      If available, retrieve the unit that backs up this document.
      Returns:
      an optional unit reference (may be null)