com.snowtide.pdf.layout

Interface Block

All Superinterfaces:

BlockParent, Bounded

All Known Subinterfaces:

Table

public interface Block
extends Bounded, BlockParent

Instances of this class represent groupings of text at a specific position on a Page.

Blocks can contain Lines and/or other Blocks (via the BlockParent interface). Existing implementations generally will not allow a Block to contain both Blocks and Lines.

Version:

©2004-2024 Snowtide

Method Summary

Modifier and Type	Method and Description
Block	crop(Region area) Returns a Block that contains only the content held by this Block that intersects the given "query" area.
Line	getLine(int idx) Returns the Line at the given index.
int	getLineCnt() Returns the number of Lines held by this Block.
java.util.List<? extends Line>	getLines() Returns a List view of the Lines held by this Block.
void	pipe(OutputHandler tgt) Sends all text events associated with this Block to the given OutputHandler.
Line	removeLine(int idx) Removes the Line at the given index from this Block, and returns it.

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

bounds

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

addChild, getChild, getChildCnt, removeAllChildren, removeChild, replaceChild, sortChildren

Method Detail

getLines

java.util.List<? extends Line> getLines()

Returns a List view of the Lines held by this Block. The returned List is guaranteed to offer efficient random access.

Since:

v1.4

getLine

Line getLine(int idx)

Returns the Line at the given index.

Since:

v1.4

getLineCnt

int getLineCnt()

Returns the number of Lines held by this Block.

Since:

v1.4

removeLine

Line removeLine(int idx)

Removes the Line at the given index from this Block, and returns it.

Since:

v1.4

pipe

void pipe(OutputHandler tgt)

Sends all text events associated with this Block to the given OutputHandler.

crop

Block crop(Region area)

Returns a Block that contains only the content held by this Block that intersects the given "query" area. If all of the content held by this instance is intersected by the query area, then this instance may be returned unchanged. If no content in this Block intersects the query area, then an empty Block will be returned.