java.awt
类 JobAttributes

java.lang.Object
  java.awt.JobAttributes

所有已实现的接口：

Cloneable

public final class JobAttributes
extends Object
implements Cloneable

控制打印作业的属性集合。

此类的实例控制份数、默认选择、目标、打印对话框、文件和打印机名称、页面范围、多文档处理（包括整理）和使用此实例的每个打印作业的多页整版（如双面）。在可能的地方属性名遵守 Internet Printing Protocol (IPP) 1.1。在可能的地方属性值部分地遵守 Internet Printing Protocol (IPP) 1.1。

要使用采用内部类类型的方法，需要将引用传递给内部类的常量字段之一。客户端代码无法创建内部类类型的新实例，因为这些类都不具有公共构造方法。例如，将打印对话框类型设置为跨平台的纯 Java 打印对话框，使用以下代码：

 import java.awt.JobAttributes;

 public class PureJavaPrintDialogExample {
     public void setPureJavaPrintDialog(JobAttributes jobAttributes) {
         jobAttributes.setDialog(JobAttributes.DialogType.COMMON);
     }
 }
 

每个支持 attributeName（默认值）的 IPP 属性都具有相应的 setattributeNameToDefault 方法。未提供默认值字段。

嵌套类摘要

static class	JobAttributes.DefaultSelectionType 可能的默认选择状态的类型安全的枚举。
static class	JobAttributes.DestinationType 可能的作业目标的类型安全枚举。
static class	JobAttributes.DialogType 显示给用户的可能对话框的类型安全枚举。
static class	JobAttributes.MultipleDocumentHandlingType 可能的多副本处理状态的类型安全枚举。
static class	JobAttributes.SidesType 可能的多页整版的类型安全枚举。

构造方法摘要

JobAttributes()
构造一个具有每个属性的默认值的 JobAttributes 实例。

JobAttributes(int copies, JobAttributes.DefaultSelectionType defaultSelection, JobAttributes.DestinationType destination, JobAttributes.DialogType dialog, String fileName, int maxPage, int minPage, JobAttributes.MultipleDocumentHandlingType multipleDocumentHandling, int[][] pageRanges, String printer, JobAttributes.SidesType sides)
构造一个具有每个属性指定值的 JobAttributes 实例。

JobAttributes(JobAttributes obj)
构造一个 JobAttributes 实例，作为所提供的 JobAttributes 的副本。

方法摘要

