PrintJob  - AS3

印刷ジョブが現在アクティブであるかどうかを示します。次の 2 つの状況のいずれかで、印刷ジョブがアクティブ（プロパティ値が true）です。

• ページ設定ダイアログまたは印刷ダイアログが表示されている。
• 戻り値 true によって、start() または start2() メソッドが呼び出し済みであり、かつ send() または terminate() メソッドが呼び出されていない場合。

このプロパティが true の場合に、showPageSetupDialog()、start()、または start2() メソッドを呼び出すと、ランタイムによって例外がスローされます。

関連する API エレメント

それ以降に印刷ジョブに追加されたページについて、印刷システムが印刷する部数。この値は、オペレーティングシステムの印刷ダイアログに入力された印刷部数です。印刷部数が印刷ダイアログに表示されなかった場合、または印刷ダイアログがユーザーに表示されなかった場合、この値は 1 です（アプリケーションコードによって変更された場合を除く）。

オペレーティングシステムの印刷ダイアログに入力された、印刷範囲の最初のページを示すページ番号です。すべてのページを印刷するように要求された場合、ページ範囲が印刷ダイアログに表示されなかった場合、または印刷ダイアログがユーザーに表示されていない場合は、このプロパティは 0 です。

現在の印刷設定で選択されているプリンターで、カラー（true）とグレースケール（false）のどちらを使用して印刷するかを示します。

カラーとグレースケールのどちらを使用するのか値を特定できない場合は、値は true です。

PrintJob クラスが現在のプラットフォームでサポートされているか（true）、サポートされていないか（false）を示します。

印刷ジョブの名前またはタイトルです。ジョブ名は、通常は印刷キュー内にあるジョブのタイトルとして、またはファイルに出力されるジョブのデフォルト名として、オペレーティングシステムによって使用されます。

start() または start2() を呼び出さず、プロパティの値も設定していなかった場合、このプロパティの値は null になります。

PrintJob インスタンスで実行する各印刷ジョブに対して、start() または start2() メソッドを呼び出す前にこのプロパティを設定します。

デフォルト値： null。

オペレーティングシステムの印刷ダイアログに入力された、印刷範囲の最後のページを示すページ番号です。すべてのページを印刷するように要求された場合、ページ範囲が印刷ダイアログに表示されなかった場合、または印刷ダイアログがユーザーに表示されていない場合は、このプロパティは 0 です。

選択したプリンターの ppi（ピクセル/インチ）単位での実際の解像度。値は、オペレーティングシステムによってレポートされる現在の印刷設定に応じて計算されます。

解像度を特定できない場合、値は標準のデフォルト値になります。デフォルト値は Linux では 600 ppi で、Mac OS では 360 ppi です。Windows では、プリンターの解像度は常に取得できるので、デフォルト値は必要ありません。

印刷するイメージの向きです。指定可能な値は、PrintJobOrientation クラスの定数として定義されています。

注意：ARI 2 以降では、印刷ジョブを開始する前にこのプロパティを設定し、ページ設定ダイアログと印刷ダイアログでのデフォルトの向きを設定します。start() または start2() を呼び出した後、印刷ジョブの進行中にこのプロパ ィを設定し、ジョブ内のページ範囲の向きを設定します。

関連する API エレメント

ページ上で実際に印刷可能な領域の中央に配置できる最大領域の高さ（ポイント単位）。ユーザーが設定した余白は含みません。このプロパティは、PrintJob.start() メソッドの呼び出し後にのみ使用可能になります。

注意：AIR 以降では、このプロパティの使用は避けてください。代わりに、printableArea を使用してください。これは、印刷可能領域を少数（ポイント単位）で測定し、印刷可能領域からはみ出した部分について正確に記述します。

関連する API エレメント

ページ上で実際に印刷可能な領域の中央に配置できる最大領域の幅（ポイント単位）。ユーザーが設定した余白は含みません。このプロパティは、PrintJob.start() メソッドの呼び出し後にのみ使用可能になります。

注意：AIR 以降では、このプロパティの使用は避けてください。代わりに、printableArea を使用してください。これは、印刷可能領域を少数（ポイント単位）で測定し、印刷可能領域からはみ出した部分について正確に記述します。

