Apache POI - Common 5.3.0 · org.apache.poi.poifs.dev.POIFSViewable

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 Summary

Modifier and Type	Method and Description
public String	Returns: short description getShortDescription() Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.
public Object[]	Returns: an array of Object; may not be null, but may be empty getViewableArray() Get an array of objects, some of which may implement POIFSViewable
public Iterator<Object>	Returns: an Iterator; may not be null, but may have an empty back end store getViewableIterator() Get an Iterator of objects, some of which may implement POIFSViewable
public boolean	Returns: true if a viewer should call getViewableArray, false if a viewer should call getViewableIterator preferArray() Give viewers a hint as to whether to call getViewableArray or getViewableIterator

Method Detail

getShortDescription	back to summary
public String getShortDescription() Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents. Returns:String short description

getShortDescription

back to summary

public String getShortDescription()

Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.

Returns:String: short description

getViewableArray	back to summary
public Object[] getViewableArray() Get an array of objects, some of which may implement POIFSViewable Returns:Object[] an array of Object; may not be null, but may be empty

getViewableArray

back to summary

public Object[] getViewableArray()

Get an array of objects, some of which may implement POIFSViewable

Returns:Object[]: an array of Object; may not be null, but may be empty

getViewableIterator	back to summary
public Iterator<Object> getViewableIterator() Get an Iterator of objects, some of which may implement POIFSViewable Returns:Iterator<Object> an Iterator; may not be null, but may have an empty back end store

getViewableIterator

back to summary

public Iterator<Object> getViewableIterator()

Get an Iterator of objects, some of which may implement POIFSViewable

Returns:Iterator<Object>: an Iterator; may not be null, but may have an empty back end store

preferArray	back to summary
public boolean preferArray() Give viewers a hint as to whether to call getViewableArray or getViewableIterator Returns:boolean true if a viewer should call getViewableArray, false if a viewer should call getViewableIterator

preferArray

back to summary

public boolean preferArray()

Give viewers a hint as to whether to call getViewableArray or getViewableIterator

Returns:boolean: true if a viewer should call getViewableArray, false if a viewer should call getViewableIterator

public Interface POIFSViewable

Method Summary

Method Detail