java.awt.print
클래스 PrinterJob

java.lang.Object 
  java.awt.print.PrinterJob

public abstract class PrinterJob
extends Object 

PrinterJob 클래스는 인쇄를 제어하는 주요한 클래스입니다. 어플리케이션은 이 클래스의 메서드를 호출해, 작업을 설정해, 필요에 따라서 인쇄의 다이얼로그를 호출해, 그 후 작업의 페이지를 인쇄합니다.

생성자 개요

PrinterJob ()
PrinterJob 객체의 작성에는 static 메서드의 getPrinterJob를 사용할 필요가 있습니다.

메서드 개요

abstract void	cancel () 실행중의 인쇄 작업을 취소합니다.
PageFormat	defaultPage () 새로운 PageFormat 인스턴스를 생성해, 디폴트의 사이즈와 인쇄 방향으로 설정합니다.
abstract PageFormat	defaultPage (PageFormat page) PageFormat인수를 복제해, 그 복제를 변경해 디폴트의 페이지 사이즈와 인쇄 방향을 기술합니다.
abstract int	getCopies () 인쇄하는 부수를 리턴합니다.
abstract String	getJobName () 인쇄하는 문서의 이름을 리턴합니다.
static PrinterJob	getPrinterJob () 초기 상태로 디폴트 프린터에 관련된 PrinterJob를 작성해 리턴합니다.
PrintService	getPrintService () 이 인쇄 작업의 서비스 (프린터)를 리턴합니다.
abstract String	getUserName () 인쇄를 실시하는 사용자 의 이름을 리턴합니다.
abstract boolean	isCancelled () 인쇄 작업이 실행중이며, 다음의 기회에 삭제될 예정의 경우는 true, 그렇지 않은 경우는 false를 리턴합니다.
static PrintService []	lookupPrintServices () 2D 인쇄 서비스를 검색하는 간이 메서드입니다.
static StreamPrintServiceFactory []	lookupStreamPrintServices (String mimeType) 2D 그래픽의 렌더링가 가능한 스트림 인쇄 서비스의 팩토리를 검출하는 간이 메서드입니다.
abstract PageFormat	pageDialog (PageFormat page) PageFormat 인스턴스를 변경하기 위한 다이얼로그를 표시합니다.
PageFormat	pageDialog (PrintRequestAttributeSet attributes) 공통 플랫폼의 페이지 설정 다이얼로그를 표시하는 간이 메서드입니다.
abstract void	print () 페이지세트를 인쇄합니다.
void	print (PrintRequestAttributeSet attributes) 속성 세트의 설정을 사용해 페이지세트를 인쇄합니다.
abstract boolean	printDialog () 사용자에 대해서 인쇄 작업의 프로퍼티 변경 다이얼로그를 표시합니다.
boolean	printDialog (PrintRequestAttributeSet attributes) 공통 플랫폼의 모든 서비스에 대한 인쇄 다이얼로그를 표시하는 간이 메서드입니다.
abstract void	setCopies (int copies) 인쇄하는 부수를 설정합니다.
abstract void	setJobName (String jobName) 인쇄하는 문서의 이름을 설정합니다.
abstract void	setPageable (Pageable document) document에 대해서 페이지수나, Pageable 인스턴스 (document)에 보관 유지되고 있는 각 페이지의 PageFormat 및 Printable을 문의합니다.
abstract void	setPrintable (Printable painter) 페이지를 렌더링 하기 위해서 painter를 호출합니다.
abstract void	setPrintable (Printable painter, PageFormat format) 지정된 format로 페이지를 렌더링 하기 위해서 painter를 호출합니다.
void	setPrintService (PrintService service) 이 PrinterJob를 새로운 PrintService에 관련짓습니다.
abstract PageFormat	validatePage (PageFormat page) 이 PrinterJob 현재의 프린터와 호환성이 있도록 조정된 설정을 가지는 page 복제를 리턴합니다.

클래스 java.lang. Object 로부터 상속된 메서드

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

생성자 상세

PrinterJob

public PrinterJob()

PrinterJob 객체의 작성에는 static 메서드의 getPrinterJob를 사용할 필요가 있습니다.

메서드의 상세

getPrinterJob

public static PrinterJob  getPrinterJob()

