AsciiDocument

Class Overview

A text document used to represent textual data, on a best-effort basis. Units may generate this type of document when they would like to have clients represent some or all their contents as text data.

The input data can be of any size, up to 2^63 bytes, and arbitrarily encoded. Non Ascii-printable characters will be escaped and rendered as \x?? entities.

Similarly to HexDumpDocument objects, these objects are not necessarily tied to units. If related to units, and since the addressing scheme may not consistent with other documents' of such unit, the reserved prefix '@' is used for addresses. Addresses are like: @line,column where line and column are 1-based.

Note: this document is not serializable; it should not be used in a list of persisted presentations.

Summary

[Expand] Inherited Fields
From class com.pnfsoftware.jeb.util.events.EventSource public static final AtomicInteger onEventCallCount

[Expand] Inherited Methods
From class com.pnfsoftware.jeb.core.output.text.impl.AbstractTextDocument final ICoordinates addressToCoordinates(String address) Convert a unit-specific address to document-specific text coordinates. ICoordinates addressToCoordinates(String address, CoordinatesConversionPrecision precision) Precision is not used - Use an exact address final String coordinatesToAddress(ICoordinates coordinates) Convert document-specific text coordinates to a unit-specific address using a default conversion precision. String coordinatesToAddress(ICoordinates coordinates, AddressConversionPrecision precision) Convert document-specific text coordinates to a unit-specific address. void dispose() The default implementation does nothing. String format() Format this text document. ITextDocumentPart getDocumentPart(long anchorId, int linesAfter) Retrieve a document part. ITextDocumentPart getDocumentPart2(long anchorBegin, long anchorEnd) The default implementation throws. long getFirstAnchor() The default implementation returns 0. long getInitialAnchor() The default implementation returns the first anchor as the initial anchor. IPropertyManager getPropertyManager() The default implementation returns null. String toString() boolean useDisplayLineNumber() Specify if coordinatesToAddress(ICoordinates, AddressConversionPrecision) and addressToCoordinates(String, CoordinatesConversionPrecision) will use the anchor inner value or should display as a text editor (where first line is line 1). boolean useLineDelta() Specify if coordinatesToAddress(ICoordinates, AddressConversionPrecision) and addressToCoordinates(String, CoordinatesConversionPrecision) will use the line Delta.
From class com.pnfsoftware.jeb.util.events.EventSource void addListener(IEventListener listener) Register a listener. int countListeners() Get the numbers of objects listening to this event source. List<IEventListener> getListeners() Get a copy of the list of listeners. IEventSource getParentSource() Get the parent source. void insertListener(int index, IEventListener listener) Register a listener. void notifyListeners(Event e) void notifyListeners(IEvent e) Notify listeners that an event has occurred. void notifyListeners(Event e, boolean notifyParent) static IEventListener relay(IEventSource origin, IEventSource proxy) Relay events issued from an origin to the listeners of a proxy. void removeListener(IEventListener listener) Unregister a listener. void setParentSource(IEventSource parentSource) Set a parent source.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface com.pnfsoftware.jeb.core.output.IGenericDocument 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.
From interface com.pnfsoftware.jeb.core.output.text.ITextDocument abstract ICoordinates addressToCoordinates(String address) Convert a unit-specific address to document-specific text coordinates. abstract ICoordinates addressToCoordinates(String address, CoordinatesConversionPrecision precision) Convert a unit-specific address to document-specific text coordinates. abstract String coordinatesToAddress(ICoordinates coordinates) Convert document-specific text coordinates to a unit-specific address using a default conversion precision. abstract String coordinatesToAddress(ICoordinates coordinates, AddressConversionPrecision precision) Convert document-specific text coordinates to a unit-specific address. abstract String format() Format this text document. abstract long getAnchorCount() Get the range of anchor points in the document. abstract IBinaryRepresentation getBinaryRepresentation() Retrieve a binary representation of this document. abstract ITextDocumentPart getDocumentPart(long anchorId, int linesAfter) Retrieve a document part. abstract ITextDocumentPart getDocumentPart(long anchorId, int linesAfter, int linesBefore) Retrieve a document part. abstract ITextDocumentPart getDocumentPart2(long anchorBegin, long anchorEnd) Retrieve the document part located between two anchor references. abstract long getFirstAnchor() Get the first anchor identifier of the document. abstract long getInitialAnchor() Get the anchor identifier that would represent the first logical section of a document (meaning the anchor to focus on when opening a document). abstract boolean hasBinaryRepresentation() Determine if this document offers binary representations.
From interface com.pnfsoftware.jeb.util.events.IEventSource abstract void addListener(IEventListener listener) Register a listener. abstract int countListeners() Get the numbers of objects listening to this event source. abstract List<? extends IEventListener> getListeners() Get a copy of the list of listeners. abstract IEventSource getParentSource() Get the parent source. abstract void insertListener(int index, IEventListener listener) Register a listener. abstract void notifyListeners(IEvent e) Notify listeners that an event has occurred. abstract void removeListener(IEventListener listener) Unregister a listener. abstract void setParentSource(IEventSource parentSource) Set a parent source.