Object	clone() 创建并返回此 JobAttributes 的一个副本。
boolean	equals(Object obj) 确定两个 JobAttributes 是否相等。
int	getCopies() 返回应用程序应该使用这些属性呈现作业的份数。
JobAttributes.DefaultSelectionType	getDefaultSelection() 指定应用程序应该为使用这些属性的作业打印所有页面，即 getPageRanges 的返回值所指定范围的页面，还是打印当前选择的页面。
JobAttributes.DestinationType	getDestination() 指定将输出到打印机还是使用这些属性的作业文件。
JobAttributes.DialogType	getDialog() 返回对于使用这些属性的作业，用户是否应该看到用于修改打印设置的打印对话框，以及显示哪种类型的打印对话框。
String	getFileName() 指定使用这些属性的作业的输出文件的文件名。
int	getFromPage() 对于使用这些属性的作业，如果要打印某个范围的页面，则返回要打印的第一页。
int	getMaxPage() 指定对于使用这些属性的作业，用户可以指定为要打印的最后一页的最大值。
int	getMinPage() 指定对于使用这些属性的作业，用户可以指定为要打印的第一页的最小值。
JobAttributes.MultipleDocumentHandlingType	getMultipleDocumentHandling() 为使用这些属性的作业指定多份处理，包括整理。
int[][]	getPageRanges() 对于使用这些属性的作业，如果要打印某个范围的页面，则指定要打印的页面范围。
String	getPrinter() 为使用这些属性的作业返回目标打印机。
JobAttributes.SidesType	getSides() 返回对于使用这些属性的作业，如何在打印介质的面上强制应用连续页。
int	getToPage() 对于使用这些属性的作业，如果要打印某个范围的页面，则返回要打印的最后一页（包括该页）。
int	hashCode() 返回此 JobAttributes 的哈希码值。
void	set(JobAttributes obj) 将此 JobAttributes 的所有属性设置为与 obj 的属性相同的值。
void	setCopies(int copies) 指定应用程序应该使用这些属性呈现作业的份数。
void	setCopiesToDefault() 将应用程序应该使用这些属性呈现作业的份数设置为默认值。
void	setDefaultSelection(JobAttributes.DefaultSelectionType defaultSelection) 指定应用程序应该为使用这些属性的作业打印所有页面，即 getPageRanges 的返回值所指定范围的页面，还是打印当前选择的页面。
void	setDestination(JobAttributes.DestinationType destination) 指定将输出到打印机还是使用这些属性的作业文件。
void	setDialog(JobAttributes.DialogType dialog) 指定对于使用这些属性的作业，用户是否应该看到用于修改打印设置的打印对话框，以及显示哪种类型的打印对话框。
void	setFileName(String fileName) 指定使用这些属性的作业的输出文件的文件名。
void	setFromPage(int fromPage) 对于使用这些属性的作业，如果要打印某个范围的页面，则指定要打印的第一页。
void	setMaxPage(int maxPage) 指定对于使用这些属性的作业，用户可以指定为要打印的最后一页的最大值。
void	setMinPage(int minPage) 指定对于使用这些属性的作业，用户可以指定为要打印的第一页的最小值。
void	setMultipleDocumentHandling(JobAttributes.MultipleDocumentHandlingType multipleDocumentHandling) 为使用这些属性的作业指定多份处理，包括整理。
void	setMultipleDocumentHandlingToDefault() 对于使用这些属性的作业，将多份处理（包括整理）设置为默认值。
void	setPageRanges(int[][] pageRanges) 对于使用这些属性的作业，如果要打印某个范围的页面，则指定要打印的页面范围。
void	setPrinter(String printer) 为使用这些属性的作业指定目标打印机。
void	setSides(JobAttributes.SidesType sides) 指定对于使用这些属性的作业，如何在打印介质的面上强制应用连续页。
void	setSidesToDefault() 对于使用这些属性的作业，将如何在打印介质的面上强制应用连续页设置为默认值。
void	setToPage(int toPage) 对于使用这些属性的作业，如果要打印某个范围的页面，则指定要打印的最后一页（包括该页）。
String	toString() 返回此 JobAttributes 的字符串表示形式。

从类 java.lang.Object 继承的方法

finalize, getClass, notify, notifyAll, wait, wait, wait

构造方法详细信息

JobAttributes

public JobAttributes()

构造一个具有每个属性的默认值的 JobAttributes 实例。对话框默认为 DialogType.NATIVE。最小页默认为 1。最大页默认为 Integer.MAX_VALUE。目标默认为 DestinationType.PRINTER。选择默认为 DefaultSelectionType.ALL。份数默认为 1。多文档处理默认为 MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES。面默认为 SidesType.ONE_SIDED。文件名默认为 null。

JobAttributes

public JobAttributes(JobAttributes obj)

构造一个 JobAttributes 实例，作为所提供的 JobAttributes 的副本。

参数：

obj - 要复制的 JobAttributes

JobAttributes

public JobAttributes(int copies,
                     JobAttributes.DefaultSelectionType defaultSelection,
                     JobAttributes.DestinationType destination,
                     JobAttributes.DialogType dialog,
                     String fileName,
                     int maxPage,
                     int minPage,
                     JobAttributes.MultipleDocumentHandlingType multipleDocumentHandling,
                     int[][] pageRanges,
                     String printer,
                     JobAttributes.SidesType sides)

构造一个具有每个属性指定值的 JobAttributes 实例。

