com.hfg.graphics.units.GfxSize Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
package com.hfg.graphics.units;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import com.hfg.units.UnitException;
import com.hfg.util.StringUtil;
//------------------------------------------------------------------------------
/**
* Interface for a unit-independent graphic length measurement.
*
* @author J. Alex Taylor, hairyfatguy.com
*/
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------
public interface GfxSize
{
public GfxSizeImpl setGfxContext(GfxContext inValue);
public float to(GfxUnits inUnits);
public int toInt(GfxUnits inUnits);
public float value();
public GfxUnits getUnits();
public GfxSize add(GfxSize inValue);
public GfxSize subtract(GfxSize inValue);
public void scale(float inScalingFactor);
static final Pattern MEASUREMENT_PATTERN = Pattern.compile("(\\-?[\\d\\.]+)\\s*(\\w+)?");
static final Pattern INT_WITH_UNITS_PATTERN = Pattern.compile("(-?\\d+)\\s?+([^\\d]+)");
static final Pattern DOUBLE_WITH_UNITS_PATTERN = Pattern.compile("(-?\\d+\\.\\d+)\\s?+([^\\d]+)");
static final Pattern SCIENTIFIC_NOTATION_WITH_UNITS_PATTERN = Pattern.compile("(-?\\d+(?:\\.\\d+)?E\\-?\\d+)\\s?+(\\S+)");
//---------------------------------------------------------------------------
/**
Convenience allocator that accepts a string with a value followed by units.
* @param inStringValue the string value
*/
public static GfxSize allocate(String inStringValue)
{
float floatVal;
GfxUnits units;
Matcher m = INT_WITH_UNITS_PATTERN.matcher(inStringValue.trim());
if (m.matches())
{
floatVal = Float.parseFloat(m.group(1));
units = GfxUnits.valueOf(m.group(2));
}
else
{
m = DOUBLE_WITH_UNITS_PATTERN.matcher(inStringValue.trim());
if (m.matches())
{
floatVal = Float.parseFloat(m.group(1));
units = GfxUnits.valueOf(m.group(2));
}
else
{
m = SCIENTIFIC_NOTATION_WITH_UNITS_PATTERN.matcher(inStringValue.trim());
if (m.matches())
{
floatVal = Float.parseFloat(m.group(1));
units = GfxUnits.valueOf(m.group(2));
}
else
{
throw new UnitException("Couldn't parse " + StringUtil.singleQuote(inStringValue) + " into a GfxSize!");
}
}
}
if (null == units)
{
throw new UnitException("Couldn't parse " + StringUtil.singleQuote(inStringValue) + " into a GfxSize! Unrecognized units value.");
}
GfxSize size = null;
if (units.equals(GfxUnits.pixels))
{
size = new Pixels((int)floatVal);
}
else if (units.equals(GfxUnits.points))
{
size = new Points(floatVal);
}
else if (units.equals(GfxUnits.dxa))
{
size = new Points(floatVal / 20);
}
else if (units.equals(GfxUnits.inches))
{
size = new Points(floatVal * 72f); // There are 72 points per inch
}
else if (units.equals(GfxUnits.millimeters))
{
size = new Points(floatVal * 2.835f); // There are 2.835 points per inch
}
return size;
}
//--------------------------------------------------------------------------
/**
Function for converting a string representation of a graphics measurement into its appropriate object.
@param inStringValue the string representation (ex: "10px", "12pt", or "17.5")
@param inDefaultUnits the units to use if the string representation is unit-less.
@return a GfxSize-extending object
*/
public static GfxSize allocate(String inStringValue, GfxUnits inDefaultUnits)
{
if (! StringUtil.isSet(inStringValue))
{
throw new RuntimeException("No String value sent to GfxSize.allocate()!");
}
inStringValue = inStringValue.trim();
Matcher m = MEASUREMENT_PATTERN.matcher(inStringValue);
if (! m.matches())
{
throw new RuntimeException(StringUtil.singleQuote(inStringValue) + " could not be interpreted by GfxSize.allocate()!");
}
float floatVal = Float.parseFloat(m.group(1));
GfxSize size = null;
GfxUnits units = GfxUnits.valueOf(m.group(2));
if (null == units)
{
units = inDefaultUnits;
}
if (units.equals(GfxUnits.pixels))
{
size = new Pixels((int)floatVal);
}
else if (units.equals(GfxUnits.points))
{
size = new Points(floatVal);
}
else if (units.equals(GfxUnits.dxa))
{
size = new Points(floatVal / 20);
}
else if (units.equals(GfxUnits.inches))
{
size = new Points(floatVal * 72f); // There are 72 points per inch
}
return size;
}
//--------------------------------------------------------------------------
/**
Function for constructing a GfxSize object.
@param inValue the integer value
@param inUnits the units to use
@return a GfxSize-extending object
*/
public static GfxSize allocate(int inValue, GfxUnits inUnits)
{
return new GfxSizeImpl(inValue, inUnits);
}
//--------------------------------------------------------------------------
/**
Function for constructing a GfxSize object.
@param inValue the float value
@param inUnits the units to use
@return a GfxSize-extending object
*/
public static GfxSize allocate(float inValue, GfxUnits inUnits)
{
return new GfxSizeImpl(inValue, inUnits);
}
//---------------------------------------------------------------------------
public default boolean greaterThan(GfxSize inValue)
{
boolean result = false;
if (inValue != null)
{
result = to(getUnits()) > inValue.to(getUnits());
}
return result;
}
//---------------------------------------------------------------------------
public default boolean lessThan(GfxSize inValue)
{
boolean result = false;
if (inValue != null)
{
result = to(getUnits()) < inValue.to(getUnits());
}
return result;
}
}