biz-Streamマニュアルダイレクト印刷ガイド第3章 ダイレクト印刷を使用したアプリケーション開発の概要3.5 DirectPrintStreamクラス

3.5 DirectPrintStreamクラス

PDFDirectPrintStreamクラス

PDFDirectPrintStreamはダイレクト印刷クライアントモジュールで使用する印刷データを生成するためのストリーム・クラスです。PDFDirectPrintStreamはbiz-StreamライブラリのPDF生成エンジンの出力先として指定します。印刷データを生成する際には、印刷の制御を行うために以下のものが設定できます。

名称 説明 既定値
印刷応答URL 印刷結果または発生したエラーの内容等を応答するためのURLを指定 応答しない
ファイル保存 印刷に使用したデータをPDFファイルとしてローカルに保存する場合に指定 保存しない
プリンタ名 出力先のプリンタ名を指定 デフォルトプリンタ
印刷ジョブ名 印刷のジョブ名称を任意の文字列で指定 なし
印刷部数 印刷部数を指定 1部
出力トレイ 出力する際に使用するトレイを指定 自動選択
印刷ダイアログの表示 印刷ダイアログを表示するかを指定します 表示しない(false)
ブラウザターゲット名 印刷応答を返す際のブラウザターゲット名を指定 "bizprint"
開始ページ番号 印刷するファイルの開始ページ番号を指定します 1 ※1
終了ページ番号 印刷するファイルの終了ページ番号を指定します -1 ※2
パスワード指定(平文) ユーザパスワード(平文)をセットします。 空文字
パスワード指定(エンコード済み) ユーザパスワード(base64エンコード済み)をセットします。 空文字
ページサイズに合わせて印刷 ページサイズに合わせて印刷フラグをセットします。 合わせる(true)
SPPファイル名を一意化 SPPファイル名を一意化するかを指定します 一意化する(true)
  • ※1PDFファイルのページ数の範囲外を指定した場合、1を指定したのと同じ挙動になります。
  • ※2既定値の「-1」を指定すると、最終ページまで印刷できます。PDFファイルのページ数の範囲外を指定した場合、-1を指定したのと同じ挙動になります。

  1. コンストラクタ

    PDFDirectPrintStreamが持つコンストラクタは次の一つのみです。
    PDFDirectPrintStream(HttpServletResponse reseponse)

    引数名 タイプ 説明
    response HttpServletResponse ダイレクト印刷クライアントモジュールの要求をしたセッションのHTTP要求オブジェクト印刷データの送出に先立ち、コンテンツ長および、コンテンツ・タイプ(apprication/x-spp) が自動的に設定
  2. setResponseUrlメソッド

    印刷結果または発生したエラーの内容等を応答するためのURLを指定します。
    setReseponseUrl(String value)

    引数名 タイプ 説明
    value String 応答先URL
    例) http://directprint/webbs/view/direct1_1.jsp
  3. setSaveFileNameメソッド

    印刷に使用したPDFファイルをローカルに保存する場合、そのファイル名を指定します。
    setSaveFileName(String value)

    引数名 タイプ 説明
    value String 保存先のファイル名
    例) c:\sample.pdf
  4. setPrinterNameメソッド

    出力先のプリンタ名 (「コントロールパネル」の「デバイスとプリンター」で表示されるプリンタ名) を指定します。
    setPrinterName(String value)

    引数名 タイプ 説明
    value String 出力先のプリンタ名
    例) Canon LBP3800 LIPSLX
  5. setJobNameメソッド

    印刷のジョブ名称を任意の文字列で指定します。
    void setJobName(String jobName)

    引数名 タイプ 説明
    jobName String 印刷のジョブ名
    例) 給与明細
  6. setNumberOfCopyメソッド

    印刷する部数を正の整数で指定します。
    setNumberOfCopy(int value)

    引数名 タイプ 説明
    value int 印刷部数 (正の整数)
  7. setSelectedTrayメソッド

    印刷に使用するトレイを指定します。指定する値はあらかじめPDFDirectPrintStreamクラスに宣言されている下記の表の定数名を使用してください。
    setSelectedTray(String value)

    引数名 タイプ 説明
    value String 出力トレイ ※(下記の表を参照)
    ※出力トレイ指定用の定数名
    定数名 説明
    PDFDirectPrintStream.TRAY_UPPER 上段のトレイ
    PDFDirectPrintStream.TRAY_MIDDLE 中段のトレイ
    PDFDirectPrintStream.TRAY_LOWER 下段のトレイ
    PDFDirectPrintStream.TRAY_MANUAL 手差しトレイ
    PDFDirectPrintStream.TRAY_AUTO 最適のトレイを自動選択
    • 出力トレイの指定は、プリンタによって異なります。あらかじめお使いのプリンタ環境をご確認ください。

  8. setPrintDialogメソッド

    クライアント側に印刷ダイアログを表示する場合に指定します。
    setPrintDialog(boolean value)

    引数名 タイプ 説明
    value boolean true: 印刷ダイアログを表示します
    false: 印刷ダイアログを表示しません
  9. setTargetメソッド

    印刷応答を返すブラウザウィンドウのターゲット名を指定します。使用するブラウザがMicrosoft Internet Explorerの場合にのみ有効となります。
    詳細については、「3.3 ターゲット機能を使ったダイレクト印刷」を参照してください。
    setTarget(String value)

    引数名 タイプ 説明
    value String ブラウザターゲット名
    例) brain
  10. setFromPageメソッド

    印刷するファイルの開始ページ番号を指定します。出力するPDFのページ数の範囲から外れた値を指定した場合、先頭ページを指定したことになります。
    void setFromPage(int fromPage)

    引数名タイプ説明
    fromPageint印刷ファイルの開始ページ番号
  11. setToPageメソッド

    印刷するファイルの終了ページ番号を指定します。出力するPDFのページ数の範囲から外れた値を指定した場合、最終ページを指定したことになります。
    void setToPage(int toPage)

    引数名タイプ説明
    toPageint印刷ファイルの終了ページ番号
  12. setPasswordメソッド

    ユーザパスワード(平文)をセットします。
    void setPassword(String value)

    引数名タイプ説明
    valueString平文パスワード
  13. setPasswordWithEncodedメソッド

    ユーザパスワード(base64エンコード済み)をセットします。
    void setPasswordWithEncoded(String value)

    引数名タイプ説明
    valueStringbase64エンコード済みパスワード
  14. setDoFitメソッド

    ページサイズに合わせて印刷フラグをセットします。
    void setDoFit(boolean value)

    引数名タイプ説明
    valuebooleantrue : ページサイズに合わせて印刷します
    false : ページサイズには合わせません
  15. setSppNameUnifiedメソッド

    SPPファイル名を一意化するかを指定します。
    void setSppNameUnified(boolean value)

    引数名タイプ説明
    valuebooleantrue : SPPファイルの名称を一意化します
    false : ファイル名を一意化しません(サーブレット名がSPPファイル名になります)