JobAttributes JDK 1.6)

Constructors

public JobAttributes ()

Constructs a JobAttributes instance with default values for every attribute.

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.

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.

Constructs a JobAttributes instance with the
specified values for every attribute.
Parameters:
- 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
Throws:
- IllegalArgumentException - if one or more of the above conditions is violated

public JobAttributes (JobAttributes obj)

Constructs a JobAttributes instance which is a copy of the supplied JobAttributes.

Constructs a JobAttributes instance which is a copy
of the supplied JobAttributes.
Parameters:
- obj - the JobAttributes to copy

Methods

Hide/Show inherited methods

public Object clone ()

Creates and returns a copy of this JobAttributes.

Creates and returns a copy of this JobAttributes.
Returns: the newly created copy; it is safe to cast this Object into a JobAttributes

public boolean equals (Object obj)

Determines whether two JobAttributes are equal to each other.

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.

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.
Returns: DefaultSelectionType.ALL, DefaultSelectionType.RANGE, or DefaultSelectionType.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.

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.
Returns: DialogType.COMMON, DialogType.NATIVE, or DialogType.NONE

public String getFileName ()

Specifies the file name for the output file for jobs using these attributes.

Specifies the file name for the output file for jobs using these
attributes. This attribute is updated to the value chosen by the user.
Returns: the possibly null file name

public int getFromPage ()

Returns, for jobs using these attributes, the first page to be printed, if a range of pages is to be printed.

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.
Returns: 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.

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.

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: 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.

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.

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: an integer greater than zero and greater than or equal to toPage and greater than or equal to minPage and less than or equal to maxPage.

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.

Sets all of the attributes of this JobAttributes to
the same values as the attributes of obj.
Parameters:
- obj - the JobAttributes to copy

public void setCopies (int copies)

Specifies the number of copies the application should render for jobs using these attributes.

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 than or equal to 0

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.

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

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.

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 equal to minPage
Throws:
- IllegalArgumentException - if one or more of the above conditions is violated

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.

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 equal to maxPage.
Throws:
- IllegalArgumentException - if one or more of the above conditions is violated.

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.

public String toString ()

Returns a string representation of this JobAttributes.