関連する API エレメント

プリンターメディアの境界です（ポイント単位）。この値は、以降の addPage() 呼び出しで使用されるのと同じ座標系を使用します。

用紙全体の高さ（ポイント単位）です。このプロパティは、PrintJob.start() メソッドの呼び出し後にのみ使用可能になります。

注意：AIR 以降では、このプロパティの使用は避けてください。代わりに、paperArea を使用してください。これは、用紙サイズを少数（ポイント単位）に分割して測定します。

関連する API エレメント

用紙全体の幅（ポイント単位）です。このプロパティは、PrintJob.start() メソッドの呼び出し後にのみ使用可能になります。

注意：AIR 以降では、このプロパティの使用は避けてください。代わりに、paperArea を使用してください。これは、用紙サイズを少数（ポイント単位）に分割して測定します。

関連する API エレメント

プリンターメディアの印刷可能範囲の境界です（ポイント単位）。この値は、以降の addPage() 呼び出しで使用されるのと同じ座標系を使用します。

現在の印刷ジョブに使用されるプリンターを取得または設定します。setter に渡され、getter から返される String は、printers() メソッドから返された Array 内のいずれかのストリングに一致します。デフォルトプリンターを使用することを示すには、値を null に設定します。デフォルトプリンターを特定できないオペレーティングシステム上では、このプロパティ値は null です。

     import flash.printing.PrintJob;
     
     var myPrintJob:PrintJob = new PrintJob();
     myPrintJob.printer = "HP_LaserJet_1";
     myPrintJob.start();
     

このプロパティの値を設定すると、直ちにプリンターの選択が実行されます。プリンターの選択に失敗した場合、このプロパティの値は以前の値にリセットされます。このプリンター値の設定が成功したかどうかは、値の設定を試行した後に値を読み取り、設定した値と読み取った値が一致することを確認することにより、判別できます。

アクティブな印刷ジョブの printer プロパティは変更できません。start() または start2() メソッドの呼び出しに成功した後、send() または terminate() の呼び出し前にこの値を変更しようとすると、失敗します。

使用可能なプリンターのリストを、String 名の値として提供します。リストは事前に計算済みのものではなく、この関数が呼び出されたときに作成されます。使用可能なプリンターがない場合、またはシステムが印刷をサポートしていない場合、値は null を返します。システムで印刷をサポートしているが、プリンターのリストを返せない場合は、戻り値は 1 個の要素を持つ Vector になります（length プロパティは 1 です）。この場合、この 1 個の要素は実際のプリンター名を表すか、プリンター名が特定できない場合はデフォルトのプリンター名を表します。

Flash ランタイム環境で個別のページ設定ダイアログがサポートされるかどうかを示します。このプロパティが true の場合、showPageSetupDialog() メソッドを呼び出してオペレーティングシステムのページ設定ダイアログボックスを表示できます。

関連する API エレメント

ページを印刷できる PrintJob オブジェクトを作成します。PrintJob オブジェクトを作成したら、PrintJob.start()、PrintJob.addPage()、PrintJob.send() の順にメソッドを使用して、プリンターに印刷ジョブを送信します。

例えば、次のコードに示すように、myPrintJob.addPage() メソッド呼び出しの [params] プレースホルダーテキストをカスタムパラメーターに置き換えることができます。

 // create PrintJob object
 var myPrintJob:PrintJob = new PrintJob();
  
 // display Print dialog box, but only initiate the print job
 // if start returns successfully.
 if (myPrintJob.start()) {
  
    // add specified page to print job
    // repeat once for each page to be printed
    try {
      myPrintJob.addPage([params]);
    }
    catch(e:Error) {
      // handle error 
    }
    try {
      myPrintJob.addPage([params]);
    }
    catch(e:Error) {
      // handle error 
    }
 
    // send pages from the spooler to the printer, but only if one or more
    // calls to addPage() was successful. You should always check for successful 
    // calls to start() and addPage() before calling send().
    myPrintJob.send();
 }
 

