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
public class DocumentProperty extends Property
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
Constructors Modifier Constructor Description protected
DocumentProperty(int index, byte[] array, int offset)
reader constructorDocumentProperty(String name, int size)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description POIFSDocument
getDocument()
get the POIFSDocumentboolean
isDirectory()
protected void
preWrite()
Perform whatever activities need to be performed prior to writingvoid
setDocument(POIFSDocument doc)
set the POIFSDocumentboolean
shouldUseSmallBlocks()
give method more visibility-
Methods 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 Detail
-
DocumentProperty
public DocumentProperty(String name, int size)
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 Detail
-
setDocument
public void setDocument(POIFSDocument doc)
set the POIFSDocument- Parameters:
doc
- the associated POIFSDocument
-
getDocument
public 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
-
-