Package org.apache.poi.poifs.property
Class DocumentProperty
java.lang.Object
org.apache.poi.poifs.property.Property
org.apache.poi.poifs.property.DocumentProperty
- All Implemented Interfaces:
POIFSViewable
,Child
Trivial extension of Property for POIFSDocuments
-
Field Summary
Fields inherited from class org.apache.poi.poifs.property.Property
_NO_INDEX, _NODE_BLACK, _NODE_RED
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
DocumentProperty
(int index, byte[] array, int offset) reader constructorDocumentProperty
(String name, int size) Constructor -
Method Summary
Modifier and TypeMethodDescriptionget the POIFSDocumentboolean
protected void
preWrite()
Perform whatever activities need to be performed prior to writingvoid
setDocument
(POIFSDocument doc) set the POIFSDocumentboolean
give method more visibilityvoid
updateSize
(int size) Update the size of the property's dataMethods inherited from class org.apache.poi.poifs.property.Property
getChildIndex, getIndex, getName, getNextChild, getPreviousChild, getShortDescription, getSize, getStartBlock, getStorageClsid, getViewableArray, getViewableIterator, isSmall, preferArray, setChildProperty, setIndex, setName, setNextChild, setNodeColor, setPreviousChild, setPropertyType, setSize, setStartBlock, setStorageClsid, writeData
-
Constructor Details
-
DocumentProperty
Constructor- Parameters:
name
- POIFSDocument namesize
- POIFSDocument size
-
DocumentProperty
protected DocumentProperty(int index, byte[] array, int offset) reader constructor- Parameters:
index
- index numberarray
- byte dataoffset
- offset into byte data
-
-
Method Details
-
setDocument
set the POIFSDocument- Parameters:
doc
- the associated POIFSDocument
-
getDocument
get the POIFSDocument- Returns:
- the associated document
-
shouldUseSmallBlocks
public boolean shouldUseSmallBlocks()give method more visibility- Overrides:
shouldUseSmallBlocks
in classProperty
- Returns:
- true if this property should use small blocks
-
isDirectory
public boolean isDirectory()- Specified by:
isDirectory
in classProperty
- Returns:
- true if a directory type Property
-
preWrite
protected void preWrite()Perform whatever activities need to be performed prior to writing -
updateSize
public void updateSize(int size) Update the size of the property's data
-