AIR 2 以降では、複数の PrintJob インスタンスを作成して使用できます。PrintJob インスタンスに設定されたプロパティは、印刷の完了後も保持されます。これにより、アプリケーション内の別のコンテンツに対して異なる印刷環境設定を適用する一方で、PrintJob インスタンスを再利用し、ユーザーによって選択された印刷環境設定を保持することができます。Flash Player および AIR 2 より前のバージョンの AIR では、最初の PrintJob オブジェクトがまだアクティブなときには、2 つ目の PrintJob オブジェクトを作成できません。1 つ目の PrintJob オブジェクトがアクティブであるときに new PrintJob() を呼び出して 2 つ目の PrintJob オブジェクトを作成しようとしても、2 つ目の PrintJob オブジェクトは生成されません。そのため、2 つ目の PrintJob を作成する前に myPrintJob 値を確認できます。

関連する API エレメント

指定の Sprite オブジェクトを 1 ページとして印刷スプーラに送ります。このメソッドを使用する前に、PrintJob オブジェクトを作成し、start() または start2() を使用する必要があります。次に、印刷ジョブに対して addPage() を 1 回または複数回呼び出した後、send() を使用して、スプールしたページをプリンターに送信します。つまり、PrintJob オブジェクトを作成したら、start()、start2()()、addPage()、send() の順にメソッドを使用して、プリンターに印刷ジョブを送信します。start() を 1 回呼び出した後、addPage() を複数回呼び出して、1 回の印刷ジョブで複数のページを印刷できます。

addPage() によって Flash Player が例外をスローした場合（start() を呼び出していなかった場合や、ユーザーが印刷ジョブをキャンセルした場合など）は、それ以降の addPage() の呼び出しはすべて失敗します。ただし、それ以前の addPage() の呼び出しが成功していれば、最後に send() コマンドを実行することで、スプールされていたすべてのページがプリンターに送られます。

印刷ジョブで addPage() 操作の完了に 15 秒以上かかる場合、Flash Player は、次回 addPage() が呼び出されたときに例外をスローします。

printArea パラメーターの値を渡すと、printArea 矩形の x 座標と y 座標が、ページの印刷可能領域の左上隅（0, 0 座標）にマップされます。読み取り専用プロパティ pageHeight と pageWidth は、start() によって設定された印刷可能領域を示します。印刷結果はページ上の印刷可能領域の左上隅を基準に整列されるので、printArea で定義した領域が用紙上の印刷可能領域よりも大きい場合は、printArea で定義した領域の右側または下側の部分（またはその両方）は切り取られることがあります。Flash Professional では、printArea の値を指定しない場合にステージが印刷可能領域よりも大きいと、同様の切り取りが発生します。Flex または Flash Builder では、printArea の値を指定しない場合にスクリーンが印刷可能領域よりも大きいと、同様の切り取りが発生します。

印刷前に Sprite オブジェクトを拡大/縮小するには、このメソッドを呼び出す前に拡大 / 縮小のプロパティ（flash.display.DisplayObject.scaleX および flash.display.DisplayObject.scaleY を参照）を設定します。印刷後、これらのプロパティを元の値に戻します。Sprite オブジェクトの拡大 / 縮小は、printArea とは無関係です。つまり、サイズが 50 × 50 ピクセルの領域を印刷するよう指定した場合、2500 ピクセルが印刷されます。Sprite オブジェクトを拡大 / 縮小している場合、その設定を反映してプリント結果は伸縮しますが、プリントの対象となる 2500 個のピクセルは変わりません。

Flash Player の印刷機能は、PostScript プリンターと非 PostScript プリンターをサポートしています。非 PostScript プリンターでは、ベクターはビットマップに変換されます。

パラメーター

関連する API エレメント

用紙サイズを設定します。paperSize パラメーターとして指定できる値は、PaperSize クラスの定数です。このメソッドを呼び出すと、ページ設定ダイアログまたは印刷ダイアログでユーザーが用紙サイズを選択した場合と同じように、印刷設定に影響します。

このメソッドは、いつでも呼び出すことができます。このメソッドは、ページ設定ダイアログと印刷ダイアログでデフォルトの用紙サイズを設定するジョブを開始する前に呼び出します。このメソッドは、印刷ジョブの進行中に呼び出して、ジョブ内のページ範囲に対する用紙サイズを設定します。

     import flash.printing.PrintJob;
     import flash.printing.PaperSize;
     
     var myPrintJob:PrintJob = new PrintJob();
     myPrintJob.selectPaperSize(PaperSize.ENV_10);
     

