org.eclipse.graphiti.ui.print
Interface IPrintConfiguration

public interface IPrintConfiguration

This interface defines a print configuration container, that is used for printing a diagram. The container itself is also capable of providing an image for the figure to print.

Since:

0.10

Field Summary

static int

OK The return code for configure() that indicates a successful configuration process.

Method Summary

void	cleanUp() Cleans up all stored data.
int	configure() Configures this container.
IFigure	getFigure() Returns the figure to be printed.
IPrintPreferences	getPreferences() The defined preferences for printing
Printer	getPrinter() Returns the Printer to be used.
Image	getScaledImage() Calculates an image with the applied scale factors.

Field Detail

OK

static final int OK

The return code for configure() that indicates a successful configuration process.

Method Detail

configure

int configure()

Configures this container. May e.g. mean that a popup is presented to the user, but also simply some default values are set.

Returns:

The return code of this operation. Anything else than 0 will be interpreted as a cancellation request.

getFigure

IFigure getFigure()

Returns the figure to be printed.

Returns:

The figure to be printed

getScaledImage

Image getScaledImage()

Calculates an image with the applied scale factors.

Returns:

A scaled image

getPreferences

IPrintPreferences getPreferences()

The defined preferences for printing

Returns:

A filled IPrintPreferences instance holding the current configuration

cleanUp

void cleanUp()

Cleans up all stored data.

getPrinter

Printer getPrinter()

Returns the Printer to be used.

Returns:

The printer.