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:

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 declared in class ResolutionSyntax

DPCM, DPI

Modifier and Type	Field	Description
static final int	DPCM	Value to indicate units of dots per centimeter (dpcm).
static final int	DPI	Value to indicate units of dots per inch (dpi).

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)	Returns whether this printer resolution attribute is equivalent to the passed in object.
final Class<? extends Attribute>	getCategory()	Get the printing attribute class which is to be used as the "category" for this printing attribute value.
final String	getName()	Get the name of the category of which this attribute value is an instance.

Methods declared in class ResolutionSyntax

getCrossFeedResolution, getCrossFeedResolutionDphi, getFeedResolution, getFeedResolutionDphi, getResolution, hashCode, lessThanOrEquals, toString, toString

Modifier and Type	Method	Description
int	getCrossFeedResolution(int units)	Returns this resolution attribute's cross feed direction resolution in the given units.
protected int	getCrossFeedResolutionDphi()	Returns this resolution attribute's cross feed direction resolution in units of dphi.
int	getFeedResolution(int units)	Returns this resolution attribute's feed direction resolution in the given units.
protected int	getFeedResolutionDphi()	Returns this resolution attribute's feed direction resolution in units of dphi.
int[]	getResolution(int units)	Get this resolution attribute's resolution values in the given units.
int	hashCode()	Returns a hash code value for this resolution attribute.
boolean	lessThanOrEquals(ResolutionSyntax other)	Determine whether this resolution attribute's value is less than or equal to the given resolution attribute's value.
String	toString()	Returns a string version of this resolution attribute.
String	toString(int units, String unitsName)	Returns a string version of this resolution attribute in the given units.

Methods declared in class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Constructor Details

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 or ResolutionSyntax.DPCM

Throws:

IllegalArgumentException - if crossFeedResolution < 1 or feedResolution < 1 or units < 1

Method Details

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:

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 in class ResolutionSyntax

Parameters:

object - Object to compare to

Returns:

true if object is equivalent to this printer resolution attribute, false otherwise

See Also:

• Object.hashCode()

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 interface Attribute

Returns:

printing attribute class (category), an instance of class java.lang.Class

getName

public final 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 in interface Attribute

Returns:

attribute category name