参数：

copies - 复制一个大于 0 的整数

defaultSelection - DefaultSelectionType.ALL、DefaultSelectionType.RANGE 和 DefaultSelectionType.SELECTION

destination - DesintationType.FILE 或 DesintationType.PRINTER

dialog - DialogType.COMMON、DialogType.NATIVE 或 DialogType.NONE

fileName - 可能为 null 文件名

maxPage - 大于零且大于或等于 minPage 的整数

minPage - 大于零且小于或等于 maxPage 的整数

multipleDocumentHandling - MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES 或 MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES

pageRanges - 两个元素的整数数组的数组；数组的范围被解释为包括两个指定页面以及它们之间的所有页面；范围必须为升序并且一定不能重叠；指定的页码既不能小于 minPage 也不能大于 maxPage；例如：

                (new int[][] { new int[] { 1, 3 }, new int[] { 5, 5 },
                               new int[] { 15, 19 } }),
          

指定页面 1、2、3、5、15、16、17、18 和 19。注意，(new int[][] { new int[] { 1, 1 }, new int[] { 1, 2 } }) 是一种无效的页面范围设置，因为两个范围重叠

printer - 可能为 null 打印机名称

sides - SidesType.ONE_SIDED、SidesType.TWO_SIDED_LONG_EDGE 或 SidesType.TWO_SIDED_SHORT_EDGE

抛出：

IllegalArgumentException - 如果违反了一个或多个上述条件

方法详细信息

clone

public Object clone()

创建并返回此 JobAttributes 的一个副本。

覆盖：

类 Object 中的 clone

返回：

新创建的副本；可以安全地将此 Object 强制转换为 JobAttributes

另请参见：

Cloneable

set

public void set(JobAttributes obj)

将此 JobAttributes 的所有属性设置为与 obj 的属性相同的值。

参数：

obj - 要复制的 JobAttributes

getCopies

public int getCopies()

返回应用程序应该使用这些属性呈现作业的份数。将此属性更新为用户选择的值。

返回：

大于 0 的整数。

setCopies

public void setCopies(int copies)

指定应用程序应该使用这些属性呈现作业的份数。不指定此属性等效于指定 1。

参数：

copies - 复制一个大于 0 的整数

抛出：

IllegalArgumentException - 如果 copies 小于或等于 0

setCopiesToDefault

public void setCopiesToDefault()

将应用程序应该使用这些属性呈现作业的份数设置为默认值。默认份数为 1。

getDefaultSelection

public JobAttributes.DefaultSelectionType getDefaultSelection()

指定应用程序应该为使用这些属性的作业打印所有页面，即 getPageRanges 的返回值所指定范围的页面，还是打印当前选择的页面。将此属性更新为用户选择的值。

返回：

DefaultSelectionType.ALL、DefaultSelectionType.RANGE 或 DefaultSelectionType.SELECTION

setDefaultSelection

public void setDefaultSelection(JobAttributes.DefaultSelectionType defaultSelection)

指定应用程序应该为使用这些属性的作业打印所有页面，即 getPageRanges 的返回值所指定范围的页面，还是打印当前选择的页面。不指定此属性等效于指定 DefaultSelectionType.ALL。

参数：

defaultSelection - DefaultSelectionType.ALL、DefaultSelectionType.RANGE 或 DefaultSelectionType.SELECTION。

抛出：

IllegalArgumentException - 如果 defaultSelection 为 null

getDestination

public JobAttributes.DestinationType getDestination()

指定将输出到打印机还是使用这些属性的作业文件。将此属性更新为用户选择的值。

返回：

DesintationType.FILE 或 DesintationType.PRINTER

setDestination

public void setDestination(JobAttributes.DestinationType destination)

指定将输出到打印机还是使用这些属性的作业文件。不指定此属性等效于指定 DesintationType.PRINTER。

参数：

destination - DesintationType.FILE 或 DesintationType.PRINTER。

