Package loci.poi.poifs.property
Class DocumentProperty
java.lang.Object
loci.poi.poifs.property.Property
loci.poi.poifs.property.DocumentProperty
- All Implemented Interfaces:
POIFSViewable,Child
Trivial extension of Property for POIFSDocuments
- Author:
- Marc Johnson (mjohnson at apache dot org)
-
Field Summary
Fields inherited from class loci.poi.poifs.property.Property
_NO_INDEX, _NODE_BLACK, _NODE_RED -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDocumentProperty(int index, byte[] array, int offset) reader constructorDocumentProperty(String name, int size) Constructor -
Method Summary
Modifier and TypeMethodDescriptionget the POIFSDocumentbooleanprotected voidpreWrite()Perform whatever activities need to be performed prior to writingvoidsetDocument(POIFSDocument doc) set the POIFSDocumentbooleangive method more visibilityMethods inherited from class loci.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:
shouldUseSmallBlocksin classProperty- Returns:
- true if this property should use small blocks
-
isDirectory
public boolean isDirectory()- Specified by:
isDirectoryin classProperty- Returns:
- true if a directory type Property
-
preWrite
protected void preWrite()Perform whatever activities need to be performed prior to writing
-