|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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. |
void |
setScaleFactor(int scaleFactor)
Preserve the scale factor that the user enters in the preview or print dialogs. |
void |
setScaleToWidthHeight(int width,
int height)
Preserve the width and height scale factors |
Field Detail |
---|
static final java.lang.String PRINT_HELPER_CLASS_NAME
Method Detail |
---|
PrinterData openPrintDlg(java.util.List diagramList)
diagramList
- the List of Diagram objects. diagramList can
be null.
PrinterData
int getDlgScaleFitToM()
int getDlgScaleFitToN()
int getDlgScalePercent()
boolean isDlgDiagramSelected(int index)
index
- the index of the diagrams you passed in
boolean getDlgDiagramPrintRangeAll()
boolean getDlgDiagramPrintRangeCurrent()
boolean getDlgDiagramPrintRangeSelection()
boolean getDlgPrintRangeAll()
boolean getDlgPrintRangePages()
boolean getDlgCollate()
int getDlgPagesFrom()
int getDlgPagesTo()
int getDlgNumberOfCopies()
void setDlgOrientation(boolean bLandscape)
isLandscape
- true if orientation should be landscape, false otherwise.void setDlgPaperSize(int index, double width, double length)
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.height
- specifies the custom width of the paper. Leave as 0 if
paper size index is user-defined.void setScaleFactor(int scaleFactor)
scaleFactor
- a zoom factor integer value greater than 0.void setScaleToWidthHeight(int width, int height)
width
- scale to number of pages wideheight
- scale to number of pages high
|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.