File	Doc	Category	Size	Date	Package
MediaPrintableArea.java	API Doc	Java SE 5 API	11369	Fri Aug 26 14:57:44 BST 2005	javax.print.attribute.standard

MediaPrintableArea

• java.lang.Object

Fields Summary
private int	x
private int	y
private int	w
private int	h
private int	units
private static final long	serialVersionUID
public static final int	INCH Value to indicate units of inches (in). It is actually the conversion factor by which to multiply inches to yield µm (25400).
public static final int	MM Value to indicate units of millimeters (mm). It is actually the conversion factor by which to multiply mm to yield µm (1000).

Constructors Summary
public MediaPrintableArea(float x, float y, float w, float h, int units) Constructs a MediaPrintableArea object from floating point values. param x printable x param y printable y param w printable width param h printable height param units in which the values are expressed. exception IllegalArgumentException Thrown if x < 0 or y < 0 or w <= 0 or h <= 0 or units < 1. if ((x < 0.0) || (y < 0.0) || (w <= 0.0) || (h <= 0.0) || (units < 1)) { throw new IllegalArgumentException("0 or negative value argument"); } this.x = (int) (x * units + 0.5f); this.y = (int) (y * units + 0.5f); this.w = (int) (w * units + 0.5f); this.h = (int) (h * units + 0.5f);
public MediaPrintableArea(int x, int y, int w, int h, int units) Constructs a MediaPrintableArea object from integer values. param x printable x param y printable y param w printable width param h printable height param units in which the values are expressed. exception IllegalArgumentException Thrown if x < 0 or y < 0 or w <= 0 or h <= 0 or units < 1. if ((x < 0) || (y < 0) || (w <= 0) || (h <= 0) || (units < 1)) { throw new IllegalArgumentException("0 or negative value argument"); } this.x = x * units; this.y = y * units; this.w = w * units; this.h = h * units;

Methods Summary
private static float	convertFromMicrometers(int x, int units) if (units < 1) { throw new IllegalArgumentException("units is < 1"); } return ((float)x) / ((float)units);
public boolean	equals(java.lang.Object object) Returns whether this media margins 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 MediaPrintableArea. The origin and dimensions are the same. param object Object to compare to. return True if object is equivalent to this media margins attribute, false otherwise. boolean ret = false; if (object instanceof MediaPrintableArea) { MediaPrintableArea mm = (MediaPrintableArea)object; if (x == mm.x && y == mm.y && w == mm.w && h == mm.h) { ret = true; } } return ret;
public final java.lang.Class	getCategory() Get the printing attribute class which is to be used as the "category" for this printing attribute value. For class MediaPrintableArea, the category is class MediaPrintableArea itself. return Printing attribute class (category), an instance of class {@link java.lang.Class java.lang.Class}. return MediaPrintableArea.class;
public float	getHeight(int units) Get the height of the printable area in the specified units. param units Unit conversion factor, e.g. {@link #INCH INCH} or {@link #MM MM}. return height of the printable area in the specified units. exception IllegalArgumentException (unchecked exception) Thrown if units < 1. return convertFromMicrometers(h, units);
public final java.lang.String	getName() Get the name of the category of which this attribute value is an instance. For class MediaPrintableArea, the category name is "media-printable-area". This is not an IPP V1.1 attribute. return Attribute category name. return "media-printable-area";
public float[]	getPrintableArea(int units) Get the printable area as an array of 4 values in the order x, y, w, h. The values returned are in the given units. param units Unit conversion factor, e.g. {@link #INCH INCH} or {@link #MM MM}. return printable area as array of x, y, w, h in the specified units. exception IllegalArgumentException (unchecked exception) Thrown if units < 1. return new float[] { getX(units), getY(units), getWidth(units), getHeight(units) };
public float	getWidth(int units) Get the width of the printable area in the specified units. param units Unit conversion factor, e.g. {@link #INCH INCH} or {@link #MM MM}. return width of the printable area in the specified units. exception IllegalArgumentException (unchecked exception) Thrown if units < 1. return convertFromMicrometers(w, units);
public float	getX(int units) Get the x location of the origin of the printable area in the specified units. param units Unit conversion factor, e.g. {@link #INCH INCH} or {@link #MM MM}. return x location of the origin of the printable area in the specified units. exception IllegalArgumentException (unchecked exception) Thrown if units < 1. return convertFromMicrometers(x, units);
public float	getY(int units) Get the y location of the origin of the printable area in the specified units. param units Unit conversion factor, e.g. {@link #INCH INCH} or {@link #MM MM}. return y location of the origin of the printable area in the specified units. exception IllegalArgumentException (unchecked exception) Thrown if units < 1. return convertFromMicrometers(y, units);
public int	hashCode() Returns a hash code value for this attribute. return x + 37*y + 43*w + 47*h;
public java.lang.String	toString(int units, java.lang.String unitsName) Returns a string version of this rectangular size attribute in the given units. param units Unit conversion factor, e.g. {@link #INCH INCH} or {@link #MM MM}. param unitsName Units name string, e.g. "in" or "mm". If null, no units name is appended to the result. return String version of this two-dimensional size attribute. exception IllegalArgumentException (unchecked exception) Thrown if units < 1. if (unitsName == null) { unitsName = ""; } float []vals = getPrintableArea(units); String str = "("+vals[0]+","+vals[1]+")->("+vals[2]+","+vals[3]+")"; return str + unitsName;
public java.lang.String	toString() Returns a string version of this rectangular size attribute in mm. return(toString(MM, "mm"));