public class Measure
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable
add
,
subtract
and scale
. You should create immutable
measures using the factory because the factory caches measures. This can
be very helpful to safe memory.Modifier and Type | Class and Description |
---|---|
static class |
Measure.Factory
The factory creates immutable measure and caches them.
|
static class |
Measure.Unit
Represents a unit.
|
Modifier and Type | Field and Description |
---|---|
static Measure.Unit |
CM
Unit CM
|
static Measure.Unit |
EMU
Unit EMU (12700 EMU = 1 Point)
|
static Measure.Unit |
INCH
Unit Inch
|
static Measure.Unit |
MM
Unit MM
|
static Measure.Unit |
PERCENTAGE
Unit Percentage (relative)
|
static Measure.Unit |
POINTS
Unit Points
|
static Measure.Unit |
TWIPS
Unit Twips
|
Constructor and Description |
---|
Measure(Measure.Unit unit,
double value)
Creates a measure.
|
Measure(Measure.Unit unit,
double value,
int scaling)
Creates a measure.
|
Measure(Measure.Unit unit,
double value,
Measure.Unit preferedOutputUnit)
Creates a measure.
|
Measure(java.lang.String value)
Creates a measure by parsing the given string.
|
Modifier and Type | Method and Description |
---|---|
Measure |
add(Measure m)
Adds the given Measure to this Measure and returns a new measure object.
|
Measure |
add(java.lang.String value)
Adds the given value to this Measure and returns a new measure object.
|
void |
changeUnit(Measure.Unit u)
Changes the unit and the value is updated related to given unit.
|
Measure |
cloned()
Clones this measure.
|
int |
compareTo(java.lang.Object o) |
static double |
convert(Measure.Unit fromUnit,
double fromValue,
Measure.Unit toUnit) |
static boolean |
equals(Measure m1,
Measure m2)
Tests, if two measures are equal.
|
boolean |
equals(java.lang.Object o)
Checks for equality.
|
double |
getCM() |
double |
getInch() |
double |
getPercentage() |
double |
getPoints() |
Measure.Unit |
getPreferredUnit()
Deprecated.
Use getUnit()
|
int |
getScaling() |
Measure.Unit |
getUnit() |
double |
getValue(Measure.Unit unit)
Gets the value for a given unit.
|
double |
getValue(Measure.Unit unit,
int roundIdx)
Gets the value for a given unit and round it.
|
int |
hashCode() |
boolean |
isEqual(Measure m)
Tests, if
m |
boolean |
isGreater(Measure m)
Tests, if
this |
boolean |
isLess(Measure m)
Tests, if
this |
boolean |
isRelativ()
Tests, if this measure is relative (e.g. percentage).
|
static Measure |
max(Measure m1,
Measure m2)
Determinates the maximum of given measures.
|
Measure |
multiply(double factor)
Scales this measure.
|
Measure |
negate()
Gets a negated value of this measure.
|
void |
setPreferredUnit(Measure.Unit unit)
Deprecated.
Use changeUnit
|
void |
setScaling(int scale) |
int |
signum()
Returns the signum function of this Measure.
|
Measure |
subtract(Measure m)
Subtracts the given Measure from this measure and returns a new measure object.
|
Measure |
subtract(java.lang.String value)
Subtracts value from this measure and returns a new measure object.
|
java.lang.String |
toString()
Gets a string-representation of this measure.
|
java.lang.String |
toString(int precision)
Gets a string-representation of this measure.
|
java.lang.String |
toString(Measure.Unit unit)
Gets a string representation in given unit.
|
java.lang.String |
toString(Measure.Unit unit,
int precision)
Gets a rounded string representation in given unit.
|
public static final Measure.Unit CM
public static final Measure.Unit MM
public static final Measure.Unit POINTS
public static final Measure.Unit TWIPS
public static final Measure.Unit INCH
public static final Measure.Unit PERCENTAGE
public static final Measure.Unit EMU
public Measure(java.lang.String value)
value
- String representation.public Measure(Measure.Unit unit, double value)
unit
- Unit of the value.value
- Value.public Measure(Measure.Unit unit, double value, Measure.Unit preferedOutputUnit)
unit
- Unit of the value.value
- Value.preferedOutputUnit
- Unit used by toString()-Methodes.public Measure(Measure.Unit unit, double value, int scaling)
unit
- Unit of the value.value
- Value.scaling
- Scale of value.public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- Object to check.true
, if o
is a measure with equal
length.public boolean isGreater(Measure m)
this is greater than m.
m
- Measuretrue if greater.
public boolean isLess(Measure m)
this is less than m.
m
- Measuretrue if less.
public boolean isEqual(Measure m)
m is equal to this measure.
m
- Measuretrue if equal.
public double getValue(Measure.Unit unit)
unit
- Unit.public double getPoints()
public double getCM()
public double getInch()
public double getPercentage()
public double getValue(Measure.Unit unit, int roundIdx)
unit
- Unit.roundIdx
- Round index (decimal places)public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toString(int precision)
precision
- The optional number of decimal digits to round to.public java.lang.String toString(Measure.Unit unit)
unit
- Unit.public java.lang.String toString(Measure.Unit unit, int precision)
unit
- Unit.precision
- The optional number of decimal digits to round to.public Measure multiply(double factor)
factor
- Scale-Factor.java.lang.IllegalArgumentException
- if immutable.public boolean isRelativ()
public Measure add(Measure m)
m
- Measure.public Measure add(java.lang.String value)
value
- Value to add.public Measure subtract(Measure m)
m
- Measure.public Measure subtract(java.lang.String value)
value
- Value to subtract.public Measure cloned()
public static Measure max(Measure m1, Measure m2)
m1
- Measure one.m2
- Measure two.public static boolean equals(Measure m1, Measure m2)
null
.m1
- First measure.m2
- Second measure.true
, if equal.public static double convert(Measure.Unit fromUnit, double fromValue, Measure.Unit toUnit)
public void changeUnit(Measure.Unit u)
u
- public Measure.Unit getUnit()
public Measure.Unit getPreferredUnit()
public void setPreferredUnit(Measure.Unit unit)
unit
- Preferred unit.public void setScaling(int scale)
public int getScaling()
public Measure negate()
public int hashCode()
hashCode
in class java.lang.Object
public int signum()
public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
© 2003-2011 by Sascha Schmidt (vision-cloud.de). All Rights Reserved.