com.sun.javafx.scene.layout.region.Margins Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 2011, 2024, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code 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 General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.javafx.scene.layout.region;
import com.sun.javafx.util.InterpolationUtils;
import javafx.animation.Interpolatable;
import javafx.scene.text.Font;
import javafx.css.Size;
import javafx.css.SizeUnits;
import javafx.css.ParsedValue;
import javafx.css.StyleConverter;
import com.sun.javafx.logging.PlatformLogger;
import com.sun.javafx.logging.PlatformLogger.Level;
import java.util.Objects;
/**
* Similar to Insets but with flag denoting values are proportional.
* If proportional is true, then the values represent fractions or percentages
* and are in the range 0..1, although this is not enforced.
*/
public final class Margins implements Interpolatable {
// lazy, thread-safe instantiation
private static class Holder {
static Converter CONVERTER_INSTANCE = new Converter();
static SequenceConverter SEQUENCE_CONVERTER_INSTANCE = new SequenceConverter();
}
final double top;
public final double getTop() { return top; }
final double right;
public final double getRight() { return right; }
final double bottom;
public final double getBottom() { return bottom; }
final double left;
public final double getLeft() { return left; }
final boolean proportional;
public final boolean isProportional() { return proportional; }
public Margins(double top, double right, double bottom, double left, boolean proportional) {
this.top = top;
this.right = right;
this.bottom = bottom;
this.left = left;
this.proportional = proportional;
}
@Override
public Margins interpolate(Margins endValue, double t) {
Objects.requireNonNull(endValue, "endValue cannot be null");
if (t <= 0 || equals(endValue)) {
return this;
}
if (t >= 1) {
return endValue;
}
if (proportional != endValue.proportional) {
return InterpolationUtils.interpolateDiscrete(this, endValue, t);
}
return new Margins(
InterpolationUtils.interpolate(top, endValue.top, t),
InterpolationUtils.interpolate(right, endValue.right, t),
InterpolationUtils.interpolate(bottom, endValue.bottom, t),
InterpolationUtils.interpolate(left, endValue.left, t),
proportional);
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (!(o instanceof Margins margins)) return false;
return Double.compare(top, margins.top) == 0
&& Double.compare(right, margins.right) == 0
&& Double.compare(bottom, margins.bottom) == 0
&& Double.compare(left, margins.left) == 0
&& proportional == margins.proportional;
}
@Override
public int hashCode() {
int result = Double.hashCode(top);
result = 31 * result + Double.hashCode(right);
result = 31 * result + Double.hashCode(bottom);
result = 31 * result + Double.hashCode(left);
result = 31 * result + Boolean.hashCode(proportional);
return result;
}
@Override
public String toString() {
return "top: "+top+"\nright: "+right+"\nbottom: "+bottom+"\nleft: "+left;
}
/**
* Convert a sequence of sizes to an Margins
*/
public static final class Converter extends StyleConverter {
public static Converter getInstance() {
return Holder.CONVERTER_INSTANCE;
}
private Converter() {
super();
}
@Override
public Margins convert(ParsedValue value, Font font) {
ParsedValue[] sides = value.getValue();
Size topSz = (sides.length > 0) ? sides[0].convert(font) : new Size(0.0F, SizeUnits.PX);
Size rightSz = (sides.length > 1) ? sides[1].convert(font) : topSz;
Size bottomSz = (sides.length > 2) ? sides[2].convert(font) : topSz;
Size leftSz = (sides.length > 3) ? sides[3].convert(font) : rightSz;
// assume proportional if any units are percent
boolean proportional =
(topSz.getUnits() == SizeUnits.PERCENT) ||
(rightSz.getUnits() == SizeUnits.PERCENT) ||
(bottomSz.getUnits() == SizeUnits.PERCENT) ||
(leftSz.getUnits() == SizeUnits.PERCENT);
// if any of the units is percent, then make sure they all are.
boolean unitsMatch =
!proportional ||
((topSz.getUnits() == SizeUnits.PERCENT) &&
(rightSz.getUnits() == SizeUnits.PERCENT) &&
(bottomSz.getUnits() == SizeUnits.PERCENT) &&
(leftSz.getUnits() == SizeUnits.PERCENT));
// unitsMatch will only be false if proportional is true and
// not all of the units are percent.
if (unitsMatch == false) {
final PlatformLogger LOGGER = com.sun.javafx.util.Logging.getCSSLogger();
if (LOGGER.isLoggable(Level.WARNING)) {
final String msg =
new StringBuilder("units do no match: ")
.append(topSz.toString())
.append(" ,").append(rightSz.toString())
.append(" ,").append(bottomSz.toString())
.append(" ,").append(leftSz.toString())
.toString();
LOGGER.warning(msg);
}
}
proportional = proportional && unitsMatch;
double top = topSz.pixels(font);
double right = rightSz.pixels(font);
double bottom = bottomSz.pixels(font);
double left = leftSz.pixels(font);
return new Margins(top, right, bottom, left, proportional);
}
@Override
public String toString() {
return "MarginsConverter";
}
}
/**
* Convert a sequence of sizes to an Insets
*/
public static final class SequenceConverter extends StyleConverter[], Margins[]> {
public static SequenceConverter getInstance() {
return Holder.SEQUENCE_CONVERTER_INSTANCE;
}
private SequenceConverter() {
super();
}
@Override
public Margins[] convert(ParsedValue[], Margins[]> value, Font font) {
ParsedValue[] layers = value.getValue();
Margins[] margins = new Margins[layers.length];
for (int layer = 0; layer < layers.length; layer++) {
margins[layer] = Converter.getInstance().convert(layers[layer], font);
}
return margins;
}
@Override
public String toString() {
return "MarginsSequenceConverter";
}
}
}