Top Description Fields Constructors Methods

org.apache.pdfbox.jbig2.segments

public Class RegionSegmentInformation

Class Inheritance

extends Object
implements SegmentData

java.lang.Object
org.apache.pdfbox.jbig2.segments.RegionSegmentInformation

All Implemented Interfaces

org.apache.pdfbox.jbig2.SegmentData

Imports

java.io.IOException, org.apache.pdfbox.jbig2.SegmentData, .SegmentHeader, org.apache.pdfbox.jbig2.err.IntegerMaxValueException, .InvalidHeaderValueException, org.apache.pdfbox.jbig2.io.SubInputStream, org.apache.pdfbox.jbig2.util.CombinationOperator

This class represents the "Region segment information" field, 7.4.1 (page 50).
Every region segment data starts with this part.

Field Summary

Modifier and Type	Field and Description
private int	bitmapHeight Region segment bitmap height, 7.4.1.2
private int	bitmapWidth Region segment bitmap width, 7.4.1.1
private CombinationOperator	combinationOperator Region segment flags, 7.4.1.5
private SubInputStream	subInputStream
private int	xLocation Region segment bitmap X location, 7.4.1.3
private int	yLocation Region segment bitmap Y location, 7.4.1.4

Constructor Summary

Access	Constructor and Description
public	RegionSegmentInformation(SubInputStream subInputStream)
public	RegionSegmentInformation()

Method Summary

Modifier and Type	Method and Description
public int	getBitmapHeight()
public int	getBitmapWidth()
public CombinationOperator	getCombinationOperator()
public int	getXLocation()
public int	getYLocation()
public void	init(SegmentHeader - The segments' header (to make referred-to segments available in data part). header, SubInputStream - Wrapped `ImageInputStream` into `SubInputStream`. sis) Implements org.apache.pdfbox.jbig2.SegmentData.init. Parse the stream and read information of header.
public void	parseHeader()
private void	readCombinationOperator()
public void	setBitmapHeight(final int bitmapHeight)
public void	setBitmapWidth(final int bitmapWidth)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

bitmapHeight	back to summary
private int bitmapHeight Region segment bitmap height, 7.4.1.2

bitmapWidth	back to summary
private int bitmapWidth Region segment bitmap width, 7.4.1.1

combinationOperator	back to summary
private CombinationOperator combinationOperator Region segment flags, 7.4.1.5

subInputStream	back to summary
private SubInputStream subInputStream

xLocation	back to summary
private int xLocation Region segment bitmap X location, 7.4.1.3

yLocation	back to summary
private int yLocation Region segment bitmap Y location, 7.4.1.4

Constructor Detail

RegionSegmentInformation	back to summary
public RegionSegmentInformation(SubInputStream subInputStream)

RegionSegmentInformation	back to summary
public RegionSegmentInformation()

Method Detail

getBitmapHeight	back to summary
public int getBitmapHeight()

getBitmapWidth	back to summary
public int getBitmapWidth()

getCombinationOperator	back to summary
public CombinationOperator getCombinationOperator()

getXLocation	back to summary
public int getXLocation()

getYLocation	back to summary
public int getYLocation()

init back to summary

public void init(SegmentHeader header, SubInputStream sis) throws InvalidHeaderValueException, IntegerMaxValueException, IOException

Implements org.apache.pdfbox.jbig2.SegmentData.init.

Doc from org.apache.pdfbox.jbig2.SegmentData.init.

Parse the stream and read information of header.

Parameters

header:SegmentHeader: - The segments' header (to make referred-to segments available in data part).
sis:SubInputStream: - Wrapped ImageInputStream into SubInputStream.

Exceptions

InvalidHeaderValueException:: if the segment header value is invalid
IntegerMaxValueException:: if the maximum value limit of an integer is exceeded
IOException:: if an underlying IO operation fails

parseHeader	back to summary
public void parseHeader() throws IOException

readCombinationOperator	back to summary
private void readCombinationOperator() throws IOException

setBitmapHeight	back to summary
public void setBitmapHeight(final int bitmapHeight)

setBitmapWidth	back to summary
public void setBitmapWidth(final int bitmapWidth)