Top Description Fields Constructors Methods
org.apache.poi.poifs.property

public Class DocumentProperty

extends Property
Class Inheritance
Imports
org.apache.poi.poifs.filesystem.POIFSDocument
Trivial extension of Property for POIFSDocuments

Field Summary

Modifier and TypeField and Description
private POIFSDocument
_document

Inherited from org.apache.poi.poifs.property.Property:
_NO_INDEX_NODE_BLACK_NODE_RED

Constructor Summary

AccessConstructor and Description
public
DocumentProperty(final String
POIFSDocument name
name, final int
POIFSDocument size
size)

Constructor

protected
DocumentProperty(final int
index number
index, final byte[]
byte data
array, final int
offset into byte data
offset)

reader constructor

Method Summary

Modifier and TypeMethod and Description
public POIFSDocument

Returns:

the associated document
getDocument()

get the POIFSDocument

public boolean

Returns:

true if a directory type Property
isDirectory()

Implements abstract org.apache.poi.poifs.property.Property.isDirectory.

protected void
preWrite()

Implements abstract org.apache.poi.poifs.property.Property.preWrite.

Perform whatever activities need to be performed prior to writing

public void
setDocument(POIFSDocument
the associated POIFSDocument
doc)

set the POIFSDocument

public boolean

Returns:

true if this property should use small blocks
shouldUseSmallBlocks()

Overrides org.apache.poi.poifs.property.Property.shouldUseSmallBlocks.

give method more visibility

public void
updateSize(int size)

Update the size of the property's data

Inherited from org.apache.poi.poifs.property.Property:
getChildIndexgetIndexgetNamegetNextChildgetNextChildIndexgetPreviousChildgetPreviousChildIndexgetShortDescriptiongetSizegetStartBlockgetStorageClsidgetViewableArraygetViewableIteratorisSmallisValidIndexpreferArraysetChildPropertysetIndexsetNamesetNextChildsetNodeColorsetPreviousChildsetPropertyTypesetSizesetStartBlocksetStorageClsidwriteData

Field Detail

_documentback to summary
private POIFSDocument _document

Constructor Detail

DocumentPropertyback to summary
public DocumentProperty(final String name, final int size)

Constructor

Parameters
name:String

POIFSDocument name

size:int

POIFSDocument size

DocumentPropertyback to summary
protected DocumentProperty(final int index, final byte[] array, final int offset)

reader constructor

Parameters
index:int

index number

array:byte[]

byte data

offset:int

offset into byte data

Method Detail

getDocumentback to summary
public POIFSDocument getDocument()

get the POIFSDocument

Returns:POIFSDocument

the associated document

isDirectoryback to summary
public boolean isDirectory()

Implements abstract org.apache.poi.poifs.property.Property.isDirectory.

Returns:boolean

true if a directory type Property

preWriteback to summary
protected void preWrite()

Implements abstract org.apache.poi.poifs.property.Property.preWrite.

Perform whatever activities need to be performed prior to writing

setDocumentback to summary
public void setDocument(POIFSDocument doc)

set the POIFSDocument

Parameters
doc:POIFSDocument

the associated POIFSDocument

shouldUseSmallBlocksback to summary
public boolean shouldUseSmallBlocks()

Overrides org.apache.poi.poifs.property.Property.shouldUseSmallBlocks.

give method more visibility

Returns:boolean

true if this property should use small blocks

updateSizeback to summary
public void updateSize(int size)

Update the size of the property's data