Package org.apache.poi.hwpf.model.types
Class BKFAbstractType
java.lang.Object
org.apache.poi.hwpf.model.types.BKFAbstractType
- Direct Known Subclasses:
BookmarkFirstDescriptor
BooKmark First descriptor (BKF).
Class and fields descriptions are quoted from Microsoft Office Word 97-2007 Binary File Format (.doc) Specification NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/types/definitions.
- Author:
- Sergey Vladimirov; according to Microsoft Office Word 97-2007 Binary File Format (.doc) Specification
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidfillFields(byte[] data, int offset) shortGet the bkf_flags field for the BKF record.shortgetIbkl()Index to BKL entry in plcfbkl that describes the ending position of this bookmark in the CP stream.byteWhen bkf.fCol==1, this is the index to the first column of a table column bookmarkbyteWhen bkf.fCol==1, this is the index to limit column of a table column bookmarkstatic intgetSize()Size of recordbooleanisFCol()When 1, this bookmark marks a range of columns in a table specified by (bkf.itcFirst, bkf.itcLim)booleanisFPub()When 1, this indicates that this bookmark is marking the range of a Macintosh Publisher sectionvoidserialize(byte[] data, int offset) voidsetBkf_flags(short field_2_bkf_flags) Set the bkf_flags field for the BKF record.voidsetFCol(boolean value) Sets the fCol field value.voidsetFPub(boolean value) Sets the fPub field value.voidsetIbkl(short field_1_ibkl) Index to BKL entry in plcfbkl that describes the ending position of this bookmark in the CP stream.voidsetItcFirst(byte value) Sets the itcFirst field value.voidsetItcLim(byte value) Sets the itcLim field value.toString()
-
Field Details
-
field_1_ibkl
protected short field_1_ibkl -
field_2_bkf_flags
protected short field_2_bkf_flags
-
-
Constructor Details
-
BKFAbstractType
protected BKFAbstractType()
-
-
Method Details
-
fillFields
protected void fillFields(byte[] data, int offset) -
serialize
public void serialize(byte[] data, int offset) -
getSize
public static int getSize()Size of record -
toString
-
getIbkl
public short getIbkl()Index to BKL entry in plcfbkl that describes the ending position of this bookmark in the CP stream. -
setIbkl
public void setIbkl(short field_1_ibkl) Index to BKL entry in plcfbkl that describes the ending position of this bookmark in the CP stream. -
getBkf_flags
public short getBkf_flags()Get the bkf_flags field for the BKF record. -
setBkf_flags
public void setBkf_flags(short field_2_bkf_flags) Set the bkf_flags field for the BKF record. -
setItcFirst
public void setItcFirst(byte value) Sets the itcFirst field value. When bkf.fCol==1, this is the index to the first column of a table column bookmark -
getItcFirst
public byte getItcFirst()When bkf.fCol==1, this is the index to the first column of a table column bookmark- Returns:
- the itcFirst field value.
-
setFPub
public void setFPub(boolean value) Sets the fPub field value. When 1, this indicates that this bookmark is marking the range of a Macintosh Publisher section -
isFPub
public boolean isFPub()When 1, this indicates that this bookmark is marking the range of a Macintosh Publisher section- Returns:
- the fPub field value.
-
setItcLim
public void setItcLim(byte value) Sets the itcLim field value. When bkf.fCol==1, this is the index to limit column of a table column bookmark -
getItcLim
public byte getItcLim()When bkf.fCol==1, this is the index to limit column of a table column bookmark- Returns:
- the itcLim field value.
-
setFCol
public void setFCol(boolean value) Sets the fCol field value. When 1, this bookmark marks a range of columns in a table specified by (bkf.itcFirst, bkf.itcLim) -
isFCol
public boolean isFCol()When 1, this bookmark marks a range of columns in a table specified by (bkf.itcFirst, bkf.itcLim)- Returns:
- the fCol field value.
-