javax.print.attribute
Class ResolutionSyntax
- Cloneable, Serializable
ResolutionSyntax is the abstract base class of all attribute
classes which provide a resolution as value (e.g. printer resolution).
A
ResolutionSyntax instance consists of two integer values
describing the resolution in feed and cross feed direction. The units of
the given values is determined by two defined constants:
- DPCM - dots per centimeter
- DPI - dots per inch
A resolutions attribute is constructed by two values for the resolution and
one of the two constants defining the actual units of the given values.
There are different methods provided to return the resolution values in
either of the both units and to compare if a resolution is less than or
equal to a given other resolution attribute.
Internal storage:
The resolutions are stored internally as dots per 100 inches (dphi). The
values of the provided constants for dots per inch (value 100) and dots
per centimeter (value 254) are used as conversion factors to the internal
storage units. To get the internal dphi values a multiplication of a given
resolution value with its units constant value is needed. Retrieving the
resolution for specific units is done by dividing the internal stored
value through the units constant value. Clients are therefore able to
provide their own resolution units by supplying other conversion factors.
Subclasses of
ResolutionSyntax have access to the internal
resolution values through the protected methods
getCrossFeedResolutionDphi() and
getFeedResolutionDphi().
static int | DPCM- Constant for units of dots per centimeter.
|
static int | DPI- Constant for units of dots per inch
|
ResolutionSyntax(int crossFeedResolution, int feedResolution, int units)- Creates a
ResolutionSyntax object with the given arguments.
|
clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait |
DPCM
public static final int DPCM
Constant for units of dots per centimeter.
DPI
public static final int DPI
Constant for units of dots per inch
ResolutionSyntax
public ResolutionSyntax(int crossFeedResolution,
int feedResolution,
int units) Creates a ResolutionSyntax object with the given arguments.
crossFeedResolution - the cross feed resolutionfeedResolution - the feed resolutionunits - the unit to use (e.g. DPCM or DPI)
equals
public boolean equals(Object obj)
Tests if the given object is equal to this object.
- equals in interface Object
true if both objects are equal,
false otherwise.
getCrossFeedResolution
public int getCrossFeedResolution(int units)
Returns the cross feed resolution for the given units.
units - the unit to use (e.g. DPCM or DPI)
- The resolution for the given units.
getCrossFeedResolutionDphi
protected int getCrossFeedResolutionDphi()
Returns the raw cross feed resolution in dots per 100 inches.
getFeedResolution
public int getFeedResolution(int units)
Returns the feed resolution for the given units.
units - the unit to use (e.g. DPCM or DPI)
- The resolution for the given units.
getFeedResolutionDphi
protected int getFeedResolutionDphi()
Returns the raw feed resolution in dots per 100 inches.
getResolution
public int[] getResolution(int units)
Returns the resolution as two field array. Index 0 is the cross feed
resolution, index 1 the feed resolution.
- The array with the resolutions.
lessThanOrEquals
public boolean lessThanOrEquals(ResolutionSyntax other)
Checks if the given resolution attribute is a lower or equal
to this resolution object.
other - the resolution to check against
true if other resolution attribute describes
a lower or equal resolution, false otherwise.
toString
public String toString()
Returns the string representation for this object.
The returned string is in the form "CxF dphi" with C standing
for the cross feed and F for the feed direction resolution.
Units used are dots per 100 inches (dphi).
- toString in interface Object
- The string representation.
toString
public String toString(int units,
String unitsName) Returns the string representation for this object.
The returned string is in the form "CxF U" with C standing
for the cross feed and F for the feed direction resolution.
U denotes the units name if one is supplied.
units - the units to useunitsName - the name of the units. If null
it is ommitted from the string representation.
- The string representation.
ResolutionSyntax.java --
Copyright (C) 2003, 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.