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

Size2DSyntax

• java.lang.Object

Fields Summary
private static final long	serialVersionUID
private int	x X dimension in units of micrometers (µm).
private int	y Y dimension in units of micrometers (µm).
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
protected Size2DSyntax(float x, float y, int units) Construct a new two-dimensional size attribute from the given floating-point values. param x X dimension. param y Y dimension. param units Unit conversion factor, e.g. {@link #INCH INCH} or {@link #MM MM}. exception IllegalArgumentException (Unchecked exception) Thrown if x < 0 or y < 0 or units < 1. if (x < 0.0f) { throw new IllegalArgumentException("x < 0"); } if (y < 0.0f) { throw new IllegalArgumentException("y < 0"); } if (units < 1) { throw new IllegalArgumentException("units < 1"); } this.x = (int) (x * units + 0.5f); this.y = (int) (y * units + 0.5f);
protected Size2DSyntax(int x, int y, int units) Construct a new two-dimensional size attribute from the given integer values. param x X dimension. param y Y dimension. param units Unit conversion factor, e.g. {@link #INCH INCH} or {@link #MM MM}. exception IllegalArgumentException (Unchecked exception) Thrown if x < 0 or y < 0 or units < 1. if (x < 0) { throw new IllegalArgumentException("x < 0"); } if (y < 0) { throw new IllegalArgumentException("y < 0"); } if (units < 1) { throw new IllegalArgumentException("units < 1"); } this.x = x * units; this.y = y * units;

Methods Summary
private static float	convertFromMicrometers(int x, int units) Convert a value from micrometers to some other units. The result is returned as a floating-point number. param x Value (micrometers) to convert. param units Unit conversion factor, e.g. {@link #INCH INCH} or {@link #MM MM}. return The value of x converted to the desired units. exception IllegalArgumentException (unchecked exception) Thrown if units < 1. if (units < 1) { throw new IllegalArgumentException("units is < 1"); } return ((float)x) / ((float)units);
public boolean	equals(java.lang.Object object) Returns whether this two-dimensional size 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 Size2DSyntax. This attribute's X dimension is equal to object's X dimension. This attribute's Y dimension is equal to object's Y dimension. param object Object to compare to. return True if object is equivalent to this two-dimensional size attribute, false otherwise. return(object != null && object instanceof Size2DSyntax && this.x == ((Size2DSyntax) object).x && this.y == ((Size2DSyntax) object).y);
public float[]	getSize(int units) Get this two-dimensional size attribute's dimensions in the given units as floating-point values. param units Unit conversion factor, e.g. {@link #INCH INCH} or {@link #MM MM}. return A two-element array with the X dimension at index 0 and the Y dimension at index 1. exception IllegalArgumentException (unchecked exception) Thrown if units < 1. return new float[] {getX(units), getY(units)};
public float	getX(int units) Returns this two-dimensional size attribute's X dimension in the given units as a floating-point value. param units Unit conversion factor, e.g. {@link #INCH INCH} or {@link #MM MM}. return X dimension. exception IllegalArgumentException (unchecked exception) Thrown if units < 1. return convertFromMicrometers(x, units);
protected int	getXMicrometers() Returns this two-dimensional size attribute's X dimension in units of micrometers (µm). (For use in a subclass.) return X dimension (µm). return x;
public float	getY(int units) Returns this two-dimensional size attribute's Y dimension in the given units as a floating-point value. param units Unit conversion factor, e.g. {@link #INCH INCH} or {@link #MM MM}. return Y dimension. exception IllegalArgumentException (unchecked exception) Thrown if units < 1. return convertFromMicrometers(y, units);
protected int	getYMicrometers() Returns this two-dimensional size attribute's Y dimension in units of micrometers (µm). (For use in a subclass.) return Y dimension (µm). return y;
public int	hashCode() Returns a hash code value for this two-dimensional size attribute. return (((x & 0x0000FFFF) ) | ((y & 0x0000FFFF) << 16));
public java.lang.String	toString() Returns a string version of this two-dimensional size attribute. The string takes the form "XxY um", where X is the X dimension and Y is the Y dimension. The values are reported in the internal units of micrometers. StringBuffer result = new StringBuffer(); result.append(x); result.append('x"); result.append(y); result.append(" um"); return result.toString();
public java.lang.String	toString(int units, java.lang.String unitsName) Returns a string version of this two-dimensional size attribute in the given units. The string takes the form "XxY U", where X is the X dimension, Y is the Y dimension, and U is the units name. The values are displayed in floating point. 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. StringBuffer result = new StringBuffer(); result.append(getX (units)); result.append('x"); result.append(getY (units)); if (unitsName != null) { result.append(' "); result.append(unitsName); } return result.toString();