java.lang.Object | |||
↳ | com.pnfsoftware.jeb.util.events.EventSource | ||
↳ | com.pnfsoftware.jeb.core.output.text.impl.AbstractTextDocument | ||
↳ | com.pnfsoftware.jeb.core.output.text.impl.StaticTextDocument |
A simple text document. Such text document objects do not listen to unit changes events; in fact,
they are unaware of the IUnit
family of classes. They are ideal to distribute static,
immutable contents. More complex text documents should implement ITextDocument
and/or
extend AbstractTextDocument
.
In this simple implementation, a line maps to one anchor. Therefore, the "line" part of a
coordinates becomes redundant within the default addressing scheme provided by
AbstractTextDocument
. The addressing scheme has been simplified to
"anchorId,columnOffset".
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
StaticTextDocument(List<ILine> lines) | |||||||||||
StaticTextDocument(String text) |
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) | ||||||||||
String | toString() |
[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. |