초기 상태로 디폴트 프린터에 관련된 PrinterJob를 작성해 리턴합니다. 시스템으로 프린터를 사용할 수 없는 경우에서도, PrinterJob가 이 메서드로부터 리턴됩니다 . 다만, getPrintService()는 null을 돌려주고, 이 PrinterJob로 print를 호출하면, 예외가 생성되는 경우가 있습니다. PrinterJob를 작성하기 전에 적절한 프린터가 있을지 어떨지를 판별할 필요가 있는 어플리케이션은, lookupPrintServices 로부터 리턴된 배열이 비어있지 않은 것을 확인할 필요가 있습니다.

반환값:

새로운 PrinterJob

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";

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

이 메서드로부터 리턴된 서비스는 인쇄 서비스를 지원하는 PrinterJob에 인스톨 할 수 있습니다. 이 메서드의 호출은 StreamPrintServiceFactory.lookupStreamPrintServiceFactories() 호출 및 Pageable DocFlavor 지정과 동등합니다.

파라미터:

mimeType - 요구된 출력 형식, 또는 null (임의의 형식을 미)

반환값:

출하시의 2D 인쇄 서비스 스트림이 비어있는 가능성이 있는 배열

도입된 버전 :

1.4

getPrintService

public PrintService  getPrintService()

이 인쇄 작업의 서비스 (프린터)를 리턴합니다. 인쇄 서비스를 지원하지 않는 이 클래스의 구현은 null을 리턴합니다.

반환값:

이 인쇄 작업의 서비스

도입된 버전 :

1.4

관련 항목:

setPrintService(PrintService)

setPrintService

public void setPrintService(PrintService  service)
                     throws PrinterException 

이 PrinterJob를 새로운 PrintService에 관련짓습니다. 이 메서드는 Print Service 지정을 지원하는 서브 클래스에 오버라이드(override) 됩니다. 지정된 서비스가 2D 인쇄의 지원에 필요한 Pageable 및 Printable인터페이스를 지원할 수 없는 경우는PrinterException을 Throw 합니다.

파라미터:

service - 2D 인쇄를 지원하는 인쇄 서비스

예외:

PrinterException - 지정된 서비스가 2D 인쇄를 지원하지 않는 경우, 또는 이 PrinterJob 클래스가 2D 인쇄 서비스의 설정을 지원하지 않는 경우, 이 양자 이외의 경우로 지정된 서비스가 유효한 인쇄 서비스가 아닌 경우

도입된 버전 :

1.4

관련 항목:

getPrintService()

setPrintable

public abstract void setPrintable(Printable  painter)

페이지를 렌더링 하기 위해서 painter를 호출합니다. 이 PrinterJob에 의해 인쇄되는 문서내의 페이지는 painter로 지정된 Printable 객체에 의해 렌더링 됩니다. 각 페이지 PageFormat 는 디폴트의 페이지 서식이 됩니다.

파라미터:

painter - 문서의 각 페이지를 렌더링 하는 Printable

setPrintable

public abstract void setPrintable(Printable  painter,
                                  PageFormat  format)

지정된 format로 페이지를 렌더링 하기 위해서 painter를 호출합니다. 이 PrinterJob에 의해 인쇄되는 문서내의 페이지는 painter로 지정된 Printable 객체에 의해 렌더링 됩니다. 각 페이지의 PageFormat는 format로 지정된 페이지 서식이 됩니다.

파라미터:

painter - 문서의 각 페이지를 렌더링 하기 위해서 호출하는 Printable

format - 인쇄되는 각 페이지의 사이즈와 인쇄 방향

setPageable

public abstract void setPageable(Pageable  document)
                          throws NullPointerException 

document에 대해서 페이지수나, Pageable 인스턴스 (document)에 보관 유지되고 있는 각 페이지의 PageFormat 및 Printable을 문의합니다.

파라미터:

document - 인쇄되는 페이지. null을 건네줄 수 없다

예외:

NullPointerException - 건네받은 Pageable가 null인 경우

관련 항목:

PageFormat, Printable

printDialog

public abstract boolean printDialog()
                             throws HeadlessException 

