javax.print

Интерфейсный PrintService

Все Известные Подынтерфейсы:

MultiDocPrintService

Все Известные Классы с реализацией:

StreamPrintService

public interface PrintService

Интерфейсный PrintService является фабрикой для DocPrintJob. PrintService описывает возможности Принтера и может быть запрошен относительно поддерживаемых атрибутов принтера.

Пример:

   DocFlavor flavor = DocFlavor.INPUT_STREAM.POSTSCRIPT;
   PrintRequestAttributeSet aset = new HashPrintRequestAttributeSet();
   aset.add(MediaSizeName.ISO_A4);
   PrintService[] pservices =
                 PrintServiceLookup.lookupPrintServices(flavor, aset);
   if (pservices.length > 0) {
       DocPrintJob pj = pservices[0].createPrintJob();
       try {
           FileInputStream fis = new FileInputStream("test.ps");
           Doc doc = new SimpleDoc(fis, flavor, null);
           pj.print(doc, aset);
        } catch (FileNotFoundException fe) {
        } catch (PrintException e) {
        }
   }
   

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
void	addPrintServiceAttributeListener(PrintServiceAttributeListener listener) Регистрирует слушателя для событий на этом PrintService.
DocPrintJob	createPrintJob() Создает и возвращает PrintJob, способный к обработке данных от любой из поддерживаемых разновидностей документа.
boolean	equals(Object obj) Определяет, обращаются ли две службы к той же самой базовой службе.
<T extends PrintServiceAttribute> T	getAttribute(Class<T> category) Получает значение единственного указанного атрибута службы.
PrintServiceAttributeSet	getAttributes() Получает набор этой службы печати предоставления атрибутов описания принтера состояния этой Службы печати.
Объект	getDefaultAttributeValue(Class<? extends Attribute> category) Определяет печать этой службы печати по умолчанию значения атрибута в данной категории.
Строка	getName() Возвращает Имя строки для этой службы печати, которая может использоваться приложениями, чтобы запросить определенную службу печати.
ServiceUIFactory	getServiceUIFactory() Возвращает фабрику для компонентов UI, которые позволяют пользователям взаимодействовать со службой в различных ролях.
Class<?>[]	getSupportedAttributeCategories() Определяет категории атрибута печати, которые клиент может определить, устанавливая задание для этой службы печати.
Объект	getSupportedAttributeValues(Class<? extends Attribute> category, DocFlavor flavor, AttributeSet attributes) Определяет значения атрибута печати, которые клиент может определить в данной категории, устанавливая задание для этой службы печати.
DocFlavor[]	getSupportedDocFlavors() Определяет форматы данных печати, которые клиент может определить, устанавливая задание для этого PrintService.
AttributeSet	getUnsupportedAttributes(DocFlavor flavor, AttributeSet attributes) Идентифицирует атрибуты, которые неподдерживаются для запроса печати в контексте определенного DocFlavor.
int	hashCode() Этот метод должен последовательно реализовываться с equals(Object).
boolean	isAttributeCategorySupported(Class<? extends Attribute> category) Определяет, может ли клиент определить данную печать категории атрибута, устанавливая задание для этой службы печати.
boolean	isAttributeValueSupported(Attribute attrval, DocFlavor flavor, AttributeSet attributes) Определяет, может ли клиент определить данную печать значения атрибута, устанавливая задание для этой Службы печати.
boolean	isDocFlavorSupported(DocFlavor flavor) Определяет, поддерживает ли эта служба печати определенное DocFlavor.
void	removePrintServiceAttributeListener(PrintServiceAttributeListener listener) Удаляет слушателя службы печати из этой службы печати.

Деталь метода

getName

String getName()

Возвращает Имя строки для этой службы печати, которая может использоваться приложениями, чтобы запросить определенную службу печати. В подходящем контексте, таком как служба имен, это имя должно быть уникальным. В некоторых средах это уникальное имя может быть тем же самым как удобным для пользователя именем принтера, определенным как PrinterName атрибут.

Возвраты:

имя службы.

createPrintJob

DocPrintJob createPrintJob()

Создает и возвращает PrintJob, способный к обработке данных от любой из поддерживаемых разновидностей документа.

Возвраты:

объект DocPrintJob

addPrintServiceAttributeListener

void addPrintServiceAttributeListener(PrintServiceAttributeListener listener)

Регистрирует слушателя для событий на этом PrintService.

Параметры:

listener - PrintServiceAttributeListener, который контролирует состояние службы печати

См. Также:

removePrintServiceAttributeListener(javax.print.event.PrintServiceAttributeListener)

removePrintServiceAttributeListener

void removePrintServiceAttributeListener(PrintServiceAttributeListener listener)

Удаляет слушателя службы печати из этой службы печати. Это означает, что слушатель больше не интересуется PrintService события.

Параметры:

