|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.viewer.CMBDocumentEngineCallbacks
This class defines callback methods that allow document engines to retrieve additional resources related to a document. An instance of this class is given to a document engine when it is initialized.
CMBDocumentEngine
Constructor Summary | |
CMBDocumentEngineCallbacks()
|
Method Summary | |
abstract java.io.InputStream |
getAnnotation(java.lang.Object hDocument,
int annotationNumber)
Retrieves an additional annotation blob for documents that store each annotation in a separate blob. |
abstract java.io.InputStream |
getForm(java.lang.Object hDocument,
java.lang.String formName)
Retrieves a background image for a page. |
int |
getFormSize(java.lang.Object hDocument,
java.lang.String formName)
Retrieves the form size. |
abstract java.io.InputStream |
getPart(java.lang.Object hDocument,
int partNumber,
java.lang.StringBuffer outMimeType)
Retrieves an additional part of a multi-part document. |
int |
getPartSize(java.lang.Object hDocument,
int partNumber)
Retrieves the size of the part specified by the part number. |
abstract java.io.InputStream |
getResources(java.lang.Object hDocument)
Retrieves the resources for a document. |
abstract void |
trace(java.lang.String message)
Writes a trace message. |
abstract boolean |
traceEnabled()
Returns true if tracing is enabled. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public CMBDocumentEngineCallbacks()
Method Detail |
public abstract java.io.InputStream getForm(java.lang.Object hDocument, java.lang.String formName)
hDocument
- engine's handle to documentformName
- the name of the formpublic int getFormSize(java.lang.Object hDocument, java.lang.String formName)
hDocument
- engine's handle to documentformName
- the name of the formpublic abstract java.io.InputStream getPart(java.lang.Object hDocument, int partNumber, java.lang.StringBuffer outMimeType)
hDocument
- engine's handle to documentpartNumber
- the index of the part (zero is the first part)outMimeType
- out parameter in which the mime type of the part is returned.
can be null if caller is not interested in the mime type of the partpublic int getPartSize(java.lang.Object hDocument, int partNumber)
hDocument
- engine's handle to documentpartNumber
- the index of the part (zero is the first part)public abstract java.io.InputStream getAnnotation(java.lang.Object hDocument, int annotationNumber)
hDocument
- engine's handle to documentannotationNumber
- the index of the annotation (zero is the first annotation)public abstract java.io.InputStream getResources(java.lang.Object hDocument)
hDocument
- engine's handle to documentpublic abstract boolean traceEnabled()
public abstract void trace(java.lang.String message)
message
- the message to be logged in the trace
|
EIP JavaBeans | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |