org.eclipse.gmf.runtime.common.ui.printing
Interface IPrintHelper

public interface IPrintHelper

The IPrintHelper is an interface for the platform specfic print fragments. The print fragments may have these methods declared in the interface as native methods, then implement this interface as wrappers around the native methods.

Field Summary

static java.lang.String

PRINT_HELPER_CLASS_NAME The location where I expect the print helper to be implemented.

Method Summary

boolean	getDlgCollate() Returns if collate was selected
boolean	getDlgDiagramPrintRangeAll() Returns if diagram print range all was selected
boolean	getDlgDiagramPrintRangeCurrent() Returns if diagram print range current was selected
boolean	getDlgDiagramPrintRangeSelection() Returns if diagram print range selection was selected
int	getDlgNumberOfCopies() Returns the number of copies the user wants to print.
int	getDlgPagesFrom() Returns the pages from int value, check if (getDlgPrintRangesPages()) first.
int	getDlgPagesTo() Returns the pages from int value, check if (getDlgPrintRangesPages()) first.
boolean	getDlgPrintRangeAll() Returns if print range all was selected
boolean	getDlgPrintRangePages() Returns if print range pages was selected
int	getDlgScaleFitToM() If not > 0 then user has clicked percent scaling
int	getDlgScaleFitToN() If not > 0 then user has clicked percent scaling
int	getDlgScalePercent() If not > 0 then user has clicked fit to m x n scaling
boolean	isDlgDiagramSelected(int index) Returns true if the diagram at the index was selected
PrinterData	openPrintDlg(java.util.List diagramList) Opens the print dialog with the diagram list which could be null
void	setDlgOrientation(boolean bLandscape) Allows to set the orientation (portrait/landscape) in the print dialog.
void	setDlgPaperSize(int index, double width, double length) Allows to set the paper size in the print dialog.

Field Detail

PRINT_HELPER_CLASS_NAME

public static final java.lang.String PRINT_HELPER_CLASS_NAME

The location where I expect the print helper to be implemented. This should be in a fragment, e.g. org.eclipse.gmf.runtime.common.ui.printing.operatingsystem

See Also:

Constant Field Values

Method Detail

openPrintDlg

public PrinterData openPrintDlg(java.util.List diagramList)

Opens the print dialog with the diagram list which could be null

Parameters:

diagramList - the List of Diagram objects. diagramList can be null.

Returns:

PrinterData

getDlgScaleFitToM

public int getDlgScaleFitToM()

If not > 0 then user has clicked percent scaling

Returns:

scale to m int

getDlgScaleFitToN

public int getDlgScaleFitToN()

If not > 0 then user has clicked percent scaling

Returns:

scale to n int

getDlgScalePercent

public int getDlgScalePercent()

If not > 0 then user has clicked fit to m x n scaling

Returns:

scale percent int

isDlgDiagramSelected

public boolean isDlgDiagramSelected(int index)

Returns true if the diagram at the index was selected

Parameters:

index - the index of the diagrams you passed in

Returns:

true if selected, false if not selected

getDlgDiagramPrintRangeAll

public boolean getDlgDiagramPrintRangeAll()

Returns if diagram print range all was selected

Returns:

true if selected, false if not selected

getDlgDiagramPrintRangeCurrent

public boolean getDlgDiagramPrintRangeCurrent()

Returns if diagram print range current was selected

Returns:

true if selected, false if not selected

getDlgDiagramPrintRangeSelection

public boolean getDlgDiagramPrintRangeSelection()

Returns if diagram print range selection was selected

Returns:

true if selected, false if not selected

getDlgPrintRangeAll

public boolean getDlgPrintRangeAll()

Returns if print range all was selected

Returns:

true if selected, false if not selected

getDlgPrintRangePages

public boolean getDlgPrintRangePages()

Returns if print range pages was selected

Returns:

true if selected, false if not selected

getDlgCollate

public boolean getDlgCollate()

Returns if collate was selected

Returns:

true if selected, false if not selected

getDlgPagesFrom

public int getDlgPagesFrom()

Returns the pages from int value, check if (getDlgPrintRangesPages()) first.

Returns:

int of the pages from box

getDlgPagesTo

public int getDlgPagesTo()

Returns the pages from int value, check if (getDlgPrintRangesPages()) first.

Returns:

int of the pages to box

getDlgNumberOfCopies

public int getDlgNumberOfCopies()

Returns the number of copies the user wants to print. This is nCopies from PRINTDLG

Returns:

int with the number of copies

setDlgOrientation

public void setDlgOrientation(boolean bLandscape)

Allows to set the orientation (portrait/landscape) in the print dialog.

setDlgPaperSize

public void setDlgPaperSize(int index,
                            double width,
                            double length)

Allows to set the paper size in the print dialog.

Parameters:

index - index of type of paper size, @see org.eclipse.gmf.runtime.diagram.ui.internal.pagesetup.PageSetupPageType for the type of paper sizes available and their indices.

width - specifies the custom width of the paper. Leave as 0 if paper size index is user-defined.