Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache.poi.poifs » dev » [javadoc | source]
org.apache.poi.poifs.dev
public interface: POIFSViewable [javadoc | source]

All Known Implementing Classes:
    DocumentNode, LocalProperty, DirectoryNode, POIFSDocument, POIFSFileSystem, LocalProperty, RootProperty, DirectoryProperty, Property, DocumentProperty

Interface for a drill-down viewable object. Such an object has content that may or may not be displayed, at the discretion of the viewer. The content is returned to the viewer as an array or as an Iterator, and the object provides a clue as to which technique the viewer should use to get its content. A POIFSViewable object is also expected to provide a short description of itself, that can be used by a viewer when the viewable object is collapsed.
Method from org.apache.poi.poifs.dev.POIFSViewable Summary:
getShortDescription,   getViewableArray,   getViewableIterator,   preferArray
Method from org.apache.poi.poifs.dev.POIFSViewable Detail:
 public String getShortDescription()
    Provides a short description of the object, to be used when a
POIFSViewable object has not provided its contents.
 public Object[] getViewableArray()
    Get an array of objects, some of which may implement
POIFSViewable
 public Iterator getViewableIterator()
    Get an Iterator of objects, some of which may implement
POIFSViewable
 public boolean preferArray()
    Give viewers a hint as to whether to call getViewableArray or
getViewableIterator