listener - объект PrintServiceAttributeListener

См. Также:

addPrintServiceAttributeListener(javax.print.event.PrintServiceAttributeListener)

getAttributes

PrintServiceAttributeSet getAttributes()

Получает набор этой службы печати предоставления атрибутов описания принтера состояния этой Службы печати. Возвращенный объект набора атрибута является неподдающимся изменению. Возвращенный объект набора атрибута является "снимком" набора атрибута этой Службы печати во время getAttributes() вызов метода: то есть, возвращенное содержание набора атрибута не будет обновлено, если содержание набора атрибута этой службы печати изменится в будущем. Чтобы обнаружить изменения в значениях атрибута, вызвать getAttributes() снова и сравните новый набор атрибута с предыдущим набором атрибута; альтернативно, зарегистрируйте слушателя для событий службы печати.

Возвраты:

Неподдающийся изменению снимок атрибута этой Службы печати устанавливается. Может быть пустым, но не нулевым.

getAttribute

<T extends PrintServiceAttribute> T getAttribute(Class<T> category)

Получает значение единственного указанного атрибута службы. Это может быть полезно для клиентов, которые только нуждаются в значении одного атрибута и хотят минимизировать издержки.

Параметры:

category - категория PrintServiceAttribute, поддерживаемого этой службой - возможно, не нуль.

Возвраты:

значение поддерживаемого атрибута или нуля, если атрибут не поддерживается этой службой.

Броски:

NullPointerException - если категория является нулем.

IllegalArgumentException - (исключение непроверенное), если category не a Class это реализует интерфейс PrintServiceAttribute.

getSupportedDocFlavors

DocFlavor[] getSupportedDocFlavors()

Определяет форматы данных печати, которые клиент может определить, устанавливая задание для этого PrintService. Формат данных печати определяется "разновидностью документа" (класс DocFlavor) состоя из MIME вводит плюс класс представления данных печати.

Отметьте, что некоторые разновидности документа не могут поддерживаться в комбинации со всеми атрибутами. Использовать getUnsupportedAttributes(..) проверить определенных комбинаций.

Возвраты:

Массив поддерживаемых разновидностей документа, должен иметь по крайней мере один элемент.

isDocFlavorSupported

boolean isDocFlavorSupported(DocFlavor flavor)

Определяет, поддерживает ли эта служба печати определенное DocFlavor. Это - метод удобства, чтобы определить если DocFlavor был бы элемент результата getSupportedDocFlavors().

Отметьте, что некоторые разновидности документа не могут поддерживаться в комбинации со всеми атрибутами. Использовать getUnsupportedAttributes(..) проверить определенных комбинаций.

Параметры:

flavor - DocFlavorзапрашивать для поддержки.

Возвраты:

true если эта служба печати поддерживает указанное DocFlavor; false иначе.

Броски:

NullPointerException - (исключение непроверенное) Брошенный, если flavor нуль.

getSupportedAttributeCategories

Class<?>[] getSupportedAttributeCategories()

Определяет категории атрибута печати, которые клиент может определить, устанавливая задание для этой службы печати. Категория атрибута печати определяется a Class это реализует интерфейс Attribute. Этот метод возвращает только категории атрибута, которые поддерживаются; это не возвращает определенные значения атрибута, которые поддерживаются.

Этот метод возвращает все категории атрибута печати, которые эта служба печати поддерживает для любого возможного задания. Некоторые категории не могут поддерживаться в определенном контексте (то есть для детали DocFlavor). Используйте один из методов, которые включают a DocFlavor проверить запроса прежде, чем представить это, такой как getSupportedAttributeValues(..).

Возвраты:

Массив печати категорий атрибута, которые клиент может определить как атрибут на уровне задания или на уровне документа в Запросе Печати. Каждый элемент в массиве является a Class это реализует интерфейс Attribute. Массив пуст, если никакие категории не поддерживаются.

isAttributeCategorySupported

boolean isAttributeCategorySupported(Class<? extends Attribute> category)

Определяет, может ли клиент определить данную печать категории атрибута, устанавливая задание для этой службы печати. Категория атрибута печати определяется a Class это реализует интерфейс Attribute. Этот метод говорит, поддерживается ли категория атрибута; это не говорит, поддерживается ли определенное значение атрибута.

Некоторые категории не могут поддерживаться в определенном контексте (то есть для детали DocFlavor). Используйте один из методов, которые включают a DocFlavor проверить запроса прежде, чем представить это, такой как getSupportedAttributeValues(..).

Это - метод удобства, чтобы определить, была ли бы категория элементом результата getSupportedAttributeCategories().

Параметры:

category - Печать категории атрибута, чтобы протестировать. Это должен быть a Class это реализует интерфейс Attribute.

Возвраты:

true если эта служба печати поддерживает определение атрибута на уровне задания или на уровне документа в category в Запросе Печати; false если это не делает.

