Size2DSyntax is the abstract base class of all attribute
* classes which provide a two dimensional size as value (e.g. the size of
* a media like Letter or A4).
*
* A Size2DSyntax instance consists of two integer values
* describing the size in the x and y dimension. The units of
* the given values is determined by two defined constants:
*
* A size 2D attribute is constructed by two values for the size of the x and * y dimension and the actual units of the given values as defined by the * constants. *
** There are different methods provided to return the size values for the * dimensions in either of the two predefined units or with a given client * supplied units conversion factor. *
*
* Internal storage:
* The size of the x,y dimensions 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. Clients are therefore able to provide their own
* size units by supplying other conversion factors.
* Subclasses of Size2DSyntax have access to the internal
* size values through the protected methods
* {@link #getXMicrometers()} and {@link #getYMicrometers()}.
*
Size2DSyntax object with the given arguments.
*
* @param x the size in x direction
* @param y the size in y direction
* @param units the units to use for the sizes
*
* @exception IllegalArgumentException if x or y < 0 or units < 1
*/
protected Size2DSyntax(float x, float y, int units)
{
if (x < 0.0f || y < 0.0f)
throw new IllegalArgumentException("x and/or y may not be less than 0");
if (units < 1)
throw new IllegalArgumentException("units may not be less then 1");
this.x = (int) (x * units + 0.5f);
this.y = (int) (y * units + 0.5f);
}
/**
* Creates a Size2DSyntax object with the given arguments.
*
* @param x the size in x direction
* @param y the size in y direction
* @param units the units to use for the sizes
*
* @exception IllegalArgumentException if x or y < 0 or units < 1
*/
protected Size2DSyntax(int x, int y, int units)
{
if (x < 0 || y < 0)
throw new IllegalArgumentException("x and/or y may not be less then 0");
if (units < 1)
throw new IllegalArgumentException("units may not be less then 1");
this.x = x * units;
this.y = y * units;
}
/**
* Tests if the given object is equal to this object.
*
* @param obj the object to test
*
* @return true if both objects are equal, false otherwise.
*/
public boolean equals(Object obj)
{
if (! (obj instanceof Size2DSyntax))
return false;
Size2DSyntax tmp = (Size2DSyntax) obj;
return (x == tmp.getXMicrometers()
&& y == tmp.getYMicrometers());
}
/**
* Returns the size described in this object as a two field array.
* Index 0 contains the size in x direction, index 1 the size in
* y direction.
*
* @param units the units to use
*
* @return The array with the size dimensions.
*
* @exception IllegalArgumentException if units < 1
*/
public float[] getSize(int units)
{
float[] size = new float[2];
size[0] = getX(units);
size[1] = getY(units);
return size;
}
/**
* Returns the size in x direction.
*
* @param units the units to use
*
* @return The size in x direction.
*
* @exception IllegalArgumentException if units < 1
*/
public float getX(int units)
{
if (units < 1)
throw new IllegalArgumentException("units may not be less then 1");
return ((float) x) / ((float) units);
}
/**
* Returns the size in x direction in mircometers.
* To be used by sublcasses that need access to the internal storage value.
*
* @return The size in x direction in micrometers.
*/
protected int getXMicrometers()
{
return x;
}
/**
* Return the size in y direction.
*
* @param units the units to use
*
* @return The size in y direction.
*
* @exception IllegalArgumentException if units < 1
*/
public float getY(int units)
{
if (units < 1)
throw new IllegalArgumentException("units may not be less then 1");
return ((float) y) / ((float) units);
}
/**
* Returns the size in y direction in mircometers.
* To be used by sublcasses that need access to the internal storage value.
*
* @return The size in y direction in micrometers.
*/
protected int getYMicrometers()
{
return y;
}
/**
* Returns the hashcode for this object.
*
* @return The hashcode.
*/
public int hashCode()
{
return x + y;
}
/**
* Returns the string representation for this object.
* * The returned string is in the form "XxY um" with X standing * for size in x and Y for the size in y direction. The used * micrometers units is indicated by the appended "um" notation. *
* * @return The string representation in micrometers. */ public String toString() { return getXMicrometers() + "x" + getYMicrometers() + " um"; } /** * Returns the string representation for this object. ** The returned string is in the form "XxY U" with X standing * for size in x and Y for the size in y direction. U denotes * the units name if one is supplied. The values are given as * floating point values. *
* * @param units the units to use * @param unitsName the name of the units. Ifnull
* it is ommitted from the string representation.
*
* @return The string representation.
*/
public String toString(int units, String unitsName)
{
if (unitsName == null)
return getX(units) + "x" + getY(units);
return getX(units) + "x" + getY(units) + " " + unitsName;
}
}