사용자에 대해서 인쇄 작업의 프로퍼티 변경 다이얼로그를 표시합니다. 이 메서드는 네이티브인 인쇄 서비스가 선택되고 있는 경우는 네이티브 다이얼로그를 표시해, 사용자 의 프린터의 선택은 이러한 네이티브인 인쇄 서비스에 제한됩니다. 공통 플랫폼의 네이티브 인쇄 서비스를 포함한 모든 서비스에 대한 인쇄 다이얼로그를 표시하려면, 대신에 printDialog(PrintRequestAttributeSet)를 사용합니다.

PrintService 인쇄 다이얼로그를 사용할 수 있는 PrinterJob 구현에의해 이 PrinterJob에 대한 PrintService가 갱신되고 사용자가 선택하는 서비스가 반영됩니다.

반환값:

사용자가 다이얼로그를 취소하지 않는 경우는 true, 그렇지 않은 경우는 false

예외:

HeadlessException - GraphicsEnvironment.isHeadless()가 true를 돌려주는 경우

관련 항목:

GraphicsEnvironment.isHeadless()

printDialog

public boolean printDialog(PrintRequestAttributeSet  attributes)
                    throws HeadlessException 

공통 플랫폼의 모든 서비스에 대한 인쇄 다이얼로그를 표시하는 간이 메서드입니다. Pageable인터페이스를 사용해 2D 그래픽의 인쇄가 가능합니다. 인쇄 다이얼로그가 초기 상태로 표시되었을 때에 선택한 프린터는 이 인쇄 작업에 현재 접속되고 있는 인쇄 서비스를 반영합니다. 사용자가 인쇄 서비스를 변경하는 경우, 사용자가 인쇄 다이얼로그를 취소하지 않는 한, PrinterJob가 갱신되어 변경을 반영합니다. 사용자는 출력처 프린터의 선택과 함께, 다양한 인쇄 요구 속성의 값을 선택할 수도 있습니다.

속성 파라미터 on input는 어플리케이션이 요구하는 사용자 다이얼로그에서의 초기 선택을 반영합니다. 속성이 지정되지 않는 경우는 인쇄 서비스의 디폴트의 속성을 사용해 표시됩니다. 속성 파라미터 on return는 사용자 의 선택을 반영합니다. 선택은 현재 선택되고 있는 인쇄 서비스가 지원하는 값과 일치하도록 갱신됩니다.

사용자가 스크롤의해 새로운 인쇄 서비스를 선택하면, 값의 카피는 사용자 의 임의의 변경과 함께 직전의 서비스의 설정에 근거해 행해집니다. 이 값의 카피는 클라이언트가 지정한 원의 설정에 근거해 행해지는 것은 아닙니다.

프린터의 선택의 예외로서 PrinterJob 상태가 사용자 의 변경을 반영해 갱신되지 않는 경우가 있습니다. 프린터의 선택에 의해 인쇄 작업을 갱신할 수 있도록 하려면, print(PrintRequestAttributeSet) 메서드의 호출로 속성을 지정할 필요가 있습니다. Pageable 인터페이스를 사용하고 있는 경우, 사용자가 선택한 미디어를 사용할 예정의 클라이언트는 사용자 의 선택으로부터 파생하는 PageFormat를 작성할 필요가 있습니다. 사용자가 인쇄 다이얼로그를 취소했을 경우는 속성은 사용자가 간 변경을 반영하지 않습니다.

파라미터:

attributes - on input는 속성이 제공하는 어플리케이션이다. on output는 사용자 의 선택에 의해 내용이 갱신된다. 이 파라미터는 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 

공통 플랫폼의 페이지 설정 다이얼로그를 표시하는 간이 메서드입니다. 유효한 선택은 이 PrinterJob에 현재 설정되어 있는 인쇄 작업을 반영합니다.

속성 파라미터 on input는 클라이언트가 요구하는 사용자 다이얼로그에서의 초기 선택을 반영합니다. 속성이 지정되지 않는 경우는 인쇄 서비스의 디폴트의 속성을 사용해 표시됩니다. 속성 파라미터 on return는 사용자 의 선택을 반영합니다. 선택은 현재 선택되고 있는 인쇄 서비스가 지원하는 값과 일치하도록 갱신됩니다.

