|
Oracle Outside In Java API Reference 8.5.4 F11002-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.oracle.outsidein.Callback
public class Callback
Enables API users to handle certain callbacks from the Outside In technology. For example, a callback is executed during the creation of each new output file. Users who want to handle specific callbacks must extend this class and override the desired methods.
OptionsCache.setCallbackHandler(Callback)
Nested Class Summary | |
---|---|
static class |
Callback.AssociationValue Describes the relationship of a new file to the original destination file. |
class |
Callback.CreateNewFileResponse Holds response values returned by createNewFile(FileFormat, FileFormat, AssociationValue, String) . |
class |
Callback.CreateTempFileResponse Holds response values returned by createTempFile() . |
static class |
Callback.FileTypeValue Defines the type of file requested to be opened in openFile(Callback.FileTypeValue, String) |
class |
Callback.NewPageResponse Holds response values returned by prepareNewPage(long) . |
class |
Callback.OpenFileResponse Holds response values returned by openFile(FileTypeValue, String) . |
Constructor Summary | |
---|---|
Callback() |
Method Summary | |
---|---|
Callback.CreateNewFileResponse |
createNewFile(FileFormat parentOutputId, FileFormat outputId, Callback.AssociationValue association, java.lang.String path) This callback is made any time a new output file needs to be generated. |
Callback.CreateTempFileResponse |
createTempFile() This callback is made when a temporary file needs to be generated. |
void |
newFileInfo(FileFormat parentOutputId, FileFormat outputId, Callback.AssociationValue association, java.lang.String path, java.lang.String url) This callback is made just after each new file has been created. |
Callback.OpenFileResponse |
openFile(Callback.FileTypeValue fileType, java.lang.String fileName) This callback is made when a supplementary file needs to be opened. |
void |
pageInfoSlideNotes(long pageNumber, java.lang.String[] slideNotes) This callback is a notification describing any existing slide notes on a page. |
void |
pageInfoVisibility(long pageNumber, boolean isVisible) This callback is a notification describing the visibility of the page indicated. |
Callback.NewPageResponse |
prepareNewPage(long pageNumber) This callback is made when a new page of output is about to be created. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Callback()
Method Detail |
---|
public void newFileInfo(FileFormat parentOutputId, FileFormat outputId, Callback.AssociationValue association, java.lang.String path, java.lang.String url) throws java.io.IOException
createNewFile(FileFormat, FileFormat, AssociationValue, String)
to change the location of (or to set up redirected I/O for) the new file, this method will echo back the information set by the developer.parentOutputId
- the FileFormat
of the parent fileoutputId
- the FileFormat
of the new fileassociation
- the relationship of the new file with respect to the initial destination filepath
- the default path and name of the new file that was createdurl
- the url as specified in the Callback.CreateNewFileResponse
object returned from createNewFile(FileFormat, FileFormat, AssociationValue, String)
java.io.IOException
public Callback.CreateNewFileResponse createNewFile(FileFormat parentOutputId, FileFormat outputId, Callback.AssociationValue association, java.lang.String path) throws java.io.IOException
parentOutputId
- the FileFormat
of the parent fileoutputId
- the FileFormat
of the new file. When this callback occurs as a result of the copy
template macro, this is FileFormat.FI_UNKNOWN
association
- the relationship of the new file with respect to the initial destination filepath
- the default path and name of the new file, if applicable.java.io.IOException
public Callback.OpenFileResponse openFile(Callback.FileTypeValue fileType, java.lang.String fileName) throws java.io.IOException
fileType
- the type of file reference that is requested to be openedfileName
- the name of the required file referenced by the template or input filejava.io.IOException
public Callback.NewPageResponse prepareNewPage(long pageNumber)
pageNumber
- the zero-based page number of the new pagepublic void pageInfoSlideNotes(long pageNumber, java.lang.String[] slideNotes)
pageNumber
- the zero-based page number of the page containing slide notesslideNotes
- an array containing lines of text in the slide notepublic void pageInfoVisibility(long pageNumber, boolean isVisible)
pageNumber
- the zero-based page number of the pageisVisible
- whether the page is visible or hiddenpublic Callback.CreateTempFileResponse createTempFile() throws java.io.IOException
java.io.IOException
|
Oracle Outside In Java API Reference 8.5.4 F11002-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |