public interface

ITextItem

implements IItem
com.pnfsoftware.jeb.core.output.text.ITextItem
Known Indirect Subclasses

Class Overview

A text item is used to identify a particular sequence of characters within the string of an ITextDocumentPart. This interface is not directly useful. Derived interfaces IVisualTextItem and IActionableTextItem are used to associate class IDs (eg, for coloring) and item IDs (eg, to make items actionable) to text items.

Summary

Public Methods
abstract int getLength()
Get item length within a line.
abstract ILine getLine()
Get the line that contains this item.
abstract int getOffset()
Get the item offset within a line.
abstract int getOffsetEnd()
Get the item end offset (exclusive) within a line.
abstract String getText()
Get the text of the item.

Public Methods

public abstract int getLength ()

Get item length within a line.

Returns
  • the item character count

public abstract ILine getLine ()

Get the line that contains this item.

Returns
  • the line, or null if the item does not belong to any line

public abstract int getOffset ()

Get the item offset within a line.

Returns
  • the item offset

public abstract int getOffsetEnd ()

Get the item end offset (exclusive) within a line.

public abstract String getText ()

Get the text of the item.