パラメーター

関連する API エレメント

start() または start2() メソッドおよび addPage() メソッドの呼び出しに成功した後、スプールされたページをプリンターに送信します。

start() または start2() メソッドへの呼び出しが失敗した場合、または addPage() メソッドへの呼び出しが例外をスローした場合、このメソッドは成功しません。エラーを回避するには、このメソッドを呼び出す前に、start() または start2() メソッドが true を返し、addPage() 例外がある場合はそれをキャッチしていることを確認します。次の例では、このメソッドを呼び出す前にエラーを適切に確認する方法について説明します。

     var myPrintJob:PrintJob = new PrintJob();
     if (myPrintJob.start()) {
       try {
         myPrintJob.addPage([params]);
       }
       catch(e:Error) {
          // handle error 
       }
     
       myPrintJob.send();
     }
     

関連する API エレメント

現在の環境でサポートされている場合、オペレーティングシステムのページ設定ダイアログを表示します。ページ設定がサポートされているかどうかを確認するには、supportsPageSetupDialog プロパティを使用します。

     import flash.printing.PrintJob;
     
     var myPrintJob:PrintJob = new PrintJob();
     if (myPrintJob.supportsPageSetupDialog)
     {
         myPrintJob.showPageSetupDialog();
     }
     

関連する API エレメント

オペレーティングシステムの印刷ダイアログボックスを表示し、スプールを開始します。ユーザーは印刷ダイアログボックスで印刷設定を変更できます。PrintJob.start() メソッドが正常に返された場合、つまりユーザーが印刷ダイアログボックスで「OK」をクリックした場合、ユーザーが選択した印刷設定を表す値が次のプロパティに設定されます。

注意：ユーザーが印刷ダイアログボックスでキャンセルすると、プロパティは設定されません。

ユーザーが印刷ダイアログボックスで「OK」をクリックすると、オペレーティングシステムへの印刷ジョブのスプールが開始されます。オペレーティングシステムで印刷の進行状況について情報が表示されるため、ページをスプーラに送信したら直ちに PrintJob.addPage() および PrintJob.send() を呼び出す必要があります。このメソッドによって値が設定された読み取り専用の高さ、幅、方向のプロパティを使用して、印刷結果をフォーマットできます。

PrintJob.addPage() や PrintJob.send() を呼び出す前に、このメソッドが true を返すこと（ユーザーがオペレーティングシステムの印刷ダイアログボックスで「OK」をクリックした場合）を確認するために、テストを行います。

     var myPrintJob:PrintJob = new PrintJob();
        if(myPrintJob.start()) {
          // addPage() and send() statements here
        }
     

特定の印刷ジョブインスタンスでは、次の間隔のいずれかが 15 秒を超えると、PrintJob.start() の次の呼び出しによって false が返されます。

• PrintJob.start() および 1 つ目の PrintJob.addPage()
• 1 つの PrintJob.addPage() と次の PrintJob.addPage()
• 最後の PrintJob.addPage() および PrintJob.send()

関連する API エレメント

必要に応じて、オペレーティングシステムの印刷ダイアログボックスを表示してスプールを開始し、PrintJob の読み取り専用プロパティ値を編集することもできます。

uiOptions パラメーターを使用すると、印刷ダイアログに表示するオプションを呼び出し側で制御できます。詳しくは、PrintUIOptions クラスを参照してください。このパラメーターは、showPrintDialog が false の場合は無視されます。

showPrintDialog が true であっても、このメソッドの動作が start() メソッドの動作と異なることがあります。一部のオペレーティングシステムでは、start() によって、まずページ設定ダイアログが表示され、続いて印刷ダイアログが表示されます。一方、start2() では、ページ設定ダイアログは表示されません。

