Class PrinterResolution
- java.lang.Object
-
- javax.print.attribute.ResolutionSyntax
-
- javax.print.attribute.standard.PrinterResolution
-
- All Implemented Interfaces:
- Serializable, Cloneable, Attribute, DocAttribute, PrintJobAttribute, PrintRequestAttribute
public final class PrinterResolution extends ResolutionSyntax implements DocAttribute, PrintRequestAttribute, 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:
- 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.
- 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.
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 bygetName()
gives the IPP attribute name.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class javax.print.attribute.ResolutionSyntax
DPCM, DPI
-
-
Constructor Summary
Constructors Constructor and Description PrinterResolution(int crossFeedResolution, int feedResolution, int units)
Construct a new printer resolution attribute from the given items.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description boolean
equals(Object object)
Returns whether this printer resolution attribute is equivalent to the passed in object.Class<? extends Attribute>
getCategory()
Get the printing attribute class which is to be used as the "category" for this printing attribute value.String
getName()
Get the name of the category of which this attribute value is an instance.-
Methods inherited from class javax.print.attribute.ResolutionSyntax
getCrossFeedResolution, getCrossFeedResolutionDphi, getFeedResolution, getFeedResolutionDphi, getResolution, hashCode, lessThanOrEquals, toString, toString
-
-
-
-
Constructor Detail
PrinterResolution
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
orResolutionSyntax.DPCM
. - Throws:
-
IllegalArgumentException
- (unchecked exception) Thrown ifcrossFeedResolution < 1
orfeedResolution < 1
orunits < 1
.
-
Method Detail
equals
public boolean equals(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:object
is not null.object
is an instance of class PrinterResolution.- This attribute's cross feed direction resolution is equal to
object
's cross feed direction resolution. - This attribute's feed direction resolution is equal to
object
's feed direction resolution.
- Overrides:
-
equals
in classResolutionSyntax
- Parameters:
-
object
- Object to compare to. - Returns:
-
True if
object
is equivalent to this printer resolution attribute, false otherwise. - See Also:
-
Object.hashCode()
,HashMap
getCategory
public final Class<? extends 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
in interfaceAttribute
- Returns:
-
Printing attribute class (category), an instance of class
java.lang.Class
.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.