oracle.ide.print
Class PrintManager

java.lang.Object
  oracle.ide.print.PrintManager

All Implemented Interfaces:

Addin, Controller

public abstract class PrintManager
extends java.lang.Object
implements Controller, Addin

Field Summary

Fields inherited from interface oracle.ide.controller.Controller

UPDATE_FROM_ACTION_PERFORMED, UPDATE_FROM_ACTIVE_VIEW_CHANGED, UPDATE_FROM_UNDO, UPDATE_FROM_USER_EXTENSION, UPDATE_FROM_VIEW_SELECTION_CHANGED

Constructor Summary

PrintManager()

Method Summary

abstract java.awt.print.Pageable	createPageableForObject(Context context, java.lang.Object object) Creates a Pageable for the given object.
abstract java.awt.print.Pageable	createPageableForObject(java.lang.Object object) Deprecated. use createPageableForObject(Context, Object)
abstract java.awt.print.PageFormat	getPageFormat() This method gets the PageFormat that will be used for printing output.
static PrintManager	getPrintManager() Returns the PrintManager instance that is active in the IDE.
abstract boolean	registerDocumentPrintFactory(java.lang.Class viewClass, java.lang.Class documentPrintFactoryClass) Registers the DocumentPrintFactory for a given View class.
abstract void	setPageable(java.awt.print.Pageable pageable) setPageable sets the Pageable object to be printed in the PrintManager
abstract void	setPageables(java.awt.print.Pageable[] pageables) setPageables sets the array of Pageable object to be printed in the PrintManager
abstract void	setPageFormat(java.awt.print.PageFormat parPageFormat) Set the PageFormat that should be used for printing output.
abstract void	setPrintable(java.awt.print.Printable printable, java.awt.print.PageFormat pageFormat) setPrintable sets the Printable object to be printed in the PrintManager
static void	setPrintManager(PrintManager printManager) Publishes the specified PrintManager as the active instance in the IDE.
abstract void	unregisterDocumentPrintFactory(java.lang.Class viewClass) Removes the entry from the DocumentPrintFactory registry for the given view class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.ide.controller.Controller

handleEvent, update

Methods inherited from interface oracle.ide.Addin

initialize

Constructor Detail

PrintManager

public PrintManager()

Method Detail

getPrintManager

public static PrintManager getPrintManager()

Returns the PrintManager instance that is active in the IDE.

setPrintManager

public static void setPrintManager(PrintManager printManager)

Publishes the specified PrintManager as the active instance in the IDE.

registerDocumentPrintFactory

public abstract boolean registerDocumentPrintFactory(java.lang.Class viewClass,
                                                     java.lang.Class documentPrintFactoryClass)

Registers the DocumentPrintFactory for a given View class. The DocumentPrintFactory is used to provide printing support for the View. This is the preferred method to use to register a DocumentPrintFactory since it provides compile-time checking.

Parameters:

viewClass - The view class to add to the registry.

documentPrintFactoryClass - The class that acts as the DocumentPrintFactory for the view for the given view.

unregisterDocumentPrintFactory

public abstract void unregisterDocumentPrintFactory(java.lang.Class viewClass)

Removes the entry from the DocumentPrintFactory registry for the given view class. This is the preferred method to use to remove a DocumentPrintFactory from the registry since it provides compile-time checking.

Parameters:

viewClassString - The fully-qualified name of the view class to remove from the registry.

createPageableForObject

public abstract java.awt.print.Pageable createPageableForObject(java.lang.Object object)

Deprecated. use createPageableForObject(Context, Object)

Creates a Pageable for the given object. This method searches the PageableFactory registry for the first entry where the object can be assigned to the pageableSourceClass in the registry. It then uses the PageableFactory registered for that entry to create a Pageable to be used for printing.

Parameters:

object - The object to create a Pageable for.

createPageableForObject

public abstract java.awt.print.Pageable createPageableForObject(Context context,
                                                                java.lang.Object object)

Creates a Pageable for the given object. This method searches the PageableFactory registry for the first entry where the object can be assigned to the pageableSourceClass in the registry. It then uses the PageableFactory registered for that entry to create a Pageable to be used for printing.

Parameters:

context - The IDE context

object - The object to create a Pageable for.

setPrintable

public abstract void setPrintable(java.awt.print.Printable printable,
                                  java.awt.print.PageFormat pageFormat)

setPrintable sets the Printable object to be printed in the PrintManager

Parameters:

printable - the object to be printed

pageFormat - the PageFormat to use when printing the object

setPageable

public abstract void setPageable(java.awt.print.Pageable pageable)

setPageable sets the Pageable object to be printed in the PrintManager

Parameters:

pageable - the object to be printed

setPageables

public abstract void setPageables(java.awt.print.Pageable[] pageables)

setPageables sets the array of Pageable object to be printed in the PrintManager

Parameters:

pageables - the array of objects to be printed

getPageFormat

public abstract java.awt.print.PageFormat getPageFormat()

This method gets the PageFormat that will be used for printing output.

Returns:

PageFormat

setPageFormat

public abstract void setPageFormat(java.awt.print.PageFormat parPageFormat)

Set the PageFormat that should be used for printing output.

Parameters:

parPageFormat - a value of type PageFormat