次の例では、印刷ダイアログがユーザーに表示される前に、印刷ダイアログの最小ページおよび最大ページ設定が設定されます。

     import flash.printing.PrintJob;
     import flash.printing.PrintUIOptions;
     
     var myPrintJob:PrintJob = new PrintJob();
     var uiOpt:PrintUIOptions = new PrintUIOptions();
     uiOpt.minPage = 1;
     uiOpt.maxPage = 3;
     var accepted:Boolean = myPrintJob.start2(uiOpt);
     

パラメーター

関連する API エレメント

印刷ジョブが送信されずに終了することを通知します。このメソッドは、start() または start2() を呼び出すことによって印刷ジョブが既に開始されているが、ページをプリンターに送信することが適切ではない場合に使用します。通常、terminate() は、エラーから回復するためにのみ使用されます。

このメソッドを呼び出した後、PrintJob インスタンスは再利用できます。可能な場合は常に、ジョブの印刷設定は、次回以降に使用できるように保持されます。

1. sheet1 および sheet2 という名前の Sprite 型の 2 つの変数を宣言します。
2. init() を呼び出します。これは、新しい Sprite インスタンスを sheet1 と sheet2 に割り当てた後、別の引数を使用して createSheet() を呼び出します。
3. createSheet() は、以下の処理を行います。
   1. 渡された Sprite オブジェクトを使用して矩形を描画します。これは、明るい灰色の背景に 1 ピクセルの黒い境界線を使用し、x = 0、y = 0 の位置に幅 100 ピクセル、高さ 200 ピクセルで描画されます。
   2. 新しい TextField オブジェクトが作成されます。この名前は txt であり、Sprite と同じサイズです。wordWrap プロパティは true に設定され、テキストプロパティは createSheet() への引数として渡される String に設定されます。
   3. 渡された Object 引数が null ではない場合、新しい Sprite インスタンスを作成します。このインスタンスの名前は img であり、渡されたオブジェクトの座標およびサイズのプロパティを使用して、白い矩形を描画するときに使用されます。addChild() を使用して、白い四角形を Sprite オブジェクトの表示リストに追加します。
   4. addChild() を使用して、txt TextField を Sprite オブジェクトの表示リストに追加します。