Броски:

NullPointerException - (исключение непроверенное) Брошенный, если category нуль.

IllegalArgumentException - (исключение непроверенное) Брошенный, если category не a Class это реализует интерфейс Attribute.

getDefaultAttributeValue

Object getDefaultAttributeValue(Class<? extends Attribute> category)

Определяет печать этой службы печати по умолчанию значения атрибута в данной категории. Значение атрибута печати является экземпляром класса, который реализует интерфейс Attribute. Если клиент установит задание печати и не определит значения атрибута в данной категории, то эта Служба печати будет использовать значение атрибута по умолчанию вместо этого.

Некоторые атрибуты не могут поддерживаться в определенном контексте (то есть для детали DocFlavor). Используйте один из методов, которые включают a DocFlavor проверить запроса прежде, чем представить это, такой как getSupportedAttributeValues(..).

Не у всех атрибутов есть значение по умолчанию. Например у службы не будет defaultvalue для RequestingUser то есть нулевой возврат для поддерживаемой категории означает, что нет никакого значения по умолчанию службы для той категории. Используйте isAttributeCategorySupported(Class) метод, чтобы отличить эти случаи.

Параметры:

category - Печать категории атрибута, на которую требуют значение атрибута по умолчанию. Это должен быть a Class это реализует интерфейс Attribute.

Возвраты:

Значение атрибута по умолчанию для category, или нуль, если эта Служба печати не поддерживает определение атрибута на уровне задания или на уровне документа в category в Запросе Печати, или службе не имеет значения по умолчанию для этого атрибута.

Броски:

NullPointerException - (исключение непроверенное) Брошенный, если category нуль.

IllegalArgumentException - (исключение непроверенное) Брошенный, если category не a Class это реализует интерфейс Attribute.

getSupportedAttributeValues

Object getSupportedAttributeValues(Class<? extends Attribute> category,
                                 DocFlavor flavor,
                                 AttributeSet attributes)

Определяет значения атрибута печати, которые клиент может определить в данной категории, устанавливая задание для этой службы печати. Значение атрибута печати является экземпляром класса, который реализует интерфейс Attribute.

Если flavor нуль и attributes нуль или пустое множество, этот метод возвращает все значения атрибута печати, которые эта Служба печати поддерживает для любого возможного задания. Если flavor не нуль или attributes не пустое множество, этот метод возвращает только значения атрибута печати, которые являются совместимыми с данной разновидностью документа и/или набором атрибутов. Таким образом, нулевое возвращаемое значение может указать, что определение этого атрибута является несовместимым с указанным DocFlavor. Также, если DocFlavor не является нулем, это должна быть разновидность, поддерживаемая этим PrintService, еще IllegalArgumentException будет брошен.

Если attributes параметр содержит Атрибут, категория которого является тем же самым как category параметр, служба должна проигнорировать этот атрибут в AttributeSet.

DocAttributes, которые должны быть определены на Doc должен быть включен в этот набор, чтобы точно представить контекст.

Этот метод возвращает Объект, потому что различные категории атрибута печати указывают на поддерживаемые значения атрибута по-разному. Документация для каждой печати приписывает в пакете javax.print.attribute.standard описывает, как каждый атрибут указывает на свои поддерживаемые значения. Возможные способы указать на поддержку включают:

• Возвратите единственный экземпляр категории атрибута, чтобы указать, что любое значение является законным - используемый, например, атрибутом, значение которого является произвольной текстовой строкой. (Значение возвращенного объекта атрибута не важно.)
• Возвратите массив одного или более экземпляров категории атрибута, содержа юридические значения - используемый, например, атрибутом со списком перечисляемых значений. Тип массива является массивом указанного типа категории атрибута как возвращено getCategory(Class).
• Возвратите единственный объект (некоторого класса кроме категории атрибута), который указывает на границы на юридических значениях - используемый, например, оцененным целому числу атрибутом, который должен лечь в пределах определенного диапазона.

Параметры:

category - Печать категории атрибута, чтобы протестировать. Это должен быть a Class это реализует интерфейс Attribute.

flavor - Разновидность документа для воображаемого задания, или нуль.

attributes - Набор печати атрибутов для воображаемого задания (и атрибуты на уровне задания и атрибуты на уровне документа), или нуль.

Возвраты:

Объект, указывающий на поддерживаемые значения для category, или нуль, если эта Служба печати не поддерживает определение атрибута на уровне задания или на уровне документа в category в Запросе Печати.

Броски:

NullPointerException - (исключение непроверенное) Брошенный, если category нуль.

IllegalArgumentException - (исключение непроверенное) Брошенный, если category не a Class это реализует интерфейс Attribute, или DocFlavor не поддерживается этой службой.

isAttributeValueSupported

