javax.print.attribute.standard
Class PrinterResolution

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.print.attribute.ResolutionSyntax sample code for javax.print.attribute.ResolutionSyntax definition code for javax.print.attribute.ResolutionSyntax 
      extended by javax.print.attribute.standard.PrinterResolution
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable , Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute , DocAttribute sample code for javax.print.attribute.DocAttribute definition code for javax.print.attribute.DocAttribute , PrintJobAttribute sample code for javax.print.attribute.PrintJobAttribute definition code for javax.print.attribute.PrintJobAttribute , PrintRequestAttribute sample code for javax.print.attribute.PrintRequestAttribute definition code for javax.print.attribute.PrintRequestAttribute

public final class PrinterResolution
extends ResolutionSyntax sample code for javax.print.attribute.ResolutionSyntax definition code for javax.print.attribute.ResolutionSyntax
implements DocAttribute sample code for javax.print.attribute.DocAttribute definition code for javax.print.attribute.DocAttribute , PrintRequestAttribute sample code for javax.print.attribute.PrintRequestAttribute definition code for javax.print.attribute.PrintRequestAttribute , PrintJobAttribute sample code for javax.print.attribute.PrintJobAttribute definition code for javax.print.attribute.PrintJobAttribute

Class PrinterResolution is a printing attribute class that specifies an exact resolution supported by a printer or to be used for a print job. This attribute assumes that printers have a small set of device resolutions at which they can operate rather than a continuum.

PrinterResolution is used in multiple ways:

  1. When a client searches looking for a printer that supports the client's desired resolution exactly (no more, no less), the client specifies an instance of class PrinterResolution indicating the exact resolution the client wants. Only printers supporting that exact resolution will match the search.

  2. When a client needs to print a job using the client's desired resolution exactly (no more, no less), the client specifies an instance of class PrinterResolution as an attribute of the Print Job. This will fail if the Print Job doesn't support that exact resolution, and Fidelity is set to true.
If a client wants to locate a printer supporting a resolution greater than some required minimum, then it may be necessary to exclude this attribute from a lookup request and to directly query the set of supported resolutions, and specify the one that most closely meets the client's requirements. In some cases this may be more simply achieved by specifying a PrintQuality attribute which often controls resolution.

IPP Compatibility: The information needed to construct an IPP "printer-resolution" attribute can be obtained by calling methods on the PrinterResolution object. The category name returned by getName() gives the IPP attribute name.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.print.attribute.ResolutionSyntax sample code for javax.print.attribute.ResolutionSyntax definition code for javax.print.attribute.ResolutionSyntax
DPCM sample code for javax.print.attribute.ResolutionSyntax.DPCM definition code for javax.print.attribute.ResolutionSyntax.DPCM , DPI sample code for javax.print.attribute.ResolutionSyntax.DPI definition code for javax.print.attribute.ResolutionSyntax.DPI
 
Constructor Summary
PrinterResolution sample code for javax.print.attribute.standard.PrinterResolution.PrinterResolution(int, int, int) definition code for javax.print.attribute.standard.PrinterResolution.PrinterResolution(int, int, int) (int crossFeedResolution, int feedResolution, int units)
          Construct a new printer resolution attribute from the given items.
 
Method Summary
 boolean equals sample code for javax.print.attribute.standard.PrinterResolution.equals(java.lang.Object) definition code for javax.print.attribute.standard.PrinterResolution.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  object)
          Returns whether this printer resolution attribute is equivalent to the passed in object.
 Class sample code for java.lang.Class definition code for java.lang.Class <? extends Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute > getCategory sample code for javax.print.attribute.standard.PrinterResolution.getCategory() definition code for javax.print.attribute.standard.PrinterResolution.getCategory() ()
          Get the printing attribute class which is to be used as the "category" for this printing attribute value.
 String sample code for java.lang.String definition code for java.lang.String getName sample code for javax.print.attribute.standard.PrinterResolution.getName() definition code for javax.print.attribute.standard.PrinterResolution.getName() ()
          Get the name of the category of which this attribute value is an instance.
 