抛出：

IllegalArgumentException - 如果目标为 null。

getDialog

public JobAttributes.DialogType getDialog()

返回对于使用这些属性的作业，用户是否应该看到用于修改打印设置的打印对话框，以及显示哪种类型的打印对话框。DialogType.COMMON 表示跨平台的纯 Java 打印对话框。DialogType.NATIVE 表示平台的本机打印对话框。如果平台不支持本机打印对话框，则显示纯 Java 打印对话框。DialogType.NONE 指定无打印对话框（即后台打印）。任何实现或目标打印机都不能修改此属性，也不能对其加以限制。

返回：

DialogType.COMMON、DialogType.NATIVE 或 DialogType.NONE

setDialog

public void setDialog(JobAttributes.DialogType dialog)

指定对于使用这些属性的作业，用户是否应该看到用于修改打印设置的打印对话框，以及显示哪种类型的打印对话框。DialogType.COMMON 表示跨平台的纯 Java 打印对话框。DialogType.NATIVE 表示平台的本机打印对话框。如果平台不支持本机打印对话框，则显示纯 Java 打印对话框。DialogType.NONE 指定无打印对话框（即后台打印）。不指定此属性等效于指定 DialogType.NATIVE。

参数：

dialog - DialogType.COMMON、DialogType.NATIVE 或 DialogType.NONE。

抛出：

IllegalArgumentException - 如果对话框为 null。

getFileName

public String getFileName()

指定使用这些属性的作业的输出文件的文件名。将此属性更新为用户选择的值。

返回：

可能为 null 文件名

setFileName

public void setFileName(String fileName)

指定使用这些属性的作业的输出文件的文件名。默认为依赖于平台并且随实现而定。

参数：

fileName - 可能为 null 文件名。

getFromPage

public int getFromPage()

对于使用这些属性的作业，如果要打印某个范围的页面，则返回要打印的第一页。将此属性更新为用户选择的值。应用程序应该忽略此输出属性，除非 getDefaultSelection 方法的返回值为 DefaultSelectionType.RANGE。如有可能，应用程序应该优先使用 getPageRanges 的返回值而不是此方法的返回值。

返回：

大于零且小于或等于 toPage 并且大于或等于 minPage 且小于或等于 maxPage 的整数。

setFromPage

public void setFromPage(int fromPage)

对于使用这些属性的作业，如果要打印某个范围的页面，则指定要打印的第一页。如果未指定此属性，则使用 pageRanges 属性的值。如果指定 pageRanges，同时指定 fromPage 和 toPage 的其中之一或两者，则优先使用 pageRanges。如果不指定 pageRanges、fromPage 或 toPage 中的任何一个，则等效于调用 setPageRanges(new int[][] { new int[] { minPage } })；

参数：

fromPage - 大于零且小于或等于 toPage 并且大于或等于 minPage 且小于或等于 maxPage 的整数。

抛出：

IllegalArgumentException - 如果违反了一个或多个上述条件。

getMaxPage

public int getMaxPage()

指定对于使用这些属性的作业，用户可以指定为要打印的最后一页的最大值。任何实现或目标打印机都不能修改此属性，也不能对其加以限制。

返回：

大于零且大于或等于 minPage 的整数。

setMaxPage

public void setMaxPage(int maxPage)

指定对于使用这些属性的作业，用户可以指定为要打印的最后一页的最大值。不指定此属性等效于指定 Integer.MAX_VALUE。

参数：

maxPage - 大于零且大于或等于 minPage 的整数

抛出：

IllegalArgumentException - 如果违反了一个或多个上述条件

getMinPage

public int getMinPage()

指定对于使用这些属性的作业，用户可以指定为要打印的第一页的最小值。任何实现或目标打印机都不能修改此属性，也不能对其加以限制。

返回：

大于零且小于或等于 maxPage 的整数。

setMinPage

public void setMinPage(int minPage)

