java.lang.Object | |||
↳ | com.pnfsoftware.jeb.util.events.EventSource | ||
↳ | com.pnfsoftware.jeb.core.output.text.impl.AbstractTextDocument | ||
↳ | com.pnfsoftware.jeb.core.output.text.impl.AsciiDocument |
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.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
AsciiDocument(IInput input)
Create a text document.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
ICoordinates |
addressToCoordinates(String address)
Convert a unit-specific address to document-specific text coordinates.
| ||||||||||
String |
coordinatesToAddress(ICoordinates coordinates, AddressConversionPrecision precision)
Convert document-specific text coordinates to a unit-specific address.
| ||||||||||
long | getAnchorCount() | ||||||||||
ITextDocumentPart | getDocumentPart(long anchorId, int linesAfter, int linesBefore) |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Convert a unit-specific address to document-specific text coordinates. It is recommended to return canonical coordinates. The implementation might return approximate coordinates, ie the closest coordinates (in terms of distance) calculated as part of a best effort approach to minimize the return of null values.
Note: The addressing scheme is unit specific, and defined by the plugin developer. Addresses should not start with the reserved '@' prefix.
address | a textual address |
---|
Convert document-specific text coordinates to a unit-specific address.
Note: The addressing scheme is unit specific, and defined by the plugin developer. Addresses should not start with the reserved '@' prefix.
coordinates | the coordinates |
---|---|
precision | indicate the precision of the address (
COARSE will return a raw address, with a faster
result while FINE will return a more precise
address that can be a bit longer). If COARSE
can not be retrieved, it may return a null result, and the user will need to
recall this method with another precision. |