Methods inherited from class javax.print.attribute.ResolutionSyntax sample code for javax.print.attribute.ResolutionSyntax definition code for javax.print.attribute.ResolutionSyntax
getCrossFeedResolution sample code for javax.print.attribute.ResolutionSyntax.getCrossFeedResolution(int) definition code for javax.print.attribute.ResolutionSyntax.getCrossFeedResolution(int) , getCrossFeedResolutionDphi sample code for javax.print.attribute.ResolutionSyntax.getCrossFeedResolutionDphi() definition code for javax.print.attribute.ResolutionSyntax.getCrossFeedResolutionDphi() , getFeedResolution sample code for javax.print.attribute.ResolutionSyntax.getFeedResolution(int) definition code for javax.print.attribute.ResolutionSyntax.getFeedResolution(int) , getFeedResolutionDphi sample code for javax.print.attribute.ResolutionSyntax.getFeedResolutionDphi() definition code for javax.print.attribute.ResolutionSyntax.getFeedResolutionDphi() , getResolution sample code for javax.print.attribute.ResolutionSyntax.getResolution(int) definition code for javax.print.attribute.ResolutionSyntax.getResolution(int) , hashCode sample code for javax.print.attribute.ResolutionSyntax.hashCode() definition code for javax.print.attribute.ResolutionSyntax.hashCode() , lessThanOrEquals sample code for javax.print.attribute.ResolutionSyntax.lessThanOrEquals(javax.print.attribute.ResolutionSyntax) definition code for javax.print.attribute.ResolutionSyntax.lessThanOrEquals(javax.print.attribute.ResolutionSyntax) , toString sample code for javax.print.attribute.ResolutionSyntax.toString() definition code for javax.print.attribute.ResolutionSyntax.toString() , toString sample code for javax.print.attribute.ResolutionSyntax.toString(int, java.lang.String) definition code for javax.print.attribute.ResolutionSyntax.toString(int, java.lang.String)
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

PrinterResolution sample code for javax.print.attribute.standard.PrinterResolution(int, int, int) definition code for javax.print.attribute.standard.PrinterResolution(int, int, int)

public PrinterResolution(int crossFeedResolution,
                         int feedResolution,
                         int units)
Construct a new printer resolution attribute from the given items.

Parameters:
crossFeedResolution - Cross feed direction resolution.
feedResolution - Feed direction resolution.
units - Unit conversion factor, e.g. ResolutionSyntax.DPI or ResolutionSyntax.>DPCM.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - (unchecked exception) Thrown if crossFeedResolution < 1 or feedResolution < 1 or units < 1.
Method Detail

equals sample code for javax.print.attribute.standard.PrinterResolution.equals(java.lang.Object) definition code for javax.print.attribute.standard.PrinterResolution.equals(java.lang.Object)

public boolean equals(Object sample code for java.lang.Object definition code for java.lang.Object  object)
Returns whether this printer resolution attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:
  1. object is not null.
  2. object is an instance of class PrinterResolution.
  3. This attribute's cross feed direction resolution is equal to object's cross feed direction resolution.
  4. This attribute's feed direction resolution is equal to object's feed direction resolution.

Overrides:
equals sample code for javax.print.attribute.ResolutionSyntax.equals(java.lang.Object) definition code for javax.print.attribute.ResolutionSyntax.equals(java.lang.Object) in class ResolutionSyntax sample code for javax.print.attribute.ResolutionSyntax definition code for javax.print.attribute.ResolutionSyntax
Parameters:
object - Object to compare to.
Returns:
True if object is equivalent to this printer resolution attribute, false otherwise.
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

getCategory sample code for javax.print.attribute.standard.PrinterResolution.getCategory() definition code for javax.print.attribute.standard.PrinterResolution.getCategory()

public final Class sample code for java.lang.Class definition code for java.lang.Class <? extends Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute > getCategory()
Get the printing attribute class which is to be used as the "category" for this printing attribute value.

For class PrinterResolution, the category is class PrinterResolution itself.

Specified by:
getCategory sample code for javax.print.attribute.Attribute.getCategory() definition code for javax.print.attribute.Attribute.getCategory() in interface Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute
Returns:
Printing attribute class (category), an instance of class java.lang.Class sample code for java.lang.Class definition code for java.lang.Class .

getName sample code for javax.print.attribute.standard.PrinterResolution.getName() definition code for javax.print.attribute.standard.PrinterResolution.getName()

public final String sample code for java.lang.String definition code for java.lang.String  getName()
Get the name of the category of which this attribute value is an instance.

For class PrinterResolution, the category name is "printer-resolution".

Specified by:
getName sample code for javax.print.attribute.Attribute.getName() definition code for javax.print.attribute.Attribute.getName() in interface Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute
Returns:
Attribute category name.