指定对于使用这些属性的作业，用户可以指定为要打印的第一页的最小值。不指定此属性等效于指定 1。

参数：

minPage - 大于零且小于或等于 maxPage 的整数。

抛出：

IllegalArgumentException - 如果违反了一个或多个上述条件。

getMultipleDocumentHandling

public JobAttributes.MultipleDocumentHandlingType getMultipleDocumentHandling()

为使用这些属性的作业指定多份处理，包括整理。将此属性更新为用户选择的值。

返回：

MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES 或 MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES。

setMultipleDocumentHandling

public void setMultipleDocumentHandling(JobAttributes.MultipleDocumentHandlingType multipleDocumentHandling)

为使用这些属性的作业指定多份处理，包括整理。不指定此属性等效于指定 MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES。

参数：

multipleDocumentHandling - MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES 或 MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES。

抛出：

IllegalArgumentException - 如果 multipleDocumentHandling 为 null。

setMultipleDocumentHandlingToDefault

public void setMultipleDocumentHandlingToDefault()

对于使用这些属性的作业，将多份处理（包括整理）设置为默认值。默认处理为 MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES。

getPageRanges

public int[][] getPageRanges()

对于使用这些属性的作业，如果要打印某个范围的页面，则指定要打印的页面范围。范围中的所有数字都包括在内。将此属性更新为用户选择的值。应用程序应该忽略此输出属性，除非 getDefaultSelection 方法的返回值为 DefaultSelectionType.RANGE。

返回：

两个元素的整数数组的数组。数组的范围被解释为包括两个指定页面以及它们之间的所有页面。范围必须为升序并且一定不能重叠。指定的页码不能小于 minPage，也不能大于 maxPage。例如：(new int[][] { new int[] { 1, 3 }, new int[] { 5, 5 }, new int[] { 15, 19 } }) 指定页面 1、2、3、5、15、16、17、18 和 19。

setPageRanges

public void setPageRanges(int[][] pageRanges)

对于使用这些属性的作业，如果要打印某个范围的页面，则指定要打印的页面范围。范围中的所有数字都包括在内。如果未指定此属性，则使用 fromPage 和 toPages 属性的值。如果指定 pageRanges，同时指定 fromPage 和 toPage 的其中之一或两者，则优先使用 pageRanges。如果不指定 pageRanges、fromPage 和 toPage 中的任何一个，则等效于调用 setPageRanges(new int[][] { new int[] { minPage, minPage } })；

参数：

pageRanges - 两个元素的整数数组的数组。数组的范围被解释为包括两个指定页面以及它们之间的所有页面。范围必须为升序并且一定不能重叠。指定的页码不能小于 minPage，也不能大于 maxPage。例如：(new int[][] { new int[] { 1, 3 }, new int[] { 5, 5 }, new int[] { 15, 19 } }) 指定页面 1、2、3、5、15、16、17、18 和 19。注意，(new int[][] { new int[] { 1, 1 }, new int[] { 1, 2 } }) 是一种页面范围的无效设置，因为两个范围重叠。

抛出：

IllegalArgumentException - 如果违反了一个或多个上述条件。

getPrinter

public String getPrinter()

为使用这些属性的作业返回目标打印机。将此属性更新为用户选择的值。

返回：

可能为 null 打印机名称。

setPrinter

public void setPrinter(String printer)

为使用这些属性的作业指定目标打印机。默认为依赖于平台并且随实现而定。

参数：

printer - 可能为 null 打印机名称。

getSides

public JobAttributes.SidesType getSides()

返回对于使用这些属性的作业，如何在打印介质的面上强制应用连续页。SidesType.ONE_SIDED 将每个连续页强制应用于连续介质纸张的同一面。这种整版有时称为 simplex。SidesType.TWO_SIDED_LONG_EDGE 将每个连续页对应用于连续介质纸张的前后两面，以便介质上的每个页对方向正对着读者，就好像绑定在长边上一样。这种整版有时称为 duplex。SidesType.TWO_SIDED_SHORT_EDGE 将每个连续页对应用于连续介质纸张的前后两面，以便介质上的每个页对方向正对着读者，就好像绑定在短边上一样。这种整版有时称为 tumble。将此属性更新为用户选择的值。