4. コンストラクターに戻ると、有効な(コメントアウトされていない）印刷メソッドが呼び出されます。これらのメソッドは非常に似ているため、printOnePerPage() については後で説明します。
5. printOnePerPage() は、以下の処理を行います。
   1. 新しい PrintJob オブジェクトを宣言します。オブジェクトには uint 型として pj と pagesToPrint という名前を付けます。
   2. オペレーティングシステムのネイティブの印刷ダイアログボックスを開き、ユーザーが OK をクリックするまで待機します。
   3. 原点を確認し、「横」が選択されている場合は、エラーをスローして終了します。
   4. sheet1 と sheet2 にページの高さと幅を設定します。
   5. sheet1 および sheet2 を印刷スプーラに送ります（addPage() を使用）。
   6. 印刷するページ数が 1 ページ以上ある場合は、スプールされたページをすべて印刷します。
6. draw() メソッドが呼び出されます。このメソッドによりステージに合わせて 2 つの Sprite プロパティのサイズが変更され、sheet2 が sheet1 の右側になるように再配置されます。

メモ：コンストラクターは、必要に応じて、ページあたり 1 シート、ページあたり 2 シート、またはページの上半分に印刷の 3 つの印刷メソッドのいずれかを選択できるように設定されます。コードコメントを使用して印刷メソッドのうちちょうど 2 つが無効にされている場合に限り、この例は適切に動作します。この例は、printOnePerPage() が呼び出されるように設定されています。

package {
    import flash.printing.PrintJob;
    import flash.printing.PrintJobOrientation;
    import flash.display.Stage;
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.geom.Rectangle;
       
    public class PrintJobExample extends Sprite {
        private var sheet1:Sprite;
        private var sheet2:Sprite;
           
        public function PrintJobExample() {
            init();
            printOnePerPage();
//            printTwoPerPage();
//            printTopHalf();
            draw();
        }
        
        private function init():void {
            sheet1 = new Sprite();
            createSheet(sheet1, "Once upon a time...", {x:10, y:50, width:80, height:130});

            sheet2 = new Sprite();
            createSheet(sheet2, "There was a great story to tell, and it ended quickly.\n\nThe end.", null);
        }
        
        private function createSheet(sheet:Sprite, str:String, imgValue:Object):void {
            sheet.graphics.beginFill(0xEEEEEE);
            sheet.graphics.lineStyle(1, 0x000000);
            sheet.graphics.drawRect(0, 0, 100, 200);
            sheet.graphics.endFill();
            
            var txt:TextField = new TextField();
            txt.height = 200;
            txt.width = 100;
            txt.wordWrap = true;
            txt.text = str;
            
            if(imgValue != null) {
                var img:Sprite = new Sprite();
                img.graphics.beginFill(0xFFFFFF);
                img.graphics.drawRect(imgValue.x, imgValue.y, imgValue.width, imgValue.height);
                img.graphics.endFill();
                sheet.addChild(img);
            }
            sheet.addChild(txt);
        }
        
        private function printOnePerPage():void {
            var pj:PrintJob = new PrintJob();
            var pagesToPrint:uint = 0;
            if(pj.start()) {                
                if(pj.orientation == PrintJobOrientation.LANDSCAPE) {    
                    throw new Error("Without embedding fonts you must print one sheet per page with an orientation of portrait.");
                }
                
                sheet1.height = pj.pageHeight;
                sheet1.width = pj.pageWidth;
                sheet2.height = pj.pageHeight;
                sheet2.width = pj.pageWidth;

                try {
                    pj.addPage(sheet1);
                    pagesToPrint++;
                }
                catch(e:Error) {
                    // do nothing
                }

                try {
                    pj.addPage(sheet2);
                    pagesToPrint++;
                }
                catch(e:Error) {
                    // do nothing
                }

                if(pagesToPrint > 0) {
                    pj.send();
                }
            }
        }
        
        private function printTwoPerPage():void {
            var pj:PrintJob = new PrintJob();
            var pagesToPrint:uint = 0;
            if(pj.start()) {                
                if(pj.orientation == PrintJobOrientation.PORTRAIT) {
                    throw new Error("Without embedding fonts you must print two sheets per page with an orientation of landscape.");
                }
                
                sheet1.height = pj.pageHeight;
                sheet1.width = pj.pageWidth/2;
                sheet2.height = pj.pageHeight;
                sheet2.width = pj.pageWidth/2;

                var sheets:Sprite = new Sprite();
                sheets.addChild(sheet1);
                sheets.addChild(sheet2);
                sheets.getChildAt(1).x = sheets.getChildAt(0).width;
                try {
                    pj.addPage(sheets);
                    pagesToPrint++;
                }
                catch(e:Error) {
                    // do nothing
                }

                if(pagesToPrint > 0) {
                    pj.send();
                }
            }
        }

        private function printTopHalf():void {
            var pj:PrintJob = new PrintJob();
            var pagesToPrint:uint = 0;
            if(pj.start()) {                
                if(pj.orientation == PrintJobOrientation.PORTRAIT) {
                    throw new Error("Without embedding fonts you must print the top half with an orientation of landscape.");
                }
                
                sheet1.height = pj.pageHeight;
                sheet1.width = pj.pageWidth/2;
                sheet2.height = pj.pageHeight;
                sheet2.width = pj.pageWidth/2;

                var sheets:Sprite = new Sprite();
                sheets.addChild(sheet1);
                sheets.addChild(sheet2);
                sheets.getChildAt(1).x = sheets.getChildAt(0).width;
                try {
                    pj.addPage(sheets, new Rectangle(0, 0, sheets.width, sheets.height/2));
                    pagesToPrint++;
                }
                catch(e:Error) {
                    // do nothing
                }

                if(pagesToPrint > 0) {
                    pj.send();
                }
            }
        }


        private function draw():void {
            var sheetWidth:Number = this.stage.stageWidth/2;
            var sheetHeight:Number = this.stage.stageHeight;
            
            addChild(sheet1);
            sheet1.width = sheetWidth;
            sheet1.height = sheetHeight;
            
            addChild(sheet2);
            sheet2.width = sheetWidth;
            sheet2.height = sheetHeight;
            sheet2.x = sheet1.width;
        }        
    }
}