FileDocCategorySizeDatePackage
DocumentProperty.javaAPI DocApache Poi 3.0.13090Mon Jan 01 12:39:36 GMT 2007org.apache.poi.poifs.property

DocumentProperty

public class DocumentProperty extends Property
Trivial extension of Property for POIFSDocuments
author
Marc Johnson (mjohnson at apache dot org)

Fields Summary
private POIFSDocument
_document
Constructors Summary
public DocumentProperty(String name, int size)
Constructor

param
name POIFSDocument name
param
size POIFSDocument size

        super();
        _document = null;
        setName(name);
        setSize(size);
        setNodeColor(_NODE_BLACK);   // simplification
        setPropertyType(PropertyConstants.DOCUMENT_TYPE);
    
protected DocumentProperty(int index, byte[] array, int offset)
reader constructor

param
index index number
param
array byte data
param
offset offset into byte data

        super(index, array, offset);
        _document = null;
    
Methods Summary
public org.apache.poi.poifs.filesystem.POIFSDocumentgetDocument()
get the POIFSDocument

return
the associated document

        return _document;
    
public booleanisDirectory()

return
true if a directory type Property

        return false;
    
protected voidpreWrite()
Perform whatever activities need to be performed prior to writing


        // do nothing
    
public voidsetDocument(org.apache.poi.poifs.filesystem.POIFSDocument doc)
set the POIFSDocument

param
doc the associated POIFSDocument

        _document = doc;
    
public booleanshouldUseSmallBlocks()
give method more visibility

return
true if this property should use small blocks

        return super.shouldUseSmallBlocks();