| package org.eclipse.swt.printing;
|
|
|
| /*
|
| * Copyright (c) 2000, 2002 IBM Corp. All rights reserved. |
| * This file is made available under the terms of the Common Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/cpl-v10.html
|
| */
|
|
|
| import org.eclipse.swt.*;
|
| import org.eclipse.swt.graphics.*;
|
| import org.eclipse.swt.widgets.*;
|
| import org.eclipse.swt.internal.gtk.*;
|
|
|
| /**
|
| * Instances of this class allow the user to select
|
| * a printer and various print-related parameters
|
| * prior to starting a print job.
|
| * <p>
|
| * IMPORTANT: This class is intended to be subclassed <em>only</em>
|
| * within the SWT implementation.
|
| * </p>
|
| */ |
| public class PrintDialog extends Dialog {
|
| int scope = PrinterData.ALL_PAGES;
|
| int startPage = -1, endPage = -1;
|
| boolean printToFile = false;
|
|
|
| /**
|
| * Constructs a new instance of this class given only its parent.
|
| *
|
| * @param parent a composite control which will be the parent of the new instance (cannot be null)
|
| *
|
| * @exception IllegalArgumentException <ul>
|
| * <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
|
| * </ul>
|
| * @exception SWTException <ul>
|
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>
|
| * <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li>
|
| * </ul>
|
| *
|
| * @see SWT
|
| * @see Widget#checkSubclass
|
| * @see Widget#getStyle
|
| */ |
| public PrintDialog (Shell parent) {
|
| this (parent, SWT.PRIMARY_MODAL);
|
| }
|
| /**
|
| * Constructs a new instance of this class given its parent
|
| * and a style value describing its behavior and appearance.
|
| * <p>
|
| * The style value is either one of the style constants defined in
|
| * class <code>SWT</code> which is applicable to instances of this
|
| * class, or must be built by <em>bitwise OR</em>'ing together
|
| * (that is, using the <code>int</code> "|" operator) two or more
|
| * of those <code>SWT</code> style constants. The class description
|
| * lists the style constants that are applicable to the class.
|
| * Style bits are also inherited from superclasses.
|
| * </p>
|
| *
|
| * @param parent a composite control which will be the parent of the new instance (cannot be null)
|
| * @param style the style of control to construct
|
| *
|
| * @exception IllegalArgumentException <ul>
|
| * <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
|
| * </ul>
|
| * @exception SWTException <ul>
|
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>
|
| * <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li>
|
| * </ul>
|
| *
|
| * @see SWT
|
| * @see Widget#checkSubclass
|
| * @see Widget#getStyle
|
| */ |
| public PrintDialog (Shell parent, int style) {
|
| super (parent, style);
|
| checkSubclass ();
|
| }
|
| /**
|
| * Makes the receiver visible and brings it to the front
|
| * of the display.
|
| *
|
| * @return a printer data object describing the desired print job parameters
|
| *
|
| * @exception SWTException <ul>
|
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
|
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
|
| * </ul>
|
| */ |
| public PrinterData open() {
|
| /* Return the first printer in the list */
|
| PrinterData[] printers = Printer.getPrinterList();
|
| if (printers.length > 0) return printers[0];
|
| return null;
|
| }
|
| /**
|
| * Returns the print job scope that the user selected
|
| * before pressing OK in the dialog. This will be one
|
| * of the following values:
|
| * <dl>
|
| * <dt><code>ALL_PAGES</code></dt>
|
| * <dd>Print all pages in the current document</dd>
|
| * <dt><code>PAGE_RANGE</code></dt>
|
| * <dd>Print the range of pages specified by startPage and endPage</dd>
|
| * <dt><code>SELECTION</code></dt>
|
| * <dd>Print the current selection</dd>
|
| * </dl>
|
| *
|
| * @return the scope setting that the user selected
|
| */ |
| public int getScope() {
|
| return scope;
|
| }
|
| /**
|
| * Sets the scope of the print job. The user will see this
|
| * setting when the dialog is opened. This can have one of
|
| * the following values:
|
| * <dl>
|
| * <dt><code>ALL_PAGES</code></dt>
|
| * <dd>Print all pages in the current document</dd>
|
| * <dt><code>PAGE_RANGE</code></dt>
|
| * <dd>Print the range of pages specified by startPage and endPage</dd>
|
| * <dt><code>SELECTION</code></dt>
|
| * <dd>Print the current selection</dd>
|
| * </dl>
|
| *
|
| * @param int the scope setting when the dialog is opened
|
| */ |
| public void setScope(int scope) {
|
| this.scope = scope;
|
| }
|
| /**
|
| * Returns the start page setting that the user selected
|
| * before pressing OK in the dialog.
|
| * <p>
|
| * Note that this value is only valid if the scope is <code>PAGE_RANGE</code>.
|
| * </p>
|
| *
|
| * @return the start page setting that the user selected
|
| */ |
| public int getStartPage() {
|
| return startPage;
|
| }
|
| /**
|
| * Sets the start page that the user will see when the dialog
|
| * is opened.
|
| *
|
| * @param int the startPage setting when the dialog is opened
|
| */ |
| public void setStartPage(int startPage) {
|
| this.startPage = startPage;
|
| }
|
| /**
|
| * Returns the end page setting that the user selected
|
| * before pressing OK in the dialog.
|
| * <p>
|
| * Note that this value is only valid if the scope is <code>PAGE_RANGE</code>.
|
| * </p>
|
| *
|
| * @return the end page setting that the user selected
|
| */ |
| public int getEndPage() {
|
| return endPage;
|
| }
|
| /**
|
| * Sets the end page that the user will see when the dialog
|
| * is opened.
|
| *
|
| * @param int the end page setting when the dialog is opened
|
| */ |
| public void setEndPage(int endPage) {
|
| this.endPage = endPage;
|
| }
|
| /**
|
| * Returns the 'Print to file' setting that the user selected
|
| * before pressing OK in the dialog.
|
| *
|
| * @return the 'Print to file' setting that the user selected
|
| */ |
| public boolean getPrintToFile() {
|
| return printToFile;
|
| }
|
| /**
|
| * Sets the 'Print to file' setting that the user will see
|
| * when the dialog is opened.
|
| *
|
| * @param boolean the 'Print to file' setting when the dialog is opened
|
| */ |
| public void setPrintToFile(boolean printToFile) {
|
| this.printToFile = printToFile;
|
| }
|
| protected void checkSubclass() {
|
| }
|
| }
|