javax.print.attribute.standard
public final class MediaPrintableArea extends Object implements DocAttribute, PrintJobAttribute, PrintRequestAttribute
MediaPrintableArea
attribute specifies the area
of a media sheet which is available for printing.
Due to hardware limitation its not possible with most printers to use the whole area of a media sheet for printing. This attribute defines the area for printing through the values of the upper left corner position (x,y) on the sheet and the available width and height of the area. The units of the values are determined by two defined constants:
Internal storage:
The values of x, y, width and height are stored internally in micrometers.
The values of the provided constants for inch (value 25400) and millimeters
(value 1000) are used as conversion factors to the internal storage units.
To get the internal micrometers values a multiplication of a given
size value with its units constant value is done. Retrieving the size value
for specific units is done by dividing the internal stored value by the
units constant value.
IPP Compatibility: MediaPrintableArea is not an IPP 1.1 attribute.
Modifier and Type | Field and Description |
---|---|
static int |
INCH
Constant for the units of inches.
|
static int |
MM
Constant for the units of millimeters.
|
Constructor and Description |
---|
MediaPrintableArea(float x,
float y,
float w,
float h,
int units)
Creates a new
MediaPrintableArea object with the given
float values for the given units. |
MediaPrintableArea(int x,
int y,
int w,
int h,
int units)
Creates a new
MediaPrintableArea object with the given
int values for the given units. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj)
Tests if the given object is equal to this object.
|
Class<? extends Attribute> |
getCategory()
Returns category of this class.
|
float |
getHeight(int units)
Returns the height of the printable area for the given units.
|
String |
getName()
Returns the name of this attribute.
|
float[] |
getPrintableArea(int units)
Returns the printable area as an float[] with 4 values
(order x, y, width, height) in the given units.
|
float |
getWidth(int units)
Returns the width of the printable area for the given units.
|
float |
getX(int units)
Returns the position in x direction of the printable area
for the given units.
|
float |
getY(int units)
Returns the position in y direction of the printable area
for the given units.
|
int |
hashCode()
Returns the hashcode for this object.
|
String |
toString()
Returns the string representation for this object in units of millimeters..
|
String |
toString(int units,
String unitsName)
Returns the string representation for this object in units of millimeters..
|
public static final int INCH
public static final int MM
public MediaPrintableArea(float x, float y, float w, float h, int units)
MediaPrintableArea
object with the given
float values for the given units.x
- start of the printable area on the sheet in x direction.y
- start of the printable area on the sheet in y direction.w
- the width of the printable area.h
- the height of the printable area.units
- the units of the given values.IllegalArgumentException
- if x i< 0 or y i< 0 or w i<= 0
or h i<= 0 or units i< 1public MediaPrintableArea(int x, int y, int w, int h, int units)
MediaPrintableArea
object with the given
int values for the given units.x
- start of the printable area on the sheet in x direction.y
- start of the printable area on the sheet in y direction.w
- the width of the printable area.h
- the height of the printable area.units
- the units of the given values.IllegalArgumentException
- if x i< 0 or y i< 0 or w i<= 0
or h i<= 0 or units i< 1public Class<? extends Attribute> getCategory()
getCategory
in interface Attribute
MediaPrintableArea
itself.public float getHeight(int units)
units
- the units conversion factor.IllegalArgumentException
- if units
is < 1public float getWidth(int units)
units
- the units conversion factor.IllegalArgumentException
- if units
is < 1public float getX(int units)
units
- the units conversion factor.IllegalArgumentException
- if units
is < 1public float getY(int units)
units
- the units conversion factor.IllegalArgumentException
- if units
is < 1public boolean equals(Object obj)
equals
in class Object
obj
- the object to testtrue
if both objects are equal, false
otherwise.Object.hashCode()
public String toString()
The returned string is in the form "(x,y)->(width,height)mm".
toString
in class Object
Object.getClass()
,
Object.hashCode()
,
Class.getName()
,
Integer.toHexString(int)
public int hashCode()
hashCode
in class Object
Object.equals(Object)
,
System.identityHashCode(Object)
public String toString(int units, String unitsName)
The returned string is in the form "(x,y)->(width,height)unitsName".
units
- the units to use for conversion.unitsName
- the name of the used units, appended to the resulting
string if not null
.IllegalArgumentException
- if units
is < 1public float[] getPrintableArea(int units)
units
- the units to use.