| java.lang.Object
 java.awt.JobAttributes
| JobAttributes | | final public class JobAttributes implements Cloneable(Code) | | 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.
version:
1.17, 05/05/07
author:
David Mendenhall
since:
1.3 |
| Inner Class :final public static class DefaultSelectionType extends AttributeValue | |
| Inner Class :final public static class DestinationType extends AttributeValue | |
| Inner Class :final public static class DialogType extends AttributeValue | |
| Inner Class :final public static class MultipleDocumentHandlingType extends AttributeValue | |
| Inner Class :final public static class SidesType extends AttributeValue | |
| Constructor Summary | |
| public | JobAttributes()
Constructs a JobAttributes instance with default
values for every attribute. | | public | JobAttributes(JobAttributes obj)
Constructs a JobAttributes instance which is a copy
of the supplied JobAttributes. | | public | JobAttributes(int copies, DefaultSelectionType defaultSelection, DestinationType destination, DialogType dialog, String fileName, int maxPage, int minPage, MultipleDocumentHandlingType multipleDocumentHandling, int[][] pageRanges, String printer, SidesType sides)
Constructs a JobAttributes instance with the
specified values for every attribute.
Parameters:
copies - an integer greater than 0
Parameters:
defaultSelection - DefaultSelectionType.ALL,DefaultSelectionType.RANGE, orDefaultSelectionType.SELECTION
Parameters:
destination - DesintationType.FILE orDesintationType.PRINTER
Parameters:
dialog - DialogType.COMMON,DialogType.NATIVE, orDialogType.NONE
Parameters:
fileName - the possibly null file name
Parameters:
maxPage - an integer greater than zero and greater than or equalto minPage
Parameters:
minPage - an integer greater than zero and less than or equalto maxPage
Parameters:
multipleDocumentHandling - MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES orMultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES
Parameters:
pageRanges - an array of integer arrays of two elements; an arrayis interpreted as a range spanning all pages including andbetween the specified pages; ranges must be in ascendingorder and must not overlap; specified page numbers cannot beless 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. |
| Method Summary | |
| public Object | clone()
Creates and returns a copy of this JobAttributes. | | public boolean | equals(Object obj)
Determines whether two JobAttributes are equal to each other.
Two JobAttributes are equal if and only if each of their attributes are
equal. | | public int | getCopies()
Returns the number of copies the application should render for jobs
using these attributes. | | public DefaultSelectionType | getDefaultSelection()
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. | | public DestinationType | getDestination()
Specifies whether output will be to a printer or a file for jobs using
these attributes. | | public DialogType | getDialog()
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. | | public String | getFileName()
Specifies the file name for the output file for jobs using these
attributes. | | public int | getFromPage()
Returns, for jobs using these attributes, the first page to be
printed, if a range of pages is to be printed. | | public int | getMaxPage()
Specifies the maximum value the user can specify as the last page to
be printed for jobs using these attributes. | | public int | getMinPage()
Specifies the minimum value the user can specify as the first page to
be printed for jobs using these attributes. | | public MultipleDocumentHandlingType | getMultipleDocumentHandling()
Specifies the handling of multiple copies, including collation, for
jobs using these attributes. | | public int[][] | getPageRanges()
Specifies, for jobs using these attributes, the ranges of pages to be
printed, if a range of pages is to be printed. | | public String | getPrinter()
Returns the destination printer for jobs using these attributes. | | public SidesType | getSides()
Returns how consecutive pages should be imposed upon the sides of the
print medium for jobs using these attributes. | | public int | getToPage()
Returns, for jobs using these attributes, the last page (inclusive)
to be printed, if a range of pages is to be printed. | | public int | hashCode()
Returns a hash code value for this JobAttributes. | | public void | set(JobAttributes obj)
Sets all of the attributes of this JobAttributes to
the same values as the attributes of obj. | | public void | setCopies(int copies)
Specifies the number of copies the application should render for jobs
using these attributes. | | public void | setCopiesToDefault()
Sets the number of copies the application should render for jobs using
these attributes to the default. | | public void | setDefaultSelection(DefaultSelectionType defaultSelection)
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. | | public void | setDestination(DestinationType destination)
Specifies whether output will be to a printer or a file for jobs using
these attributes. | | public void | setDialog(DialogType dialog)
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. | | public void | setFileName(String fileName)
Specifies the file name for the output file for jobs using these
attributes. | | public void | setFromPage(int fromPage)
Specifies, for jobs using these attributes, the first page to be
printed, if a range of pages is to be printed. | | public void | setMaxPage(int maxPage)
Specifies the maximum value the user can specify as the last page to
be printed for jobs using these attributes. | | public void | setMinPage(int minPage)
Specifies the minimum value the user can specify as the first page to
be printed for jobs using these attributes. | | public void | setMultipleDocumentHandling(MultipleDocumentHandlingType multipleDocumentHandling)
Specifies the handling of multiple copies, including collation, for
jobs using these attributes. | | public void | setMultipleDocumentHandlingToDefault()
Sets the handling of multiple copies, including collation, for jobs
using these attributes to the default. | | public void | setPageRanges(int[][] pageRanges)
Specifies, for jobs using these attributes, the ranges of pages to be
printed, if a range of pages is to be printed. | | public void | setPrinter(String printer)
Specifies the destination printer for jobs using these attributes. | | public void | setSides(SidesType sides)
Specifies how consecutive pages should be imposed upon the sides of the
print medium for jobs using these attributes. | | public void | setSidesToDefault()
Sets how consecutive pages should be imposed upon the sides of the
print medium for jobs using these attributes to the default. | | public void | setToPage(int toPage)
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. | | public String | toString()
Returns a string representation of this JobAttributes. |
| JobAttributes | | public JobAttributes()(Code) | | 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.
|
| JobAttributes | | public JobAttributes(JobAttributes obj)(Code) | | Constructs a JobAttributes instance which is a copy
of the supplied JobAttributes.
Parameters:
obj - the JobAttributes to copy |
| JobAttributes | | public JobAttributes(int copies, DefaultSelectionType defaultSelection, DestinationType destination, DialogType dialog, String fileName, int maxPage, int minPage, MultipleDocumentHandlingType multipleDocumentHandling, int[][] pageRanges, String printer, SidesType sides)(Code) | | Constructs a JobAttributes instance with the
specified values for every attribute.
Parameters:
copies - an integer greater than 0
Parameters:
defaultSelection - DefaultSelectionType.ALL,DefaultSelectionType.RANGE, orDefaultSelectionType.SELECTION
Parameters:
destination - DesintationType.FILE orDesintationType.PRINTER
Parameters:
dialog - DialogType.COMMON,DialogType.NATIVE, orDialogType.NONE
Parameters:
fileName - the possibly null file name
Parameters:
maxPage - an integer greater than zero and greater than or equalto minPage
Parameters:
minPage - an integer greater than zero and less than or equalto maxPage
Parameters:
multipleDocumentHandling - MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES orMultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES
Parameters:
pageRanges - an array of integer arrays of two elements; an arrayis interpreted as a range spanning all pages including andbetween the specified pages; ranges must be in ascendingorder and must not overlap; specified page numbers cannot beless 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 rangesoverlap
Parameters:
printer - the possibly null printer name
Parameters:
sides - SidesType.ONE_SIDED,SidesType.TWO_SIDED_LONG_EDGE, orSidesType.TWO_SIDED_SHORT_EDGE
throws:
IllegalArgumentException - if one or more of the aboveconditions is violated |
| clone | | public Object clone()(Code) | | Creates and returns a copy of this JobAttributes.
the newly created copy; it is safe to cast this Object intoa JobAttributes |
| equals | | public boolean equals(Object obj)(Code) | | 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.
Parameters:
obj - the object whose equality will be checked. whether obj is equal to this JobAttribute according to theabove criteria. |
| getCopies | | public int getCopies()(Code) | | 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.
an integer greater than 0. |
| getDefaultSelection | | public DefaultSelectionType getDefaultSelection()(Code) | | 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.
DefaultSelectionType.ALL, DefaultSelectionType.RANGE, orDefaultSelectionType.SELECTION |
| getDestination | | public DestinationType getDestination()(Code) | | 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.
DesintationType.FILE or DesintationType.PRINTER |
| getDialog | | public DialogType getDialog()(Code) | | 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, orDialogType.NONE |
| getFileName | | public String getFileName()(Code) | | Specifies the file name for the output file for jobs using these
attributes. This attribute is updated to the value chosen by the user.
the possibly null file name |
| getFromPage | | public int getFromPage()(Code) | | 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.
an integer greater than zero and less than or equal totoPage and greater than or equal to minPage andless than or equal to maxPage. |
| getMaxPage | | public int getMaxPage()(Code) | | 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.
an integer greater than zero and greater than or equalto minPage. |
| getMinPage | | public int getMinPage()(Code) | | 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.
an integer greater than zero and less than or equalto maxPage. |
| getMultipleDocumentHandling | | public MultipleDocumentHandlingType getMultipleDocumentHandling()(Code) | | Specifies the handling of multiple copies, including collation, for
jobs using these attributes. This attribute is updated to the value
chosen by the user.
MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES orMultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES. |
| getPageRanges | | public int[][] getPageRanges()(Code) | | 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.
an array of integer arrays of 2 elements. An arrayis interpreted as a range spanning all pages including andbetween the specified pages. Ranges must be in ascendingorder and must not overlap. Specified page numbers cannot beless 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. |
| getPrinter | | public String getPrinter()(Code) | | Returns the destination printer for jobs using these attributes. This
attribute is updated to the value chosen by the user.
the possibly null printer name. |
| getSides | | public SidesType getSides()(Code) | | 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.
SidesType.ONE_SIDED, SidesType.TWO_SIDED_LONG_EDGE, orSidesType.TWO_SIDED_SHORT_EDGE. |
| getToPage | | public int getToPage()(Code) | | 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.
an integer greater than zero and greater than or equalto toPage and greater than or equal to minPageand less than or equal to maxPage. |
| hashCode | | public int hashCode()(Code) | | Returns a hash code value for this JobAttributes.
the hash code. |
| set | | public void set(JobAttributes obj)(Code) | | Sets all of the attributes of this JobAttributes to
the same values as the attributes of obj.
Parameters:
obj - the JobAttributes to copy |
| setCopies | | public void setCopies(int copies)(Code) | | Specifies the number of copies the application should render for jobs
using these attributes. Not specifying this attribute is equivalent to
specifying 1.
Parameters:
copies - an integer greater than 0
throws:
IllegalArgumentException - if copies is less thanor equal to 0 |
| setCopiesToDefault | | public void setCopiesToDefault()(Code) | | Sets the number of copies the application should render for jobs using
these attributes to the default. The default number of copies is 1.
|
| setDefaultSelection | | public void setDefaultSelection(DefaultSelectionType defaultSelection)(Code) | | 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.
Parameters:
defaultSelection - DefaultSelectionType.ALL,DefaultSelectionType.RANGE, or DefaultSelectionType.SELECTION.
throws:
IllegalArgumentException - if defaultSelection is null |
| setDestination | | public void setDestination(DestinationType destination)(Code) | | 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.
Parameters:
destination - DesintationType.FILE or DesintationType.PRINTER.
throws:
IllegalArgumentException - if destination is null. |
| setDialog | | public void setDialog(DialogType dialog)(Code) | | 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.
Parameters:
dialog - DialogType.COMMON, DialogType.NATIVE, orDialogType.NONE.
throws:
IllegalArgumentException - if dialog is null. |
| setFileName | | public void setFileName(String fileName)(Code) | | Specifies the file name for the output file for jobs using these
attributes. Default is platform-dependent and implementation-defined.
Parameters:
fileName - the possibly null file name. |
| setFromPage | | public void setFromPage(int fromPage)(Code) | | 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 } });
Parameters:
fromPage - an integer greater than zero and less than or equal totoPage and greater than or equal to minPage andless than or equal to maxPage.
throws:
IllegalArgumentException - if one or more of the aboveconditions is violated. |
| setMaxPage | | public void setMaxPage(int maxPage)(Code) | | 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.
Parameters:
maxPage - an integer greater than zero and greater than or equalto minPage
throws:
IllegalArgumentException - if one or more of the aboveconditions is violated |
| setMinPage | | public void setMinPage(int minPage)(Code) | | 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.
Parameters:
minPage - an integer greater than zero and less than or equalto maxPage.
throws:
IllegalArgumentException - if one or more of the aboveconditions is violated. |
| setMultipleDocumentHandling | | public void setMultipleDocumentHandling(MultipleDocumentHandlingType multipleDocumentHandling)(Code) | | 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.
Parameters:
multipleDocumentHandling - MultipleDocumentHandlingType.SEPARATE_DOCUMENTS_COLLATED_COPIES orMultipleDocumentHandlingType.SEPARATE_DOCUMENTS_UNCOLLATED_COPIES.
throws:
IllegalArgumentException - if multipleDocumentHandling is null. |
| setMultipleDocumentHandlingToDefault | | public void setMultipleDocumentHandlingToDefault()(Code) | | 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.
|
| setPageRanges | | public void setPageRanges(int[][] pageRanges)(Code) | | 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 } });
Parameters:
pageRanges - an array of integer arrays of 2 elements. An arrayis interpreted as a range spanning all pages including andbetween the specified pages. Ranges must be in ascendingorder and must not overlap. Specified page numbers cannot beless 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 rangesoverlap.
throws:
IllegalArgumentException - if one or more of the aboveconditions is violated. |
| setPrinter | | public void setPrinter(String printer)(Code) | | Specifies the destination printer for jobs using these attributes.
Default is platform-dependent and implementation-defined.
Parameters:
printer - the possibly null printer name. |
| setSides | | public void setSides(SidesType sides)(Code) | | 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.
Parameters:
sides - SidesType.ONE_SIDED, SidesType.TWO_SIDED_LONG_EDGE, orSidesType.TWO_SIDED_SHORT_EDGE.
throws:
IllegalArgumentException - if sides is null. |
| setSidesToDefault | | public void setSidesToDefault()(Code) | | 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.
|
| setToPage | | public void setToPage(int toPage)(Code) | | 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 } });
Parameters:
toPage - an integer greater than zero and greater than or equalto fromPage and greater than or equal to minPageand less than or equal to maxPage.
throws:
IllegalArgumentException - if one or more of the aboveconditions is violated. |
| toString | | public String toString()(Code) | | Returns a string representation of this JobAttributes.
the string representation. |
|
|