public
interface
IUnitTextFragment
implements IUnitFragment| com.pnfsoftware.jeb.client.api.IUnitTextFragment |
Class Overview
A text fragment representing a textual document generated by a unit.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract ICoordinates |
getCaretCoordinates()
Retrieve the caret position.
| ||||||||||
| abstract IGenericDocument |
getDocument()
Retrieve the underlying source document used to render fragment, if there is one.
| ||||||||||
| abstract List<Object> |
getDocumentObjectsAtCaret()
Retrieve the lit of unit specific objects related to the current caret position or currently
active item in the fragment.
| ||||||||||
| abstract String |
getSelectedText()
Retrieve the selected text string.
| ||||||||||
| abstract void |
setCaretCoordinates(ICoordinates coord, boolean record)
Set the caret position.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From interface
com.pnfsoftware.jeb.client.api.IUnitFragment
| |||||||||||
Public Methods
public abstract IGenericDocument getDocument ()
Retrieve the underlying source document used to render fragment, if there is one.
Returns
- a document, or null
public abstract List<Object> getDocumentObjectsAtCaret ()
Retrieve the lit of unit specific objects related to the current caret position or currently active item in the fragment. The objects and their type are document-(and therefore, unit-) specific.
public abstract String getSelectedText ()
Retrieve the selected text string.
public abstract void setCaretCoordinates (ICoordinates coord, boolean record)
Set the caret position.