返回：

SidesType.ONE_SIDED、SidesType.TWO_SIDED_LONG_EDGE 或 SidesType.TWO_SIDED_SHORT_EDGE。

setSides

public void setSides(JobAttributes.SidesType sides)

指定对于使用这些属性的作业，如何在打印介质的面上强制应用连续页。SidesType.ONE_SIDED 将每个连续页强制应用于连续介质表的同一面。这种整版有时称为 simplex。SidesType.TWO_SIDED_LONG_EDGE 将每个连续页对应用于连续介质纸张的前后两面，以便介质上的每个页对方向正对着读者，就好像绑定在长边上一样。这种整版有时称为 duplex。SidesType.TWO_SIDED_SHORT_EDGE 将每个连续页对应用于连续介质纸张的前后两面，以便介质上的每个页对方向正对着读者，就好像绑定在短边上一样。这种整版有时称为 tumble。不指定此属性等效于指定 SidesType.ONE_SIDED。

参数：

sides - SidesType.ONE_SIDED、SidesType.TWO_SIDED_LONG_EDGE 或 SidesType.TWO_SIDED_SHORT_EDGE。

抛出：

IllegalArgumentException - 如果面为 null。

setSidesToDefault

public void setSidesToDefault()

对于使用这些属性的作业，将如何在打印介质的面上强制应用连续页设置为默认值。默认的整版为 SidesType.ONE_SIDED。

getToPage

public int getToPage()

对于使用这些属性的作业，如果要打印某个范围的页面，则返回要打印的最后一页（包括该页）。将此属性更新为用户选择的值。应用程序应该忽略此输出属性，除非 getDefaultSelection 方法的返回值是 DefaultSelectionType.RANGE。如果可能，应用程序应该优先使用 getPageRanges 的返回值而不用此方法的返回值。

返回：

大于零且大于或等于 toPage 并且大于或等于 minPage 且小于或等于 maxPage 的整数。

setToPage

public void setToPage(int toPage)

对于使用这些属性的作业，如果要打印某个范围的页面，则指定要打印的最后一页（包括该页）。如果未指定此属性，则使用 pageRanges 属性的值。如果指定 pageRanges，同时指定 fromPage 和 toPage 的其中之一或两者，则优先使用 pageRanges。如果不指定 pageRanges、fromPage 和 toPage 中的任何一个，则等效于调用 setPageRanges(new int[][] { new int[] { minPage } })；

参数：

toPage - 大于零且大于或等于 fromPage 并且大于或等于 minPage 且小于或等于 maxPage 的整数。

抛出：

IllegalArgumentException - 如果违反了一个或多个上述条件。

equals

public boolean equals(Object obj)

确定两个 JobAttributes 是否相等。

当且仅当两个 JobAttributes 的每个属性都相等时，这两个 JobAttributes 才相等。当且仅当字段都引用同一个惟一枚举对象时，枚举类型的属性才相等。当且仅当范围集合长度相等，每个范围枚举相同的页面并且这些范围顺序都相同时，页面范围的集合才相等。

覆盖：

类 Object 中的 equals

参数：

obj - 将检查其相等性的对象。

返回：

obj 是否等于此 JobAttribute，遵循上述标准。

另请参见：

Object.hashCode(), Hashtable

hashCode

public int hashCode()

返回此 JobAttributes 的哈希码值。

覆盖：

类 Object 中的 hashCode

返回：

哈希码。

另请参见：

Object.equals(java.lang.Object), Hashtable

toString

public String toString()

返回此 JobAttributes 的字符串表示形式。

覆盖：

类 Object 中的 toString

返回：

字符串表示形式。