com.snowtide.pdf.layout

Interface Line

All Superinterfaces:

Region

public interface Line
extends Region

Instances of this class represent distinct runs of text at a specific position within a Block.

Since:

v1.4

Version:

©2004-2012 Snowtide Informatics Systems, Inc.

Method Summary

Methods

Modifier and Type	Method and Description
TextUnit	getTextUnit(int idx) Returns the TextUnit at the specified index.
int	getTextUnitCnt() Returns the number of TextUnits in this Line.
java.util.List	getTextUnits() Returns a List view of the TextUnits held by this Line.
void	pipe(OutputHandler tgt) Sends all text events associated with this Line to the given OutputHandler.
TextUnit	remove(int idx) Removes the TextUnit at the specified index, and returns it.

Methods inherited from interface com.snowtide.pdf.layout.Region

area, endxpos, endypos, height, width, xpos, ypos

Method Detail

getTextUnitCnt

int getTextUnitCnt()

Returns the number of TextUnits in this Line.

getTextUnit

TextUnit getTextUnit(int idx)

Returns the TextUnit at the specified index.

remove

TextUnit remove(int idx)

Removes the TextUnit at the specified index, and returns it.

getTextUnits

java.util.List getTextUnits()

Returns a List view of the TextUnits held by this Line. This List is guaranteed to provide efficient random access.

pipe

void pipe(OutputHandler tgt)
          throws java.io.IOException

Sends all text events associated with this Line to the given OutputHandler. Note that Line objects will not send any linebreaks to any OutputHandler passed to this function; only Block objects are able to calculate linebreak counts between lines.

Parameters:

tgt - - the destination for all contents of this Line

Throws:

java.io.IOException