Home » openjdk-7 » java » awt » [javadoc | source]
java.awt
public final class: JobAttributes [javadoc | source]
java.lang.Object
   java.awt.JobAttributes

All Implemented Interfaces:
    Cloneable

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 Class Summary:
public static final class  JobAttributes.DefaultSelectionType  A type-safe enumeration of possible default selection states. 
public static final class  JobAttributes.DestinationType  A type-safe enumeration of possible job destinations. 
public static final class  JobAttributes.DialogType  A type-safe enumeration of possible dialogs to display to the user. 
public static final class  JobAttributes.MultipleDocumentHandlingType  A type-safe enumeration of possible multiple copy handling states. It is used to control how the sheets of multiple copies of a single document are collated. 
public static final class  JobAttributes.SidesType  A type-safe enumeration of possible multi-page impositions. These impositions are in compliance with IPP 1.1. 
Constructor:
 public JobAttributes() 
 public JobAttributes(JobAttributes obj) 
    Constructs a JobAttributes instance which is a copy of the supplied JobAttributes.
    Parameters:
    obj - the JobAttributes to copy
 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
    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
Method from java.awt.JobAttributes Summary:
clone,   equals,   getCopies,   getDefaultSelection,   getDestination,   getDialog,   getFileName,   getFromPage,   getMaxPage,   getMinPage,   getMultipleDocumentHandling,   getPageRanges,   getPrinter,   getSides,   getToPage,   hashCode,   set,   setCopies,   setCopiesToDefault,   setDefaultSelection,   setDestination,   setDialog,   setFileName,   setFromPage,   setMaxPage,   setMinPage,   setMultipleDocumentHandling,   setMultipleDocumentHandlingToDefault,   setPageRanges,   setPrinter,   setSides,   setSidesToDefault,   setToPage,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.awt.JobAttributes Detail:
 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. 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.

 public int getCopies() 
    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.
 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. This attribute is updated to the value chosen by the user.
 public DestinationType getDestination() 
    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.
 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. 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.
 public String getFileName() 
    Specifies the file name for the output file for jobs using these attributes. This attribute is updated to the value chosen by the user.
 public int getFromPage() 
    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.
 public int getMaxPage() 
    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.
 public int getMinPage() 
    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.
 public MultipleDocumentHandlingType getMultipleDocumentHandling() 
    Specifies the handling of multiple copies, including collation, for jobs using these attributes. This attribute is updated to the value chosen by the user.
 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. 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.
 public String getPrinter() 
    Returns the destination printer for jobs using these attributes. This attribute is updated to the value chosen by the user.
 public SidesType getSides() 
    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.
 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. 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.
 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. Not specifying this attribute is equivalent to specifying 1.
 public  void setCopiesToDefault() 
    Sets the number of copies the application should render for jobs using these attributes to the default. The default number of copies is 1.
 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. Not specifying this attribute is equivalent to specifying DefaultSelectionType.ALL.
 public  void setDestination(DestinationType destination) 
    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.
 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. 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.
 public  void setFileName(String fileName) 
    Specifies the file name for the output file for jobs using these attributes. Default is platform-dependent and implementation-defined.
 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. 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 } });
 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. Not specifying this attribute is equivalent to specifying Integer.MAX_VALUE.
 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. Not specifying this attribute is equivalent to specifying 1.
 public  void setMultipleDocumentHandling(MultipleDocumentHandlingType multipleDocumentHandling) 
    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.
 public  void setMultipleDocumentHandlingToDefault() 
    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.
 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. 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 } });
 public  void setPrinter(String printer) 
    Specifies the destination printer for jobs using these attributes. Default is platform-dependent and implementation-defined.
 public  void setSides(SidesType sides) 
    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.
 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. The default imposition is SidesType.ONE_SIDED.
 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. 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 } });
 public String toString() 
    Returns a string representation of this JobAttributes.