반환값은 PrintRequestAttributeSet 에서의 선택과 동등의 PageFormat 입니다. 사용자가 다이얼로그를 취소했을 경우, 속성은 사용자가 간 변경을 반영하지 않습니다. 반환값은 null 입니다.

파라미터:

attributes - on input는 속성이 제공하는 어플리케이션이다. on output는 사용자 의 선택에 의해 내용이 갱신된다. 이 파라미터는 null은 되지 않는다

반환값:

사용자가 다이얼로그를 취소하지 않는 경우는 페이지 서식, 그렇지 않은 경우는 null

예외:

HeadlessException - GraphicsEnvironment.isHeadless()가 true를 돌려주는 경우

NullPointerException - attributes 파라미터가 null인 경우

도입된 버전 :

1.4

관련 항목:

GraphicsEnvironment.isHeadless()

defaultPage

public abstract PageFormat  defaultPage(PageFormat  page)

PageFormat인수를 복제해, 그 복제를 변경해 디폴트의 페이지 사이즈와 인쇄 방향을 기술합니다.

파라미터:

page - 복제 및 변경되는 PageFormat

반환값:

디폴트의 PageFormat를 기술하기 위해서 변경된 page 복제

defaultPage

public PageFormat  defaultPage()

새로운 PageFormat 인스턴스를 생성해, 디폴트의 사이즈와 인쇄 방향으로 설정합니다.

반환값:

디폴트의 사이즈와 인쇄 방향으로 설정된 PageFormat

validatePage

public abstract PageFormat  validatePage(PageFormat  page)

이 PrinterJob 현재의 프린터와 호환성이 있도록 조정된 설정을 가지는 page 복제를 리턴합니다. 예를 들어 리턴된 PageFormat는 현재의 프린터가 사용하고 있는 용지의 물리적 영역내에 수습되도록 조정된 이메징 가능 영역을 가질 수가 있습니다.

파라미터:

page - 복제되어 그 설정이 현재의 프린터와 호환성을 가지도록 변경되는 PageFormat

반환값:

Page로 부터 복제되어 이 PrinterJob에 맞추어 설정이 변경되는 PageFormat

print

public abstract void print()
                    throws PrinterException 

페이지세트를 인쇄합니다.

예외:

PrinterException - 인쇄 시스템의 에러가 원인으로 작업이 정지했을 경우

관련 항목:

Book, Pageable, Printable

print

public void print(PrintRequestAttributeSet  attributes)
           throws PrinterException 

속성 세트의 설정을 사용해 페이지세트를 인쇄합니다. 디폴트의 구현은 속성 세트를 무시합니다.

일부의 속성은 같은 메서드의 호출에 의해 직접 PrinterJob 로 설정되는 경우가 있습니다. 이 메서드의 호출의 예에는 copies: setcopies(int), job name: setJobName(String) 및 PageFormat 객체의 지정에 관계없이 미디어의 사이즈와 인쇄 방향을 지정하는 경우가 있습니다.

지원되는 속성값이 이 속성 세트로 가리키는 경우는 이 print() 오퍼레이션의 경우만 API 설정보다 우선됩니다. 다음에 말하는 동작은 PageFormat에 대해서 지정됩니다. 클라이언트가 Printable 인터페이스를 사용하고 있는 경우, 이 메서드에 대한 attributes 파라미터는 미디어 사이즈, 인쇄 방향 및 이메징 가능 영역을 지정하는 속성이 검사되어 이것들은 Printable 객체의 print() 메서드에게 건네지는 새로운 PageFormat를 구축하기 위해서 사용됩니다. PrinterJob 에 한 최적인 인쇄에 필요한 Printable 동작에 대해서는 Printable를 참조하십시오. Pageable 인터페이스를 사용하는 클라이언트의 경우, PageFormat는 항상 이 인터페이스에 의해 1 페이지 마다 제공됩니다.

이러한 동작에의해 어플리케이션은 printDialog(PrintRequestAttributeSet attributes로 부터 리턴된 사용자 설정을 직접 이 print() 메서드에 건네줄 수 있게 됩니다.

파라미터:

attributes - 작업의 속성세트

예외:

PrinterException - 인쇄 시스템의 에러가 원인으로 작업이 정지했을 경우

관련 항목:

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