org.apache.poi.hdf.model.hdftypes: abstract public class: FormattedDiskPage

org.apache.poi.hdf.model.hdftypes
abstract public class: FormattedDiskPage [javadoc | source]

java.lang.Object
   org.apache.poi.hdf.model.hdftypes.FormattedDiskPage

Direct Known Subclasses:
PAPFormattedDiskPage, CHPFormattedDiskPage

Represents an FKP data structure. This data structure is used to store the grpprls of the paragraph and character properties of the document. A grpprl is a list of sprms(decompression operations) to perform on a parent style. The style properties for paragraph and character runs are stored in fkps. There are PAP fkps for paragraph properties and CHP fkps for character run properties. The first part of the fkp for both CHP and PAP fkps consists of an array of 4 byte int offsets in the main stream for that Paragraph's or Character run's text. The ending offset is the next value in the array. For example, if an fkp has X number of Paragraph's stored in it then there are (x + 1) 4 byte ints in the beginning array. The number X is determined by the last byte in a 512 byte fkp. CHP and PAP fkps also store the compressed styles(grpprl) that correspond to the offsets on the front of the fkp. The offset of the grpprls is determined differently for CHP fkps and PAP fkps.

author: Ryan - Ackley

Field Summary
protected byte[]	_fkp
protected int	_crun

Constructor:
public FormattedDiskPage(byte[] fkp) { _crun = LittleEndian.getUnsignedByte(fkp, 511); _fkp = fkp; } Uses a 512-byte array to create a FKP

Constructor:

 public FormattedDiskPage(byte[] fkp) {
        _crun = LittleEndian.getUnsignedByte(fkp, 511);
        _fkp = fkp;
}

Uses a 512-byte array to create a FKP

Method from org.apache.poi.hdf.model.hdftypes.FormattedDiskPage Summary:
getEnd, getGrpprl, getStart, size

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.poi.hdf.model.hdftypes.FormattedDiskPage Detail:
public int getEnd(int index) { return LittleEndian.getInt(_fkp, ((index + 1) * 4)); } Used to get the end of the text corresponding to a grpprl in this fkp.
abstract public byte[] getGrpprl(int index)
public int getStart(int index) { return LittleEndian.getInt(_fkp, (index * 4)); } Used to get a text offset corresponding to a grpprl in this fkp.
public int size() { return _crun; } Used to get the total number of grrprl's stored int this FKP

Method from org.apache.poi.hdf.model.hdftypes.FormattedDiskPage Detail:

 public int getEnd(int index) {
        return LittleEndian.getInt(_fkp, ((index + 1) * 4));
}

Used to get the end of the text corresponding to a grpprl in this fkp.

 abstract public byte[] getGrpprl(int index)

 public int getStart(int index) {
        return LittleEndian.getInt(_fkp, (index * 4));
}

Used to get a text offset corresponding to a grpprl in this fkp.

 public int size() {
        return _crun;
}

Used to get the total number of grrprl's stored int this FKP