前言
在我們的實際工作中,經常需要實現打印功能。但由於歷史原因,Java 提供的打印功能一直都比較弱。實際上最初的 jdk 根本不支持打印,直到 jdk1.1 才引入了很輕量的打印支持。所以,在以前用 Java/Applet/JSP/Servlet 設計的程序中,較複雜的打印都是通過調用 ActiveX/OCX 控件或者 VB/VC 程序來實現的,非常麻煩。實際上,SUN 公司也一直致力於 Java 打印功能的完善,而 Java2 平臺則終於有了一個健壯的打印模式的開端,該打印模式與 Java2D 圖形包充分結合成一體。更令人鼓舞的是,新發布的 jdk1.4 則提供了一套完整的"Java 打印服務 API" (Java Print Service API),它對已有的打印功能是積極的補充。利用它,我們可以實現大部分實際應用需求,包括打印文字、圖形、文件及打印預覽等等。本文將通過一個具體的程序實例來說明如何設計 Java 打印程序以實現這些功能,並對不同版本的實現方法進行分析比較。希望大家能從中獲取一些有益的提示。
Java 中的打印
2.1 Java 的打印 API
Java 的打印 API 主要存在於 java.awt.print 包中。而 jdk1.4 新增的類則主要存在於 javax.print 包及其相應的子包 javax.print.event 和 javax.print.attribute 中。其中 javax.print 包中主要包含打印服務的相關類,而 javax.print.event 則包含打印事件的相關定義,javax.print.attribute 則包括打印服務的可用屬性列表等。
2.2 如何實現打印
要產生一個打印,至少需要考慮兩條:
- 需要一個打印服務對象。這可通過三種方式實現:在 jdk1.4 之前的版本,必須要實現 java.awt.print.Printable 接口或通過 Toolkit.getDefaultToolkit().getPrintJob 來獲取打印服務對象;在 jdk1.4 中則還可以通過 javax.print.PrintSerivceLookup 來查找定位一個打印服務對象。
- 需要開始一個打印工作。這也有幾種實現方法:在 jdk1.4 之前可以通過 java.awt.print.PrintJob(jdk1.1 提供的,現在已經很少用了)調用 print 或 printAll 方法開始打印工作;也可以通過 java.awt.print.PrinterJob 的 printDialog 顯示打印對話框,然後通過 print 方法開始打印;在 jdk1.4 中則可以通過 javax.print.ServiceUI 的 printDialog 顯示打印對話框,然後調用 print 方法開始一個打印工作。
2.3 打印機對話框
2.3.1 Printable 的打印對話框
開始打印工作之前,可以通過 PrinterJob.printDialog 來顯示一個打印對話框。它給用戶一個機會以選擇應該打印的頁碼範圍,並可供用戶改變打印設置。它是一個本地對話框。
事實上,當從一個 Printable 對象進行一個打印工作時,打印對象並不知道需要打印多少頁。它只是不停地調用 print 方法。只要 print 方法返回 Printable.PAGE_EXISTS 值,打印工作就不停地產生打印頁,直到 print 方法返回 Printable.NO_SUCH_PAGE 時,打印工作才停止。
由於打印工作只有在打印完成後才進行準確的頁數計算,所以在對話框上的頁碼範圍是尚未初始化的 [1,9999]。我們可以通過構建一個 java.awt.print.Book 對象傳遞給打印對象;也可以通過指定的格式計算需要打印的頁數並傳遞給打印對象,使其準確地知道要打印多少頁。
2.3.2 ServiceUI 的打印對話框
與 Printable 的對話框不同的是,在 jdk1.4 提供 ServiceUI 的打印機對話框的缺省行爲已經用新的 API 更改了:缺省情況下對話框不顯示。我們必須使用 ServiceUI 類調用 printDialog 方法創建如下所示的打印對話框。
Java 打印程序設計實例
3.1 打印文本
3.1.1 應用場景
假設我們需要打印一個窗體的某個文本編輯域(可能只有幾行,也可能包含多頁)的內容,並且每頁最多打印 54 行,如何實現呢?
3.1.2 解決方法
基本思路如下:首先我們需要實現 Printable 接口,然後按照每頁最多 54 行的格式計算共需要打印多少頁,當打印文本的按鈕被點擊時,執行相應的打印動作。打印文本的具體操作可通過 Graphics2D 的 drawString 方法來實現。
1、實現 Printable 接口
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 | /*Graphic 指明打印的圖形環境;PageFormat 指明打印頁格式(頁面大小以點爲計量單位, 1 點爲 1 英才的 1/72,1 英寸爲 25.4 毫米。A4 紙大致爲 595 × 842 點);page 指明頁號 */ public int print(Graphics g, PageFormat pf, int page) throws PrinterException { Graphics2D g2 = (Graphics2D)g; g2.setPaint(Color.black); // 設置打印顏色爲黑色 if (page >= PAGES) // 當打印頁號大於需要打印的總頁數時,打印工作結束 return Printable.NO_SUCH_PAGE; g2.translate(pf.getImageableX(), pf.getImageableY());// 轉換座標,確定打印邊界 drawCurrentPageText(g2, pf, page); // 打印當前頁文本 return Printable.PAGE_EXISTS; // 存在打印頁時,繼續打印工作 } /* 打印指定頁號的具體文本內容 */ private void drawCurrentPageText(Graphics2D g2, PageFormat pf, int page) { String s = getDrawText(printStr)[page];// 獲取當前頁的待打印文本內容 // 獲取默認字體及相應的尺寸 FontRenderContext context = g2.getFontRenderContext(); Font f = area.getFont(); String drawText; float ascent = 16; // 給定字符點陣 int k, i = f.getSize(), lines = 0; while(s.length() > 0 && lines < 54 ) // 每頁限定在 54 行以內 { k = s .indexOf('\n'); // 獲取每一個回車符的位置 if (k != -1) // 存在回車符 { lines += 1; // 計算行數 drawText = s .substring(0, k); // 獲取每一行文本 g2.drawString(drawText, 0, ascent); // 具體打印每一行文本,同時走紙移位 if (s.substring(k + 1).length() > 0) { s = s.substring(k + 1); // 截取尚未打印的文本 ascent += i; } } else // 不存在回車符 { lines += 1; // 計算行數 drawText = s; // 獲取每一行文本 g2.drawString(drawText, 0, ascent); // 具體打印每一行文本,同時走紙移位 s = ""; // 文本已結束 } } } /* 將打印目標文本按頁存放爲字符串數組 */ public String[] getDrawText(String s) { String[] drawText = new String[PAGES];// 根據頁數初始化數組 for (int i = 0; i < PAGES ; i++) drawText[i] = ""; // 數組元素初始化爲空字符串 int k, suffix = 0 , lines = 0 ; while(s.length() > 0) { if(lines < 54 ) // 不夠一頁時 { k = s .indexOf('\n'); if (k != -1) // 存在回車符 { lines += 1; // 行數累加 // 計算該頁的具體文本內容,存放到相應下標的數組元素 drawText[suffix] = drawText[suffix] + s.substring(0, k + 1); if (s.substring(k + 1).length() > 0) s = s.substring(k + 1); } else { lines += 1; // 行數累加 // 將文本內容存放到相應的數組元素 drawText[suffix] = drawText[suffix] + s; s = ""; } } else // 已滿一頁時 { lines = 0; // 行數統計清零 suffix++; // 數組下標加 1 } } return drawText; } |
2、計算需要打印的總頁數
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | public int getPagesCount(String curStr) { int page = 0; int position, count = 0; String str = curStr; while(str.length() > 0) // 文本尚未計算完畢 { position = str.indexOf('\n'); // 計算回車符的位置 count += 1; // 統計行數 if (position != -1) str = str.substring(position + 1); // 截取尚未計算的文本 else str = ""; // 文本已計算完畢 } if (count > 0) page = count / 54 + 1; // 以總行數除以 54 獲取總頁數 return page; // 返回需打印的總頁數 } |
3.1、以 jdk1.4 以前的版本實現打印動作按鈕監聽,並完成具體的打印操作
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | private void printTextAction() { printStr = area.getText().trim(); // 獲取需要打印的目標文本 if (printStr != null && printStr.length() > 0) // 當打印內容不爲空時 { PAGES = getPagesCount(printStr); // 獲取打印總頁數 PrinterJob myPrtJob = PrinterJob.getPrinterJob(); // 獲取默認打印作業 PageFormat pageFormat = myPrtJob.defaultPage(); // 獲取默認打印頁面格式 myPrtJob.setPrintable(this, pageFormat); // 設置打印工作 if (myPrtJob.printDialog()) // 顯示打印對話框 { try { myPrtJob.print(); // 進行每一頁的具體打印操作 } catch(PrinterException pe) { pe.printStackTrace(); } } } else { // 如果打印內容爲空時,提示用戶打印將取消 JOptionPane.showConfirmDialog (null, "Sorry, Printer Job is Empty, Print Cancelled!", "Empty", JOptionPane.DEFAULT_OPTION, JOptionPane.WARNING_MESSAGE); } } |
3.2、以 jdk1.4 新版本提供的 API 實現打印動作按鈕監聽,並完成具體的打印操作
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 | private void printText2Action() { printFlag = 0; // 打印標誌清零 printStr = area.getText().trim();// 獲取需要打印的目標文本 if (printStr != null && printStr.length() > 0) // 當打印內容不爲空時 { PAGES = getPagesCount(printStr); // 獲取打印總頁數 // 指定打印輸出格式 DocFlavor flavor = DocFlavor.SERVICE_FORMATTED.PRINTABLE; // 定位默認的打印服務 PrintService printService = PrintServiceLookup.lookupDefaultPrintService(); // 創建打印作業 DocPrintJob job = printService.createPrintJob(); // 設置打印屬性 PrintRequestAttributeSet pras = new HashPrintRequestAttributeSet(); DocAttributeSet das = new HashDocAttributeSet(); // 指定打印內容 Doc doc = new SimpleDoc(this, flavor, das); // 不顯示打印對話框,直接進行打印工作 try { job.print(doc, pras); // 進行每一頁的具體打印操作 } catch(PrintException pe) { pe.printStackTrace(); } } else { // 如果打印內容爲空時,提示用戶打印將取消 JOptionPane.showConfirmDialog(null, "Sorry, Printer Job is Empty, Print Cancelled!", "Empty", JOptionPane.DEFAULT_OPTION, JOptionPane.WARNING_MESSAGE); } } |
3.2 打印預覽
3.2.1 應用場景
大多少商業應用都需要提供打印預覽機制,它可以讓我們在屏幕上看到頁面,這樣就不會因爲不喜歡的打印結果而浪費紙張。 假設我們在打印上一節所說的文本之前,需要先進行打印預覽。那麼該怎麼實現呢?
界面實現圖示如下:(Next 預覽下一頁,Preview 預覽前一頁,Close 則關閉預覽)
3.2.2 解決方法
基本思路:雖然 Java2 平臺的打印 API 並不提供標準的打印預覽對話框,但是自己來進行設計也並不複雜。正常情況下,print 方法將頁面環境繪製到一個打印機圖形環境上,從而實現打印。而事實上,print 方法並不能真正產生打印頁面,它只是將待打印內容繪製到圖形環境上。所以,我們可以忽略掉屏幕圖形環境,經過適當的縮放比例,使整個打印頁容納在一個屏幕矩形裏,從而實現精確的打印預覽。
在打印預覽的設計實現中,主要需要解決兩個問題。第一,如何將打印內容按合適的比例繪製到屏幕;第二,如何實現前後翻頁。下面我給出這兩個問題的具體實現方法,完整的實現請參看附件中的 PrintPreviewDialog.java 文件。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 | /* 將待打印內容按比例繪製到屏幕 */ public void paintComponent(Graphics g) { super.paintComponent(g); Graphics2D g2 = (Graphics2D)g; PageFormat pf = PrinterJob.getPrinterJob().defaultPage(); // 獲取頁面格式 double xoff; // 在屏幕上頁面初始位置的水平偏移 double yoff; // 在屏幕上頁面初始位置的垂直偏移 double scale; // 在屏幕上適合頁面的比例 double px = pf.getWidth(); // 頁面寬度 double py = pf.getHeight(); // 頁面高度 double sx = getWidth() - 1; double sy = getHeight() - 1; if (px / py < sx / sy) { scale = sy / py; // 計算比例 xoff = 0.5 * (sx - scale * px); // 水平偏移量 yoff = 0; } else { scale = sx / px; // 計算比例 xoff = 0; yoff = 0.5 * (sy - scale * py); // 垂直偏移量 } g2.translate((float)xoff, (float)yoff); // 轉換座標 g2.scale((float)scale, (float)scale); Rectangle2D page = new Rectangle2D.Double(0, 0, px, py); // 繪製頁面矩形 g2.setPaint(Color.white); // 設置頁面背景爲白色 g2.fill(page); g2.setPaint(Color.black);// 設置頁面文字爲黑色 g2.draw(page); try { preview.print(g2, pf, currentPage); // 顯示指定的預覽頁面 } catch(PrinterException pe) { g2.draw(new Line2D.Double(0, 0, px, py)); g2.draw(new Line2D.Double(0, px, 0, py)); } } /* 預覽指定的頁面 */ public void viewPage(int pos) { int newPage = currentPage + pos; // 指定頁面在實際的範圍內 if (0 <= newPage && newPage < preview.getPagesCount(printStr)) { currentPage = newPage; // 將指定頁面賦值爲當前頁 repaint(); } } |
這樣,在按下"Next"按鈕時,只需要調用 canvas.viewPage(1);而在按下"Preview"按鈕時,只需要調用 canvas.viewPage(-1) 即可實現預覽的前後翻頁。
3.3 打印圖形
3.3.1 應用場景
在實際應用中,我們還需要打印圖形。譬如,我們有時需要將一個 Java Applet 的完整界面或一個應用程序窗體及其所包含的全部組件都打印出來,又應該如何實現呢?
3.3.2 解決方法
基本思路如下:在 Java 的 Component 類及其派生類中都提供了 print 和 printAll 方法,只要設置好屬性就可以直接調用這兩個方法,從而實現對組件及圖形的打印。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | /* 打印指定的窗體及其包含的組件 */ private void printFrameAction() { Toolkit kit = Toolkit.getDefaultToolkit(); // 獲取工具箱 Properties props = new Properties(); props.put("awt.print.printer", "durango");// 設置打印屬性 props.put("awt.print.numCopies", "2"); if(kit != null) { // 獲取工具箱自帶的打印對象 PrintJob printJob = kit.getPrintJob(this, "Print Frame", props); if(printJob != null) { Graphics pg = printJob.getGraphics();// 獲取打印對象的圖形環境 if(pg != null) { try { this.printAll(pg);// 打印該窗體及其所有的組件 } finally { pg.dispose();// 註銷圖形環境 } } printJob.end();// 結束打印作業 } } } |
3.4 打印文件
3.4.1 應用場景
在很多實際應用情況下,我們可能都需要打印用戶指定的某一個文件。該文件可能是圖形文件,如 GIF、JPEG 等等;也可能是文本文件,如 TXT、Java 文件等等;還可能是複雜的 PDF、DOC 文件等等。那麼對於這樣的打印需求,我們又應該如何實現呢?
3.4.2 解決方法
基本思路:在 JDK 1.4 以前的版本,要實現這樣的打印功能將非常麻煩和複雜,甚至是難以想象的。但幸運的是,jdk1.4 的打印服務 API 提供了一整套的打印文件流的類和方法。利用它們,我們可以非常方便快捷地實現各式各樣不同類型文件的打印功能。下面給出一個通用的處理方法。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | /* 打印指定的文件 */ private void printFileAction() { // 構造一個文件選擇器,默認爲當前目錄 JFileChooser fileChooser = new JFileChooser(SystemProperties.USER_DIR); int state = fileChooser.showOpenDialog(this);// 彈出文件選擇對話框 if (state == fileChooser.APPROVE_OPTION)// 如果用戶選定了文件 { File file = fileChooser.getSelectedFile();// 獲取選擇的文件 // 構建打印請求屬性集 PrintRequestAttributeSet pras = new HashPrintRequestAttributeSet(); // 設置打印格式,因爲未確定文件類型,這裏選擇 AUTOSENSE DocFlavor flavor = DocFlavor.INPUT_STREAM.AUTOSENSE; // 查找所有的可用打印服務 PrintService printService[] = PrintServiceLookup.lookupPrintServices(flavor, pras); // 定位默認的打印服務 PrintService defaultService = PrintServiceLookup.lookupDefaultPrintService(); // 顯示打印對話框 PrintService service = ServiceUI.printDialog(null, 200, 200, printService , defaultService, flavor, pras); if (service != null) { try { DocPrintJob job = service.createPrintJob();// 創建打印作業 FileInputStream fis = new FileInputStream(file);// 構造待打印的文件流 DocAttributeSet das = new HashDocAttributeSet(); Doc doc = new SimpleDoc(fis, flavor, das);// 建立打印文件格式 job.print(doc, pras);// 進行文件的打印 } catch(Exception e) { e.printStackTrace(); } } } } |
在上面的示例中,因尚未確定文件的類型,所以將指定文件的打印格式定義爲 DocFlavor.INPUT_STREAM.AUTOSENSE。事實上,如果在進行打印之前,就已確定地知道文件的格式,如爲 GIF,就應定義爲 DocFlavor.INPUT_STREAM.GIF ;如爲 PDF,就應該定義爲 DocFlavor.INPUT_STREAM.PDF;如爲純 ASCII 文件,就可以定義爲 DocFlavor.INPUT_STREAM.TEXT_HTML_US_ASCII。等等。jdk1.4 的 javax.print.DocFlavor 提供了極爲豐富的文件流類型,你可以根據具體的應用需求進行合適的選擇。具體的 API 參考文檔可見本文的參考資料 3。
結束語
以上是本人在兩年多 J2EE 應用開發中,總結的關於用 Java 進行打印程序設計的一些經驗,希望能給大家一些啓示和裨益。儘管目前用 Java 來實現打印功能與用 Microsoft 的 MFC API 相比確實有更多的麻煩。但 jdk1.4 的推出,對 Java 以前較弱的打印功能是一個極好的補充。相信大家如果能夠很好地理解前文所述的打印程序設計實例,並加以應用和拓展,應該可以解決目前大部分應用的實際編程問題。而隨着 Java 的進一步發展和完善,必將更好地充實其基礎類庫及打印 API,相信用 Java 實現高級打印功能也將越來越不成爲我們這些 Java 癡迷者頭痛的問題。
例程源碼
PrintSrc.zip包含下列 java 源代碼和 Class 代碼:
- PrintTest.java 包含了本文所描述的所有打印功能的實現源代碼。相應的打印文本功能通過 Print Text 和 PrintText2(jdk1.4 實現)按鈕調用;打印文件通過 Print File 按鈕調用;打印圖形通過 Print Frame 按鈕調用;而 Print Preview 則進行打印預覽。
- PrintPreviewDialog.java 包含打印預覽源代碼,你可以通過 PrintTest 窗體中的 Print Preview 按鈕來調用。