boolean isAttributeValueSupported(Attribute attrval,
                                DocFlavor flavor,
                                AttributeSet attributes)

Определяет, может ли клиент определить данную печать значения атрибута, устанавливая задание для этой Службы печати. Значение атрибута печати является экземпляром класса, который реализует интерфейс Attribute.

Если flavor нуль и attributes нуль или пустое множество, этот метод говорит, поддерживает ли эта Служба печати данную печать значения атрибута для некоторой возможной комбинации разновидности документа и набора атрибутов. Если flavor не нуль или attributes не пустое множество, этот метод говорит, поддерживает ли эта Служба печати данную печать значения атрибута в комбинации с данной разновидностью документа и/или набором атрибутов.

Также, если DocFlavor не является нулем, это должна быть разновидность, поддерживаемая этим PrintService, еще IllegalArgumentException будет брошен.

DocAttributes, которые должны быть определены на Doc должен быть включен в этот набор, чтобы точно представить контекст.

Это - метод удобства, чтобы определить, было ли бы значение элементом результата getSupportedAttributeValues(...).

Параметры:

attrval - Печать значения атрибута, чтобы протестировать.

flavor - Разновидность документа для воображаемого задания, или нуль.

attributes - Набор печати атрибутов для воображаемого задания (и атрибуты на уровне задания и атрибуты на уровне документа), или нуль.

Возвраты:

Истина, если эта Служба печати поддерживает определение attrval как атрибут на уровне задания или на уровне документа в Запросе Печати, ложь, если это не делает.

Броски:

NullPointerException - (исключение непроверенное), если attrval нуль.

IllegalArgumentException - если разновидность не поддерживается этим PrintService.

getUnsupportedAttributes

AttributeSet getUnsupportedAttributes(DocFlavor flavor,
                                    AttributeSet attributes)

Идентифицирует атрибуты, которые неподдерживаются для запроса печати в контексте определенного DocFlavor. Этот метод полезен для того, чтобы проверил потенциального задания печати и идентифицировал определенные атрибуты, которые не могут поддерживаться. Важно предоставить только поддерживаемый DocFlavor, или IllegalArgumentException будет брошен. Если возвращаемое значение от этого метода является нулем, все атрибуты поддерживаются.

DocAttributes, которые должны быть определены на Doc должен быть включен в этот набор, чтобы точно представить контекст.

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

Поддерживаемый запрос печати может тогда быть создан, удаляя все неподдерживаемые атрибуты из исходного набора атрибута, кроме в случае, что DocFlavor неподдерживается.

Если какие-либо атрибуты неподдерживаются только потому, что они находятся в конфликте с другими атрибутами тогда, это на усмотрение службы, чтобы выбрать атрибут (ы), который будет идентифицирован как причина конфликта.

Использовать isDocFlavorSupported() проверять, что DocFlavor поддерживается прежде, чем вызвать этот метод.

Параметры:

flavor - Разновидность документа, чтобы протестировать, или обнулить

attributes - Набор печати атрибутов для воображаемого задания (и атрибуты на уровне задания и атрибуты на уровне документа), или нуль.

Возвраты:

нуль, если эта Служба печати поддерживает спецификацию запроса печати, еще неподдерживаемые атрибуты.

Броски:

IllegalArgumentException - еслиflavor не поддерживается этим PrintService.

getServiceUIFactory

ServiceUIFactory getServiceUIFactory()

Возвращает фабрику для компонентов UI, которые позволяют пользователям взаимодействовать со службой в различных ролях. Службы, которые не обеспечивают UI, должны возвратить нуль. Службы печати, которые действительно обеспечивают UI, но хотят поддерживаться в среде без поддержки UI, должны гарантировать, что фабрика не инициализируется, если приложение не вызывает этот метод, чтобы получить фабрику. См. ServiceUIFactory для получения дополнительной информации.

Возвраты:

нуль или фабрика для компонентов UI.

равняется

boolean equals(Object obj)

Определяет, обращаются ли две службы к той же самой базовой службе. Объекты, инкапсулирующие службу печати, возможно, не показывают равенство ссылки даже при том, что они обращаются к той же самой базовой службе.

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

Службы должны реализовать этот метод и возвратить true, только если сравниваемые объекты службы могут использоваться взаимозаменяемо клиентом. Службы свободны возвратить ту же самую ссылку на объект на базовую службу, если это, но клиенты не должно зависеть от равенства ссылки.

Переопределения:

equals в классе Object

Параметры:

obj - ссылочный объект, с которым можно сравниться.

Возвраты:

истина, если эта служба является тем же самым как obj параметром, ложь иначе.

См. Также:

Object.hashCode(), HashMap

хэш-код

int hashCode()

Этот метод должен последовательно реализовываться с equals(Object).

Переопределения:

hashCode в классе Object

Возвраты:

хэш-код этого объекта.

См. Также:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)