| org.apache.poi.poifs.dev.POIFSViewable
All known Subclasses: org.apache.poi.poifs.property.Property, org.apache.poi.poifs.filesystem.POIFSDocument, org.apache.poi.poifs.filesystem.DocumentNode, org.apache.poi.poifs.filesystem.POIFSFileSystem, org.apache.poi.poifs.filesystem.DirectoryNode,
POIFSViewable | public interface POIFSViewable (Code) | | 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.
author: Marc Johnson (mjohnson at apache dot org) |
getShortDescription | public String getShortDescription()(Code) | | Provides a short description of the object, to be used when a
POIFSViewable object has not provided its contents.
short description |
getViewableArray | public Object[] getViewableArray()(Code) | | Get an array of objects, some of which may implement
POIFSViewable
an array of Object; may not be null, but may be empty |
getViewableIterator | public Iterator getViewableIterator()(Code) | | Get an Iterator of objects, some of which may implement
POIFSViewable
an Iterator; may not be null, but may have an emptyback end store |
preferArray | public boolean preferArray()(Code) | | Give viewers a hint as to whether to call getViewableArray or
getViewableIterator
true if a viewer should call getViewableArray, false ifa viewer should call getViewableIterator |
|
|