PrintJob  - AS3

Указывает, активно ли в данный момент задание печати. Задание печати является активным (свойство имеет значение true) в любом из двух случаев.

• В данный момент отображается диалоговое окно «Параметры страницы» или «Печать».
• Метод start() или start2() вызывался и возвратил значение true, и не вызывался метод send() или terminate().

Если это свойство имеет значение true и вызывается метод showPageSetupDialog(), start() или start2(), среда выполнения выдает исключение.

Связанные элементы API

Число экземпляров, которое система печати печатает для всех страниц, впоследствии добавляемых в задание печати. Это значение указывает число экземпляров, введенное пользователем в диалоговом окне «Печать» операционной системы. Если в диалоговом окне «Печать» не отображается число экземпляров или если это окно не выводится, используется значение 1 (если оно не изменено кодом приложения).

Номер первой страницы диапазона, введенный пользователем в системном диалоговом окне «Печать». Это свойство имеет нулевое значение, если пользователь запрашивает печать всех страниц, если диапазон страниц не отображался в диалоговом окне «Печать» или если это окно не выводилось.

Указывает, какой режим использует выбранный принтер с текущими настройками печати: цветной (true) или градации серого (false).

Если не удается определить режим, используется значение true.

Указывает, поддерживает ли текущая платформа класс PrintJob: да (true) или нет (false).

Имя или заголовок задания печати. Имя задания обычно используется операционной системой как заголовок задания в очереди печати или как имя по умолчанию для задания, которое печатается в файл.

Если еще не вызывался метод start() или start2() и свойство не задано, то ему задается значение null.

Для каждого задания печати, выполняемого с помощью экземпляра PrintJob, задайте это свойство до вызова метода start() или start2().

Значением по умолчанию является null.

Номер последней страницы диапазона, введенный пользователем в системном диалоговом окне «Печать». Это свойство имеет нулевое значение, если пользователь запрашивает печать всех страниц, если диапазон страниц не отображался в диалоговом окне «Печать» или если это окно не выводилось.

Физическое разрешение выбранного принтера, в пикселах на дюйм. Это значение вычисляется в соответствии с текущими настройками печати в операционной системе.

Если определить разрешение не удается, используется значение по умолчанию. Значение по умолчанию — 600 пикс./дюйм в ОС Linux и 360 пикс./дюйм в ОС Mac OS. В ОС Windows разрешение принтера всегда доступно, поэтому значение по умолчанию не требуется.

Ориентация изображения при печати. Допустимые значения определены как константы в классе PrintJobOrientation.

Примечание. В AIR 2 и более поздних версиях это свойство можно установить до начала печати, чтобы задать ориентацию по умолчанию в диалоговых окнах «Параметры страницы» и «Печать». Установите это свойство в процессе выполнения задания печати (после вызова метода start() или start2(), чтобы задать ориентацию для диапазона страниц в текущем задании.

Связанные элементы API

Высота самой большой области, которую можно расположить по центру фактической области печати на странице (в пунктах). Любые границы, установленные пользователем, игнорируются. Это свойство доступно только после того, как был вызван метод PrintJob.start().

Примечание. В AIR 2 и более поздних версиях это свойство игнорируется. Используйте вместо него свойство printableArea, которое измеряет область печати в дробных пунктах и точно описывает области печати, смещенные относительно центра.

Связанные элементы API

Ширина самой большой области, которую можно расположить по центру фактической области печати на странице (в пунктах). Любые границы, установленные пользователем, игнорируются. Это свойство доступно только после того, как был вызван метод PrintJob.start().

Примечание. В AIR 2 и более поздних версиях это свойство игнорируется. Используйте вместо него свойство printableArea, которое измеряет область печати в дробных пунктах и точно описывает области печати, смещенные относительно центра.

Связанные элементы API

Границы материала для печати в принтере, в пунктах. Это значение использует ту же систему координат, что и в последующих вызовах метода addPage().

Общая высота бумаги (в пунктах). Это свойство доступно только после того, как был вызван метод PrintJob.start().

Примечание. В AIR 2 и более поздних версиях это свойство игнорируется. Вместо него используйте свойство paperArea, которое измеряет размеры бумаги в дробных пунктах.

Связанные элементы API

Общая ширина бумаги (в пунктах). Это свойство доступно только после того, как был вызван метод PrintJob.start().

Примечание. В AIR 2 и более поздних версиях это свойство игнорируется. Вместо него используйте свойство paperArea, которое измеряет размеры бумаги в дробных пунктах.

Связанные элементы API

Границы области печати материала в принтере, в пунктах. Это значение использует ту же систему координат, что и в последующих вызовах метода addPage().

Получает или задает принтер для выполнения текущего задания печати. Объект String, передаваемый установщику получателем, должен соответствовать одной из строк в объекте Array, возращенном методом printers(). Чтобы указать, что необходимо использовать принтер по умолчанию, задайте этому свойству значение null. В операционных системах, где невозможно определить принтер по умолчанию, это свойство имеет значение null.

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

Когда задается значение для этого свойства, предпринимается попытка немедленно выбрать принтер. Если выбрать принтер не удается, используется предыдущее значение этого свойства. Чтобы узнать, удалось ли задать значение принтера, проверьте значение свойства после попытки установить его и убедитесь, соответствует ли оно заданному значению.

Свойство printer активного задания печати изменить нельзя. Попытки изменить свойство после успешного вызова метода start() или start2() и перед вызовом метода send() или terminate() не дают результатов.

Предоставляет список доступных принтеров в виде строковых значений имен. Список не вычисляется предварительно, он генерируется в момент вызова функции. Если нет доступных принтеров или система не поддерживает печать, используется значение null. Если система поддерживает печать, но не может вернуть список принтеров, в качестве значения используется объект Vector с одним элементом (его свойство length имеет значение 1). В этом случае единственный элемент содержит действительное имя принтера, либо имя по умолчанию, если невозможно определить имя текущего принтера.

Указывает, поддерживает ли текущая среда выполнения Flash отображение отдельного диалогового окна «Параметры страницы». Если это свойство имеет значение true, можно вызвать метод showPageSetupDialog(), чтобы вывести системное диалоговое окно «Параметры страницы».

Связанные элементы API

Создает объект PrintJob, который можно использовать для печати одной или нескольких страниц. После создания объекта PrintJob для отправки задания печати на принтер необходимо использовать (в указанном порядке) методы PrintJob.start(), PrintJob.addPage(), а затем PrintJob.send().

Например, можно заменить текст-заполнитель [params] для вызовов метода myPrintJob.addPage() пользовательскими параметрами, как показано в следующем коде.

 // 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 нельзя создавать второй объект PrintJob, пока активен первый. Если второй объект PrintJob создается (вызовом метода new PrintJob()), когда активен первый объект PrintJob, второй объект создан не будет. Поэтому можно проверить значение myPrintJob, прежде чем создавать второй объект PrintJob.

Связанные элементы API

Отправляет заданный объект Sprite в диспетчер очереди печати принтера в виде одной страницы. Перед использованием этого метода необходимо создать объект PrintJob, а затем применить метод start() или start2(). Затем, после вызова метода addPage() один или несколько раз для задания печати, используйте метод send() для передачи страниц в диспетчере очереди печати на принтер. Другими словами, после создания объекта PrintJob для отправки задания печати на принтер необходимо использовать (в указанном порядке) методы start(), addPage(), а затем send(). Метод addPage() можно вызывать несколько раз после вызова метода start(), чтобы напечатать несколько страниц в задании печати.

Если метод addPage() вызывает исключение в проигрывателе Flash Player (например, если не вызван метод start() или пользователь отменил задание печати), любой последующий вызов addPage() завершится ошибкой. Однако, если предыдущие вызовы метода addPage() были успешными, завершающая команда send() отправляет на принтер страницы, успешно помещенные в очередь диспетчера печати.

Если заданию печати требуется более 15 секунд для выполнения операции addPage(), то проигрыватель Flash Player вызовет исключение при следующем вызове метода addPage().

Если передается значение для параметра printArea, то в качестве координат x и y прямоугольника printArea задается верхний левый угол (координаты 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 x 50 пикселей, распечатывается 2500 пикселей. Если объект Sprite масштабируется, распечатываются те же 2500 пикселей, но объект Sprite при этом печатается в отмасштабированном размере.

Функция печати в проигрывателе Flash Player может работать с поддерживающими и не поддерживающими 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() успешно выполняется (пользователь нажимает кнопку «ОК» в диалоговом окне «Печать»), то следующие свойства заполняются значениями, соответствующими параметрам печати, установленным пользователем.

Примечание. Если пользователь закрывает диалоговое окно «Печать», эти свойства не заполняются.

После того как пользователь нажмет кнопку «ОК» в диалоговом окне «Печать», проигрыватель начинает отправлять задание печати в очередь диспетчера печати операционной системы. Поскольку операционная система затем начинает отображать пользователю информацию о выполнении печати, необходимо как можно быстрее вызвать методы PrintJob.addPage() и PrintJob.send(), чтобы отправить страницы в диспетчер очереди печати. Можно использовать доступные только для чтения свойства высоты, ширины и ориентации страницы, которые этот метод подставляет при форматировании печатаемой страницы.

Проверьте, возвращает ли метод значение true (если пользователь нажмет кнопку «ОК» в диалоговом окне «Печать» операционной системы) перед последующим вызовом одного из методов PrintJob.addPage() и PrintJob.send():

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

Для заданного экземпляра задания печати, если какой-либо из следующих интервалов длится дольше 15 секунд, при следующем вызове PrintJob.start() будет возвращаться значение false:

• между PrintJob.start() и первымPrintJob.addPage()
• между 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. Объявляются две переменные типа Sprite с названиями sheet1 и sheet2.
2. Вызывается метод init(), который назначает новый экземпляр Sprite обеим переменным sheet1 и sheet2, а затем вызывается метод createSheet().
3. Метод createSheet() выполняет следующие действия:
   1. Передаваемый объект Sprite используется для создания прямоугольника со светло-серой заливкой, черной рамкой толщиной в один пиксель, шириной в 100 пикселей и высотой в 200 пикселей, с координатами x = 0, y = 0.
   2. Создается новый объект TextField с именем txt и такими же размерами, что и объект Sprite, для свойства wordWrap устанавливается значение true, а для текстового свойства в качестве аргумента для createSheet() устанавливается «Строка передана».
   3. Если определено значение для переданного аргумента объекта, создайте новый экземпляр Sprite с именем img, который используется для отображения белого прямоугольника, используя свойства координат и размеров переданного объекта. Этот белый прямоугольник добавляется к списку отображения объекта Sprite с помощью метода addChild().
   4. Объект TextField с названием txt добавляется к списку отображения объекта Sprite с помощью метода addChild().
4. Выполняется обратный переход в конструктор, а затем вызывается разрешенный (незакомментированный) метод печати. Поскольку методы очень похожи, далее описан только один из них printOnePerPage().
5. Метод printOnePerPage() выполняет следующие действия:
   1. Объявляется новый объект PrintJob с именем pj и pagesToPrint в качестве объекта uint.
   2. Открывается предусмотренное в операционной системе диалоговое окно «Печать», выполняется ожидание, пока пользователь не нажмет кнопку «OK».
   3. Проверяется ориентация, и если выбрана альбомная ориентация, выдается сообщение об ошибке и выполнение операции завершается.
   4. Настраивается высота и ширина страницы для sheet1 и sheet2.
   5. Объекты sheet1 и sheet2 отправляются в диспетчер очереди печати принтера с помощью метода addPage().
   6. Если число страниц для печати больше нуля, выполняется печать всех помещенных в очередь печати страниц.
6. Метод draw() вызывается, когда необходимо изменить размеры двух объектов Sprite для размещения на монтажном столе или изменения положения sheet2, например, поместив его справа от sheet1.

Примечание. Конструктор настроен таким образом, что можно выбрать один из трех методов печати (печать одной страницы на лист, двух страниц на лист или печать в верхней половине листа) в зависимости от предпочтения. Этот пример не будет работать правильно до тех пор, пока два метода печати не будут отключены с помощью комментариев в программном коде. Пример настроен таким образом, что будет вызываться метод 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;
        }        
    }
}