java.awt.print
介面 Printable

public interface Printable

Printable 介面由當前頁面 painter 的 print 方法實作，該方法由列印系統調用，以呈現頁面。建構 Pageable 時，使用 PageFormat 實例和實作此介面的實例構成的實例用於描述每個頁面。調用實作 Printable 的實例，以列印頁面的圖形。

在 PrinterJob 上可以設置 Printable(..)。當客戶端隨後通過調用 PrinterJob.print(..) 啟動列印時，控制被傳送到列印系統，直到所有的頁面完成列印。這是通過在文檔中所有頁面列印完成前一直調用 Printable.print(..) 來實作的。使用 Printable 介面時，只要列印系統請求，該列印就將頁面內容提交給圖像。

Printable.print(..) 的參數包括描述該頁面可列印區域（計算適合該頁面的內容所需要的區域）的 PageFormat 和頁面索引（它指定請求頁面的從 0 開始的列印串流索引）。

要正確的進行列印，應注意以下幾點：

• 列印系統可能多次請求頁面索引。對於每種情況，都將提供等效的 PageFormat 參數。
• 列印系統將使用單調遞增的頁面索引來調用 Printable.print(..)，儘管上文已說明，Printable 應期望多次調用頁面索引，並期望當客戶端或使用者通過列印對話指定頁面範圍時，可以跳過頁面索引。
• 如果請求文檔多次逐份列印，並且印表機本身不支持此行為，那麼該文檔可能成像多次。將從最低列印串流頁面索引頁面開始每次列印。
• 除了為多次逐份列印重新成像整個文檔外，遞增的頁面索引順序意味著，當請求頁面 N 時，如果客戶端需要計算頁面中斷位置，則可以安全地丟棄任何與 < N 的頁面相關的狀態，並將頁面 N 設置為當前狀態。在與頁面起始部分對應的文檔中，「狀態」通常就是計算的位置。
• 當被列印系統調用時，Printable 必須檢查並遵照提供的 PageFormat 參數以及頁面索引。要繪製的頁面格式由提供的 pageFormat 指定。所以該頁面的大小、方向和可成像區域已經確定，並且必須在此可成像區域中呈現。這是正確進行列印的關鍵，它暗示客戶端負責追蹤指定頁面上所屬的內容。
• 從客戶端提供的 Pageable 獲取 Printable 時，該客戶端可能為每個頁面索引提供不同的 PageFormat。計算頁面中斷必須考慮到這一點。

另請參見：

Pageable, PageFormat, PrinterJob

欄位摘要

static int	NO_SUCH_PAGE 從 print 返回，表示 pageIndex 太大以及請求的頁面不存在。
static int	PAGE_EXISTS 從 print(Graphics, PageFormat, int) 返回，表示請求的頁面被呈現。

方法摘要

int	print(Graphics graphics, PageFormat pageFormat, int pageIndex) 將指定索引處的頁面用指定格式列印到指定的 Graphics 上下文。

欄位詳細資訊

PAGE_EXISTS

static final int PAGE_EXISTS

從 print(Graphics, PageFormat, int) 返回，表示請求的頁面被呈現。

另請參見：

常數欄位值

NO_SUCH_PAGE

static final int NO_SUCH_PAGE

從 print 返回，表示 pageIndex 太大以及請求的頁面不存在。

另請參見：

常數欄位值

方法詳細資訊

print

int print(Graphics graphics,
          PageFormat pageFormat,
          int pageIndex)
          throws PrinterException

將指定索引處的頁面用指定格式列印到指定的 Graphics 上下文。PrinterJob 調用 Printable 介面，以請求將頁面呈現到 graphics 指定的上下文。pageFormat 指定要繪製的頁面格式。pageIndex 指定請求頁面從 0 開始的索引。如果請求的頁面不存在，那麼此方法將返回 NO_SUCH_PAGE；否則返回 PAGE_EXISTS。Graphics 類別或子類別實作 PrinterGraphics 介面，以提供附加資訊。如果 Printable 物件中止該列印作業，那麼它將拋出 PrinterException。

參數：

graphics - 用來繪製頁面的上下文

pageFormat - 將繪製的頁面的大小和方向

pageIndex - 要繪製的頁面從 0 開始的索引

返回：

如果成功呈現該頁面，則返回 PAGE_EXISTS；如果 pageIndex 指定不存在的頁面，則返回 NO_SUCH_PAGE。

拋出：

PrinterException - 列印作業被終止時拋出。