|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.swt.widgets.Dialog
org.eclipse.swt.printing.PrintDialog
public class PrintDialog
Instances of this class allow the user to select a printer and various print-related parameters prior to starting a print job.
IMPORTANT: This class is intended to be subclassed only within the SWT implementation.
Constructor Summary | |
---|---|
PrintDialog(Shell parent)
Constructs a new instance of this class given only its parent. |
|
PrintDialog(Shell parent,
int style)
Constructs a new instance of this class given its parent and a style value describing its behavior and appearance. |
Method Summary | |
---|---|
protected void |
checkSubclass()
Checks that this class can be subclassed. |
int |
getEndPage()
Returns the end page setting that the user selected before pressing OK in the dialog. |
PrinterData |
getPrinterData()
Returns the printer data that will be used when the dialog is opened. |
boolean |
getPrintToFile()
Returns the 'Print to file' setting that the user selected before pressing OK in the dialog. |
int |
getScope()
Returns the print job scope that the user selected before pressing OK in the dialog. |
int |
getStartPage()
Returns the start page setting that the user selected before pressing OK in the dialog. |
PrinterData |
open()
Makes the receiver visible and brings it to the front of the display. |
void |
setEndPage(int endPage)
Sets the end page that the user will see when the dialog is opened. |
void |
setPrinterData(PrinterData data)
Sets the printer data that will be used when the dialog is opened. |
void |
setPrintToFile(boolean printToFile)
Sets the 'Print to file' setting that the user will see when the dialog is opened. |
void |
setScope(int scope)
Sets the scope of the print job. |
void |
setStartPage(int startPage)
Sets the start page that the user will see when the dialog is opened. |
Methods inherited from class org.eclipse.swt.widgets.Dialog |
---|
getParent, getStyle, getText, setText |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PrintDialog(Shell parent)
parent
- a composite control which will be the parent of the new instance (cannot be null)
java.lang.IllegalArgumentException
- SWTException
- SWT
,
Widget.checkSubclass()
,
Widget.getStyle()
public PrintDialog(Shell parent, int style)
The style value is either one of the style constants defined in
class SWT
which is applicable to instances of this
class, or must be built by bitwise OR'ing together
(that is, using the int
"|" operator) two or more
of those SWT
style constants. The class description
lists the style constants that are applicable to the class.
Style bits are also inherited from superclasses.
parent
- a composite control which will be the parent of the new instance (cannot be null)style
- the style of control to construct
java.lang.IllegalArgumentException
- SWTException
- SWT
,
Widget.checkSubclass()
,
Widget.getStyle()
Method Detail |
---|
public void setPrinterData(PrinterData data)
data
- the data that will be used when the dialog is openedpublic PrinterData getPrinterData()
protected void checkSubclass()
Dialog
IMPORTANT: See the comment in Widget.checkSubclass()
.
checkSubclass
in class Dialog
Widget.checkSubclass()
public int getScope()
PrinterData.ALL_PAGES
PrinterData.PAGE_RANGE
PrinterData.SELECTION
public void setScope(int scope)
PrinterData.ALL_PAGES
PrinterData.PAGE_RANGE
PrinterData.SELECTION
scope
- the scope setting when the dialog is openedpublic int getStartPage()
This value can be from 1 to the maximum number of pages for the platform.
Note that it is only valid if the scope is PrinterData.PAGE_RANGE
.
public void setStartPage(int startPage)
This value can be from 1 to the maximum number of pages for the platform.
Note that it is only valid if the scope is PrinterData.PAGE_RANGE
.
startPage
- the startPage setting when the dialog is openedpublic int getEndPage()
This value can be from 1 to the maximum number of pages for the platform.
Note that it is only valid if the scope is PrinterData.PAGE_RANGE
.
public void setEndPage(int endPage)
This value can be from 1 to the maximum number of pages for the platform.
Note that it is only valid if the scope is PrinterData.PAGE_RANGE
.
endPage
- the end page setting when the dialog is openedpublic boolean getPrintToFile()
public void setPrintToFile(boolean printToFile)
printToFile
- the 'Print to file' setting when the dialog is openedpublic PrinterData open()
SWTException
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |