Класс PrinterJob

public abstract class PrinterJob
extends Object

Конструкторы

PrinterJob

public PrinterJob()

Объект PrinterJob должен быть создан с помощью статического метода getPrinterJob.

Методы

getPrinterJob

public static PrinterJob getPrinterJob()

Создаёт и возвращает PrinterJob, первоначально связанный с принтером по умолчанию. Если на системе нет принтеров, метод всё равно вернёт PrinterJob, но getPrintService() вернёт null, и вызов print с этим PrinterJob может вызвать исключение. Приложениям, которым необходимо определить, есть ли подходящие принтеры перед созданием PrinterJob, следует убедиться, что массив, возвращаемый методом lookupPrintServices, не пуст.

Возвращает:

новый PrinterJob.

Исключения:

SecurityException - если существует менеджер безопасности, и его метод SecurityManager.checkPrintJobAccess() запрещает этому потоку создавать запрос на печать.

lookupPrintServices

public static PrintService[] lookupPrintServices()

Удобный метод для поиска 2D-служб печати. Службы, возвращаемые этим методом, могут быть установлены на PrinterJob которые поддерживают службы печати. Вызов этого метода эквивалентен вызову PrintServiceLookup.lookupPrintServices() и указанию Pageable DocFlavor.

Возвращает:

возможно пустой массив 2D-служб печати.

С:

1.4

lookupStreamPrintServices

public static StreamPrintServiceFactory[] lookupStreamPrintServices(String mimeType)

Удобный метод для поиска фабрик для потоковых служб печати, которые могут отображать 2D-графику. Пример использования:

FileOutputStream outstream;
 StreamPrintService psPrinter;
 String psMimeType = "application/postscript";
 PrinterJob pj = PrinterJob.getPrinterJob();

 StreamPrintServiceFactory[] factories =
     PrinterJob.lookupStreamPrintServices(psMimeType);
 if (factories.length > 0) {
     try {
         outstream = new File("out.ps");
         psPrinter =  factories[0].getPrintService(outstream);
         // psPrinter can now be set as the service on a PrinterJob
         pj.setPrintService(psPrinter)
     } catch (Exception e) {
         e.printStackTrace();
     }
 }

Службы, возвращаемые этим методом, могут быть установлены на экземпляры PrinterJob которые поддерживают службы печати. Вызов этого метода эквивалентен вызову StreamPrintServiceFactory.lookupStreamPrintServiceFactories() и указанию Pageable DocFlavor.

Параметры:

mimeType - требуемый формат вывода или null, если любой формат подходит.

Возвращает:

возможно пустой массив 2D-фабрик потоковых служб печати.

С:

1.4

getPrintService

public PrintService getPrintService()

Возвращает службу (принтер) для этой работы с принтером. Реализации этого класса, которые не поддерживают службы печати, могут вернуть null. null также будет возвращён, если принтеры недоступны.

Возвращает:

службу для этой работы с принтером.

С:

1.4

См. также:

setPrintService(PrintService), getPrinterJob()

setPrintService

public void setPrintService(PrintService service)
                     throws PrinterException

Связывает эту работу с принтером с новой PrintService. Этот метод переопределяется подклассами, которые поддерживают указание Print Service. Выбрасывает PrinterException, если указанная служба не может поддерживать интерфейсы Pageable и Printable, необходимые для поддержки 2D-печати.

Параметры:

service - служба печати, поддерживающая 2D-печать

Исключения:

PrinterException - если указанная служба не поддерживает 2D-печать, или этот класс PrinterJob не поддерживает установку 2D-службы печати, или указанная служба по другим причинам не является действительной службой печати.

С:

1.4

См. также:

getPrintService()

setPrintable

public abstract void setPrintable(Printable painter)

Вызывает painter для отрисовки страниц. Страницы документа, подлежащего печати этой PrinterJob, отрисовываются объектом Printable, painter. PageFormat для каждой страницы — это формат страницы по умолчанию.

Параметры:

painter - Printable для отрисовки каждой страницы документа.

setPrintable

public abstract void setPrintable(Printable painter,
                                  PageFormat format)

Вызывает painter для отрисовки страниц в заданном format. Страницы документа, подлежащего печати этой PrinterJob, отрисовываются объектом Printable, painter. Формат PageFormat каждой страницы — format.

Параметры:

painter - Printable для отрисовки каждой страницы документа

format - размер и ориентация каждой страницы для печати

setPageable

public abstract void setPageable(Pageable document)
                          throws NullPointerException

Запрашивает у document количество страниц и PageFormat и Printable для каждой страницы, хранящихся в экземпляре Pageable, document.

Параметры:

document - страницы для печати. Не может быть null.

Исключения:

NullPointerException - переданный Pageable был null.

См. также:

PageFormat, Printable

printDialog

public abstract boolean printDialog()
                             throws HeadlessException

Возвращает:

true если пользователь не отменяет диалог; false в противном случае.

Исключения:

HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true.

См. также:

GraphicsEnvironment.isHeadless()

printDialog

public boolean printDialog(PrintRequestAttributeSet attributes)
                    throws HeadlessException

Параметры:

attributes - на входе атрибуты, предоставленные приложением, на выходе содержимое обновляется для отражения выбора пользователя. Этот параметр не может быть null.

Возвращает:

true если пользователь не отменяет диалоговое окно; false в противном случае.

Исключения:

HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true.

NullPointerException - если параметр attributes равен null.

С:

1.4

См. также:

GraphicsEnvironment.isHeadless()

pageDialog

public abstract PageFormat pageDialog(PageFormat page)
                               throws HeadlessException

Отображает диалоговое окно, позволяющее изменить экземпляр PageFormat. Аргумент page используется для инициализации элементов управления в диалоговом окне настройки страницы. Если пользователь отменяет диалог, метод возвращает исходный объект page без изменений. Если пользователь подтверждает диалог, метод возвращает новый объект PageFormat с внесёнными изменениями. В любом случае, исходный объект page не изменяется.

Параметры:

page - стандартный PageFormat, представленный пользователю для изменения

Возвращает:

исходный объект page при отмене диалогового окна; новый объект PageFormat содержащий указанный пользователем формат при подтверждении диалогового окна.

Исключения:

HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true.

С:

1.2

См. также:

GraphicsEnvironment.isHeadless()

pageDialog

public PageFormat pageDialog(PrintRequestAttributeSet attributes)
                      throws HeadlessException

Параметры:

attributes - при вводе это атрибуты, предоставляемые приложением, при выводе содержимое обновляется, чтобы отразить выбор пользователя. Этот параметр не может быть null.

Возвращает:

формат страницы, если пользователь не отменяет диалог; null в противном случае.

Выбрасывает:

HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true.

NullPointerException - если параметр attributes равен null.

С:

1.4

См. также:

GraphicsEnvironment.isHeadless()

defaultPage

public abstract PageFormat defaultPage(PageFormat page)

Клонирует аргумент PageFormat и изменяет клон, чтобы описать размер и ориентацию страницы по умолчанию.

Параметры:

page - PageFormat для клонирования и изменения

Возвращает:

клон page, изменённый для описания размера и ориентации страницы по умолчанию.

defaultPage

public PageFormat defaultPage()

Создаёт новый экземпляр PageFormat и устанавливает его размер и ориентацию по умолчанию.

Возвращает:

экземпляр PageFormat с размером и ориентацией по умолчанию.

getPageFormat

public PageFormat getPageFormat(PrintRequestAttributeSet attributes)

Параметры:

attributes - набор атрибутов печати, например, полученных путём вызова printDialog. Если attributes равен null, возвращается PageFormat по умолчанию.

Возвращает:

PageFormat со значениями, соответствующими значениям текущего сервиса и указанным атрибутам.

С:

1.6

validatePage

public abstract PageFormat validatePage(PageFormat page)

Возвращает клон page с настроенными значениями, совместимыми с текущим принтером этого PrinterJob. Например, возвращаемый PageFormat может иметь область изображения, скорректированную для размещения внутри физической области бумаги, используемой текущим принтером.

Параметры:

page - PageFormat для клонирования, настройки которого изменены для соответствия текущему принтеру

Возвращает:

PageFormat — клон page, настройки которого изменены для соответствия этому PrinterJob.

print

public abstract void print()
                    throws PrinterException

Печатает набор страниц.

Выбрасывает:

PrinterException — произошла ошибка в системе печати, из-за которой задание было прервано.

См. также:

Book, Pageable, Printable

print

public void print(PrintRequestAttributeSet attributes)
           throws PrinterException

Параметры:

attributes - набор атрибутов для задачи

Выбрасывает:

PrinterException — произошла ошибка в системе печати, из-за которой задание было прервано.

С:

1.4

См. также:

Book, Pageable, Printable

setCopies

public abstract void setCopies(int copies)

Устанавливает количество копий для печати.

Параметры:

copies - количество копий для печати

См. также:

getCopies()

getCopies

public abstract int getCopies()

Получает количество копий для печати.

Возвращает:

количество копий для печати.

См. также:

setCopies(int)

getUserName

public abstract String getUserName()

Получает имя пользователя, выполняющего печать.

Возвращает:

имя пользователя, выполняющего печать

setJobName

public abstract void setJobName(String jobName)

Устанавливает имя документа для печати. Имя документа не может быть null.

Параметры:

jobName - имя документа для печати

См. также:

getJobName()

getJobName

public abstract String getJobName()

Получает имя документа для печати.

Возвращает:

имя документа для печати.

См. также:

setJobName(java.lang.String)

cancel

public abstract void cancel()

Отменяет задание печати, которое выполняется. Если print был вызван, но не возвратил значение, этот метод сигнализирует о том, что задание должно быть отменено при следующей возможности. Если задание печати не выполняется, этот вызов ничего не делает.

isCancelled

public abstract boolean isCancelled()

Возвращает true если задание печати выполняется, но будет отменено при следующей возможности; в противном случае возвращает false.

Возвращает:

true если задание, которое выполняется, будет отменено; false в противном случае.