public final class JobAttributes extends Object implements Cloneable
该类的实例控制使用的每个打印作业的份数,默认选择,目的地,打印对话框,文件和打印机名称,页面范围,多个文档处理(包括排序规则)和多页面拼版(如双面)实例。 如果可能,属性名称符合Internet打印协议(IPP)1.1。 属性值在可能的情况下是部分兼容的。
要使用一个接受内部类类型的方法,请将引用传递给内部类的一个常量字段。 客户端代码不能创建内部类类型的新实例,因为这些类都不具有公共构造函数。 例如,要将打印对话框类型设置为跨平台,纯Java打印对话框,请使用以下代码:
import java.awt.JobAttributes;
public class PureJavaPrintDialogExample {
public void setPureJavaPrintDialog(JobAttributes jobAttributes) {
jobAttributes.setDialog(JobAttributes.DialogType.COMMON);
}
}
支持attributeName -default值的每个IPP属性都具有相应的setattributeNameToDefault
方法。 未提供默认值字段。
Modifier and Type | Class and Description |
---|---|
static class |
JobAttributes.DefaultSelectionType
可能的默认选择状态的类型安全枚举。
|
static class |
JobAttributes.DestinationType
可能的工作目的地的类型安全枚举。
|
static class |
JobAttributes.DialogType
可以显示给用户的可能对话框的类型安全枚举。
|
static class |
JobAttributes.MultipleDocumentHandlingType
可能的多重复制处理状态的类型安全枚举。
|
static class |
JobAttributes.SidesType
可能的多页面强制的类型安全枚举。
|
Constructor and Description |
---|
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 的副本。
|
Modifier and Type | Method and Description |
---|---|
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的
JobAttributes 相同的值。
|
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的字符串表示形式。
|
public JobAttributes()
JobAttributes
实例。
对话框默认为DialogType.NATIVE
。
最小页面默认为1
。
最大页面默认为Integer.MAX_VALUE
。
目标默认为DestinationType.PRINTER
。
选择默认为DefaultSelectionType.ALL
。
份数默认为1
。
多个文档处理默认为MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES
。
侧面默认为SidesType.ONE_SIDED
。
文件名默认为null
。
public JobAttributes(JobAttributes obj)
JobAttributes
实例,它是提供的
JobAttributes
的副本。
obj
- 要复制的
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
- 如果违反上述一个或多个条件
public Object clone()
JobAttributes
的副本。
public void set(JobAttributes obj)
JobAttributes
相同的值。
obj
-
JobAttributes
复制
public int getCopies()
public void setCopies(int copies)
1
。
copies
- 大于0的整数
IllegalArgumentException
- 如果
copies
小于或等于0
public void setCopiesToDefault()
public JobAttributes.DefaultSelectionType getDefaultSelection()
getPageRanges
的范围或当前选择。
此属性更新为用户选择的值。
public void setDefaultSelection(JobAttributes.DefaultSelectionType defaultSelection)
getPageRanges
的范围或当前选择。
不指定此属性等同于指定DefaultSelectionType.ALL。
defaultSelection
- DefaultSelectionType.ALL,DefaultSelectionType.RANGE或DefaultSelectionType.SELECTION。
IllegalArgumentException
- 如果defaultSelection是
null
public JobAttributes.DestinationType getDestination()
public void setDestination(JobAttributes.DestinationType destination)
destination
- DesintationType.FILE或DesintationType.PRINTER。
IllegalArgumentException
- 如果目的地为空。
public JobAttributes.DialogType getDialog()
DialogType.COMMON
,
DialogType.NATIVE
,或
DialogType.NONE
public void setDialog(JobAttributes.DialogType dialog)
dialog
- DialogType.COMMON,DialogType.NATIVE或DialogType.NONE。
IllegalArgumentException
- 如果对话框为空。
public String getFileName()
null
文件名
public void setFileName(String fileName)
fileName
- 可能为null的文件名。
public int getFromPage()
getDefaultSelection
方法的返回值为DefaultSelectionType.RANGE。
如果可能,应用程序应遵守getPageRanges
的返回值超过此方法的返回值。
public void setFromPage(int fromPage)
fromPage
- 一个大于零且小于或等于
toPage并大于或等于
minPage且小于或等于
maxPage的整数 。
IllegalArgumentException
- 如果上述条件中的一个或多个被违反。
public int getMaxPage()
public void setMaxPage(int maxPage)
Integer.MAX_VALUE
。
maxPage
- 一个大于零且大于或等于
minPage的整数
IllegalArgumentException
- 如果违反上述一个或多个条件
public int getMinPage()
public void setMinPage(int minPage)
1
。
minPage
- 大于零且小于或等于
maxPage的整数 。
IllegalArgumentException
- 如果违反了上述一个或多个条件。
public JobAttributes.MultipleDocumentHandlingType getMultipleDocumentHandling()
public void setMultipleDocumentHandling(JobAttributes.MultipleDocumentHandlingType multipleDocumentHandling)
multipleDocumentHandling
- MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES或MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES。
IllegalArgumentException
- 如果multipleDocumentHandling为null。
public void setMultipleDocumentHandlingToDefault()
public int[][] getPageRanges()
getDefaultSelection
方法的返回值为DefaultSelectionType.RANGE。
public void setPageRanges(int[][] pageRanges)
pageRanges
- 2个元素的整数数组数组。
一个数组被解释为跨越包含指定页面的所有页面的范围。
范围必须按照升序排列,不得重叠。
指定的页码不能小于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
- 如果上述条件中的一个或多个被违反。
public String getPrinter()
public void setPrinter(String printer)
printer
- 可能为空的打印机名称。
public JobAttributes.SidesType getSides()
public void setSides(JobAttributes.SidesType sides)
sides
- SidesType.ONE_SIDED,SidesType.TWO_SIDED_LONG_EDGE或SidesType.TWO_SIDED_SHORT_EDGE。
IllegalArgumentException
- 如果边为空。
public void setSidesToDefault()
public int getToPage()
getDefaultSelection
方法的返回值为DefaultSelectionType.RANGE。
如果可能,应用程序应遵守getPageRanges
的返回值超过此方法的返回值。
public void setToPage(int toPage)
toPage
- 一个大于零且大于或等于
fromPage并大于或等于
minPage且小于或等于
maxPage的整数 。
IllegalArgumentException
- 如果违反上述一个或多个条件。
public boolean equals(Object obj)
当且仅当它们的每个属性相等时,两个JobAttributes是相等的。 枚举类型的属性当且仅当这些域引用相同的唯一枚举对象时相等。 当且仅当集合长度相等时,一组页面范围是相等的,每个范围枚举相同的页面,范围是相同的顺序。
equals
在
Object
obj
- 将检查其相等性的对象。
Object.hashCode()
, HashMap
public int hashCode()
hashCode
在
Object
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)