java.lang.Object | |
↳ | java.awt.JobAttributes |
A set of attributes which control a print job.
Instances of this class control the number of copies, default selection, destination, print dialog, file and printer names, page ranges, multiple document handling (including collation), and multi-page imposition (such as duplex) of every print job which uses the instance. Attribute names are compliant with the Internet Printing Protocol (IPP) 1.1 where possible. Attribute values are partially compliant where possible.
To use a method which takes an inner class type, pass a reference to one of the constant fields of the inner class. Client code cannot create new instances of the inner class types because none of those classes has a public constructor. For example, to set the print dialog type to the cross-platform, pure Java print dialog, use the following code:
import java.awt.JobAttributes; public class PureJavaPrintDialogExample { public void setPureJavaPrintDialog(JobAttributes jobAttributes) { jobAttributes.setDialog(JobAttributes.DialogType.COMMON); } }
Every IPP attribute which supports an attributeName-default value
has a corresponding setattributeNameToDefault
method.
Default value fields are not provided.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
JobAttributes.DefaultSelectionType | A type-safe enumeration of possible default selection states. | ||||||||||
JobAttributes.DestinationType | A type-safe enumeration of possible job destinations. | ||||||||||
JobAttributes.DialogType | A type-safe enumeration of possible dialogs to display to the user. | ||||||||||
JobAttributes.MultipleDocumentHandlingType | A type-safe enumeration of possible multiple copy handling states. | ||||||||||
JobAttributes.SidesType | A type-safe enumeration of possible multi-page impositions. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a
JobAttributes instance with default
values for every attribute. | |||||||||||
Constructs a
JobAttributes instance which is a copy
of the supplied JobAttributes . | |||||||||||
Constructs a
JobAttributes instance with the
specified values for every attribute. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates and returns a copy of this
JobAttributes . | |||||||||||
Determines whether two JobAttributes are equal to each other.
| |||||||||||
Returns the number of copies the application should render for jobs
using these attributes.
| |||||||||||
Specifies whether, for jobs using these attributes, the application
should print all pages, the range specified by the return value of
getPageRanges , or the current selection. | |||||||||||
Specifies whether output will be to a printer or a file for jobs using
these attributes.
| |||||||||||
Returns whether, for jobs using these attributes, the user should see
a print dialog in which to modify the print settings, and which type of
print dialog should be displayed.
| |||||||||||
Specifies the file name for the output file for jobs using these
attributes.
| |||||||||||
Returns, for jobs using these attributes, the first page to be
printed, if a range of pages is to be printed.
| |||||||||||
Specifies the maximum value the user can specify as the last page to
be printed for jobs using these attributes.
| |||||||||||
Specifies the minimum value the user can specify as the first page to
be printed for jobs using these attributes.
| |||||||||||
Specifies the handling of multiple copies, including collation, for
jobs using these attributes.
| |||||||||||
Specifies, for jobs using these attributes, the ranges of pages to be
printed, if a range of pages is to be printed.
| |||||||||||
Returns the destination printer for jobs using these attributes.
| |||||||||||
Returns how consecutive pages should be imposed upon the sides of the
print medium for jobs using these attributes.
| |||||||||||
Returns, for jobs using these attributes, the last page (inclusive)
to be printed, if a range of pages is to be printed.
| |||||||||||
Returns a hash code value for this JobAttributes.
| |||||||||||
Sets all of the attributes of this
JobAttributes to
the same values as the attributes of obj. | |||||||||||
Specifies the number of copies the application should render for jobs
using these attributes.
| |||||||||||
Sets the number of copies the application should render for jobs using
these attributes to the default.
| |||||||||||
Specifies whether, for jobs using these attributes, the application
should print all pages, the range specified by the return value of
getPageRanges , or the current selection. | |||||||||||
Specifies whether output will be to a printer or a file for jobs using
these attributes.
| |||||||||||
Specifies whether, for jobs using these attributes, the user should see
a print dialog in which to modify the print settings, and which type of
print dialog should be displayed.
| |||||||||||
Specifies the file name for the output file for jobs using these
attributes.
| |||||||||||
Specifies, for jobs using these attributes, the first page to be
printed, if a range of pages is to be printed.
| |||||||||||
Specifies the maximum value the user can specify as the last page to
be printed for jobs using these attributes.
| |||||||||||
Specifies the minimum value the user can specify as the first page to
be printed for jobs using these attributes.
| |||||||||||
Specifies the handling of multiple copies, including collation, for
jobs using these attributes.
| |||||||||||
Sets the handling of multiple copies, including collation, for jobs
using these attributes to the default.
| |||||||||||
Specifies, for jobs using these attributes, the ranges of pages to be
printed, if a range of pages is to be printed.
| |||||||||||
Specifies the destination printer for jobs using these attributes.
| |||||||||||
Specifies how consecutive pages should be imposed upon the sides of the
print medium for jobs using these attributes.
| |||||||||||
Sets how consecutive pages should be imposed upon the sides of the
print medium for jobs using these attributes to the default.
| |||||||||||
Specifies, for jobs using these attributes, the last page (inclusive)
to be printed, if a range of pages is to be printed.
| |||||||||||
Returns a string representation of this JobAttributes.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Constructs a JobAttributes
instance with default
values for every attribute. The dialog defaults to
DialogType.NATIVE
. Min page defaults to
1
. Max page defaults to Integer.MAX_VALUE
.
Destination defaults to DestinationType.PRINTER
.
Selection defaults to DefaultSelectionType.ALL
.
Number of copies defaults to 1
. Multiple document handling defaults
to MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES
.
Sides defaults to SidesType.ONE_SIDED
. File name defaults
to null
.
Constructs a JobAttributes
instance which is a copy
of the supplied JobAttributes
.
obj | the JobAttributes to copy
|
---|
Constructs a JobAttributes
instance with the
specified values for every attribute.
copies | an integer greater than 0 |
---|---|
defaultSelection | DefaultSelectionType.ALL ,
DefaultSelectionType.RANGE , or
DefaultSelectionType.SELECTION |
destination | DesintationType.FILE or
DesintationType.PRINTER |
dialog | DialogType.COMMON ,
DialogType.NATIVE , or
DialogType.NONE |
fileName | the possibly null file name |
maxPage | an integer greater than zero and greater than or equal to minPage |
minPage | an integer greater than zero and less than or equal to maxPage |
multipleDocumentHandling | MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES or
MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES |
pageRanges | an array of integer arrays of two elements; an array
is interpreted as a range spanning all pages including and
between the specified pages; ranges must be in ascending
order and must not overlap; specified page numbers cannot be
less than minPage nor greater than maxPage;
for example:
(new int[][] { new int[] { 1, 3 }, new int[] { 5, 5 }, new int[] { 15, 19 } }),specifies pages 1, 2, 3, 5, 15, 16, 17, 18, and 19. Note that ( new int[][] { new int[] { 1, 1 }, new int[] { 1, 2 } } ),
is an invalid set of page ranges because the two ranges
overlap |
printer | the possibly null printer name |
sides | SidesType.ONE_SIDED ,
SidesType.TWO_SIDED_LONG_EDGE , or
SidesType.TWO_SIDED_SHORT_EDGE |
IllegalArgumentException | if one or more of the above conditions is violated |
---|
Creates and returns a copy of this JobAttributes
.
JobAttributes
Determines whether two JobAttributes are equal to each other.
Two JobAttributes are equal if and only if each of their attributes are equal. Attributes of enumeration type are equal if and only if the fields refer to the same unique enumeration object. A set of page ranges is equal if and only if the sets are of equal length, each range enumerates the same pages, and the ranges are in the same order.
obj | the object whose equality will be checked. |
---|
Returns the number of copies the application should render for jobs using these attributes. This attribute is updated to the value chosen by the user.
Specifies whether, for jobs using these attributes, the application
should print all pages, the range specified by the return value of
getPageRanges
, or the current selection. This attribute
is updated to the value chosen by the user.
Specifies whether output will be to a printer or a file for jobs using these attributes. This attribute is updated to the value chosen by the user.
Returns whether, for jobs using these attributes, the user should see a print dialog in which to modify the print settings, and which type of print dialog should be displayed. DialogType.COMMON denotes a cross- platform, pure Java print dialog. DialogType.NATIVE denotes the platform's native print dialog. If a platform does not support a native print dialog, the pure Java print dialog is displayed instead. DialogType.NONE specifies no print dialog (i.e., background printing). This attribute cannot be modified by, and is not subject to any limitations of, the implementation or the target printer.
DialogType.COMMON
, DialogType.NATIVE
, or
DialogType.NONE
Specifies the file name for the output file for jobs using these attributes. This attribute is updated to the value chosen by the user.
null
file name
Returns, for jobs using these attributes, the first page to be
printed, if a range of pages is to be printed. This attribute is
updated to the value chosen by the user. An application should ignore
this attribute on output, unless the return value of the
getDefaultSelection
method is DefaultSelectionType.RANGE. An
application should honor the return value of getPageRanges
over the return value of this method, if possible.
Specifies the maximum value the user can specify as the last page to be printed for jobs using these attributes. This attribute cannot be modified by, and is not subject to any limitations of, the implementation or the target printer.
Specifies the minimum value the user can specify as the first page to be printed for jobs using these attributes. This attribute cannot be modified by, and is not subject to any limitations of, the implementation or the target printer.
Specifies the handling of multiple copies, including collation, for jobs using these attributes. This attribute is updated to the value chosen by the user.
Specifies, for jobs using these attributes, the ranges of pages to be
printed, if a range of pages is to be printed. All range numbers are
inclusive. This attribute is updated to the value chosen by the user.
An application should ignore this attribute on output, unless the
return value of the getDefaultSelection
method is
DefaultSelectionType.RANGE.
Returns the destination printer for jobs using these attributes. This attribute is updated to the value chosen by the user.
Returns how consecutive pages should be imposed upon the sides of the print medium for jobs using these attributes. SidesType.ONE_SIDED imposes each consecutive page upon the same side of consecutive media sheets. This imposition is sometimes called simplex. SidesType.TWO_SIDED_LONG_EDGE imposes each consecutive pair of pages upon front and back sides of consecutive media sheets, such that the orientation of each pair of pages on the medium would be correct for the reader as if for binding on the long edge. This imposition is sometimes called duplex. SidesType.TWO_SIDED_SHORT_EDGE imposes each consecutive pair of pages upon front and back sides of consecutive media sheets, such that the orientation of each pair of pages on the medium would be correct for the reader as if for binding on the short edge. This imposition is sometimes called tumble. This attribute is updated to the value chosen by the user.
Returns, for jobs using these attributes, the last page (inclusive)
to be printed, if a range of pages is to be printed. This attribute is
updated to the value chosen by the user. An application should ignore
this attribute on output, unless the return value of the
getDefaultSelection
method is DefaultSelectionType.RANGE. An
application should honor the return value of getPageRanges
over the return value of this method, if possible.
Returns a hash code value for this JobAttributes.
Sets all of the attributes of this JobAttributes
to
the same values as the attributes of obj.
obj | the JobAttributes to copy
|
---|
Specifies the number of copies the application should render for jobs
using these attributes. Not specifying this attribute is equivalent to
specifying 1
.
copies | an integer greater than 0 |
---|
IllegalArgumentException | if copies is less than
or equal to 0
|
---|
Sets the number of copies the application should render for jobs using these attributes to the default. The default number of copies is 1.
Specifies whether, for jobs using these attributes, the application
should print all pages, the range specified by the return value of
getPageRanges
, or the current selection. Not specifying
this attribute is equivalent to specifying DefaultSelectionType.ALL.
defaultSelection | DefaultSelectionType.ALL, DefaultSelectionType.RANGE, or DefaultSelectionType.SELECTION. |
---|
IllegalArgumentException | if defaultSelection is null
|
---|
Specifies whether output will be to a printer or a file for jobs using these attributes. Not specifying this attribute is equivalent to specifying DesintationType.PRINTER.
destination | DesintationType.FILE or DesintationType.PRINTER. |
---|
IllegalArgumentException | if destination is null. |
---|
Specifies whether, for jobs using these attributes, the user should see a print dialog in which to modify the print settings, and which type of print dialog should be displayed. DialogType.COMMON denotes a cross- platform, pure Java print dialog. DialogType.NATIVE denotes the platform's native print dialog. If a platform does not support a native print dialog, the pure Java print dialog is displayed instead. DialogType.NONE specifies no print dialog (i.e., background printing). Not specifying this attribute is equivalent to specifying DialogType.NATIVE.
dialog | DialogType.COMMON, DialogType.NATIVE, or DialogType.NONE. |
---|
IllegalArgumentException | if dialog is null. |
---|
Specifies the file name for the output file for jobs using these attributes. Default is platform-dependent and implementation-defined.
fileName | the possibly null file name. |
---|
Specifies, for jobs using these attributes, the first page to be printed, if a range of pages is to be printed. If this attribute is not specified, then the values from the pageRanges attribute are used. If pageRanges and either or both of fromPage and toPage are specified, pageRanges takes precedence. Specifying none of pageRanges, fromPage, or toPage is equivalent to calling setPageRanges(new int[][] { new int[] { minPage } });
fromPage | an integer greater than zero and less than or equal to toPage and greater than or equal to minPage and less than or equal to maxPage. |
---|
IllegalArgumentException | if one or more of the above conditions is violated. |
---|
Specifies the maximum value the user can specify as the last page to
be printed for jobs using these attributes. Not specifying this
attribute is equivalent to specifying Integer.MAX_VALUE
.
maxPage | an integer greater than zero and greater than or equal to minPage |
---|
IllegalArgumentException | if one or more of the above conditions is violated |
---|
Specifies the minimum value the user can specify as the first page to
be printed for jobs using these attributes. Not specifying this
attribute is equivalent to specifying 1
.
minPage | an integer greater than zero and less than or equal to maxPage. |
---|
IllegalArgumentException | if one or more of the above conditions is violated. |
---|
Specifies the handling of multiple copies, including collation, for jobs using these attributes. Not specifying this attribute is equivalent to specifying MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES.
multipleDocumentHandling | MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES or MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES. |
---|
IllegalArgumentException | if multipleDocumentHandling is null. |
---|
Sets the handling of multiple copies, including collation, for jobs using these attributes to the default. The default handling is MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES.
Specifies, for jobs using these attributes, the ranges of pages to be printed, if a range of pages is to be printed. All range numbers are inclusive. If this attribute is not specified, then the values from the fromPage and toPages attributes are used. If pageRanges and either or both of fromPage and toPage are specified, pageRanges takes precedence. Specifying none of pageRanges, fromPage, or toPage is equivalent to calling setPageRanges(new int[][] { new int[] { minPage, minPage } });
pageRanges | an array of integer arrays of 2 elements. An array is interpreted as a range spanning all pages including and between the specified pages. Ranges must be in ascending order and must not overlap. Specified page numbers cannot be less than minPage nor greater than maxPage. For example: (new int[][] { new int[] { 1, 3 }, new int[] { 5, 5 }, new int[] { 15, 19 } }), specifies pages 1, 2, 3, 5, 15, 16, 17, 18, and 19. Note that (new int[][] { new int[] { 1, 1 }, new int[] { 1, 2 } }), is an invalid set of page ranges because the two ranges overlap. |
---|
IllegalArgumentException | if one or more of the above conditions is violated. |
---|
Specifies the destination printer for jobs using these attributes. Default is platform-dependent and implementation-defined.
printer | the possibly null printer name. |
---|
Specifies how consecutive pages should be imposed upon the sides of the print medium for jobs using these attributes. SidesType.ONE_SIDED imposes each consecutive page upon the same side of consecutive media sheets. This imposition is sometimes called simplex. SidesType.TWO_SIDED_LONG_EDGE imposes each consecutive pair of pages upon front and back sides of consecutive media sheets, such that the orientation of each pair of pages on the medium would be correct for the reader as if for binding on the long edge. This imposition is sometimes called duplex. SidesType.TWO_SIDED_SHORT_EDGE imposes each consecutive pair of pages upon front and back sides of consecutive media sheets, such that the orientation of each pair of pages on the medium would be correct for the reader as if for binding on the short edge. This imposition is sometimes called tumble. Not specifying this attribute is equivalent to specifying SidesType.ONE_SIDED.
sides | SidesType.ONE_SIDED, SidesType.TWO_SIDED_LONG_EDGE, or SidesType.TWO_SIDED_SHORT_EDGE. |
---|
IllegalArgumentException | if sides is null. |
---|
Sets how consecutive pages should be imposed upon the sides of the print medium for jobs using these attributes to the default. The default imposition is SidesType.ONE_SIDED.
Specifies, for jobs using these attributes, the last page (inclusive) to be printed, if a range of pages is to be printed. If this attribute is not specified, then the values from the pageRanges attribute are used. If pageRanges and either or both of fromPage and toPage are specified, pageRanges takes precedence. Specifying none of pageRanges, fromPage, or toPage is equivalent to calling setPageRanges(new int[][] { new int[] { minPage } });
toPage | an integer greater than zero and greater than or equal to fromPage and greater than or equal to minPage and less than or equal to maxPage. |
---|
IllegalArgumentException | if one or more of the above conditions is violated. |
---|
Returns a string representation of this JobAttributes.