com.itextpdf.layout.property.UnitValue Maven / Gradle / Ivy
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2019 iText Group NV
Authors: Bruno Lowagie, Paulo Soares, et al.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License version 3
as published by the Free Software Foundation with the addition of the
following permission added to Section 15 as permitted in Section 7(a):
FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
OF THIRD PARTY RIGHTS
This program 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program; if not, see http://www.gnu.org/licenses or write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA, 02110-1301 USA, or download the license from the following URL:
http://itextpdf.com/terms-of-use/
The interactive user interfaces in modified source and object code versions
of this program must display Appropriate Legal Notices, as required under
Section 5 of the GNU Affero General Public License.
In accordance with Section 7(b) of the GNU Affero General Public License,
a covered work must retain the producer line in every PDF that is created
or manipulated using iText.
You can be released from the requirements of the license by purchasing
a commercial license. Buying such a license is mandatory as soon as you
develop commercial activities involving the iText software without
disclosing the source code of your own applications.
These activities include: offering paid services to customers as an ASP,
serving PDFs on the fly in a web application, shipping iText with a closed
source product.
For more information, please contact iText Software Corp. at this
address: [email protected]
*/
package com.itextpdf.layout.property;
import com.itextpdf.io.util.MessageFormatUtil;
/**
* A specialized class that holds a value and the unit it is measured in.
*/
public class UnitValue {
public static final int POINT = 1;
public static final int PERCENT = 2;
protected int unitType;
protected float value;
/**
* Creates a UnitValue object with a specified type and value.
* @param unitType either {@link UnitValue#POINT} or a {@link UnitValue#PERCENT}
* @param value the value to be stored.
*/
public UnitValue(int unitType, float value) {
this.unitType = unitType;
assert !Float.isNaN(value);
this.value = value;
}
/**
* Creates a copy of UnitValue object.
*/
public UnitValue(UnitValue unitValue) {
this(unitValue.unitType, unitValue.value);
}
/**
* Creates a UnitValue POINT object with a specified value.
* @param value the value to be stored.
* @return a new {@link UnitValue#POINT} {@link UnitValue}
*/
public static UnitValue createPointValue(float value) {
return new UnitValue(POINT, value);
}
/**
* Creates a UnitValue PERCENT object with a specified value.
* @param value the value to be stored.
* @return a new {@link UnitValue#PERCENT} {@link UnitValue}
*/
public static UnitValue createPercentValue(float value) {
return new UnitValue(PERCENT, value);
}
/**
* Creates an array of UnitValue PERCENT objects with specified values.
*
* @param values the values to be stored.
* @return a new normalized (Σ=100%) array of {@link UnitValue#PERCENT} {@link UnitValue}.
*/
public static UnitValue[] createPercentArray(float[] values) {
UnitValue[] resultArray = new UnitValue[values.length];
float sum = 0;
for (float val : values) sum += val;
for (int i = 0; i < values.length; i++) {
resultArray[i] = UnitValue.createPercentValue(100 * values[i] / sum);
}
return resultArray;
}
/**
* Creates an array of UnitValue PERCENT objects with equal values.
*
* @param size of the resulted array.
* @return a array of equal {@link UnitValue#PERCENT} {@link UnitValue}.
*/
public static UnitValue[] createPercentArray(int size) {
UnitValue[] resultArray = new UnitValue[size];
for (int i = 0; i < size; i++) {
resultArray[i] = UnitValue.createPercentValue(100f / size);
}
return resultArray;
}
/**
* Creates an array of UnitValue POINT objects with specified values.
* @param values the values to be stored.
* @return a new array of {@link UnitValue#POINT} {@link UnitValue}
*/
public static UnitValue[] createPointArray(float[] values) {
UnitValue[] resultArray = new UnitValue[values.length];
for (int i = 0; i < values.length; i++) {
resultArray[i] = UnitValue.createPointValue(values[i]);
}
return resultArray;
}
/**
* Returns the unit this value is stored in, either points (pt) or percent(%)
* @return either 1 for {@link UnitValue#POINT} or 2 for {@link UnitValue#PERCENT}
*/
public int getUnitType() {
return unitType;
}
/**
* Sets the unit this value is stored in, either points (pt) or percent(%)
* @param unitType either {@link UnitValue#POINT} or {@link UnitValue#PERCENT}
*/
public void setUnitType(int unitType) {
this.unitType = unitType;
}
/**
* Gets the measured value stored in this object
* @return the value, as a float
*/
public float getValue() {
return value;
}
/**
* Sets the measured value stored in this object
* @param value a float
*/
public void setValue(float value) {
assert !Float.isNaN(value);
this.value = value;
}
/**
* Returns whether or not the value is stored in points (pt)
* @return true if stored in points
*/
public boolean isPointValue() {
return unitType == POINT;
}
/**
* Returns whether or not the value is stored in percent (%)
* @return true if stored in percent
*/
public boolean isPercentValue() {
return unitType == PERCENT;
}
@Override
public boolean equals(Object obj) {
if (getClass() != obj.getClass()) {
return false;
}
UnitValue other = (UnitValue) obj;
return Integer.compare(unitType, other.unitType) == 0 && Float.compare(value, other.value) == 0;
}
@Override
public int hashCode() {
int hash = 7;
hash = 71 * hash + this.unitType;
hash = 71 * hash + Float.floatToIntBits(this.value);
return hash;
}
@Override
public String toString() {
return MessageFormatUtil.format((unitType == PERCENT ? "{0}%" : "{0}pt"), value);
}
}