javafx.scene.layout.BorderConverter Maven / Gradle / Ivy
/*
* Copyright (c) 2012, 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 javafx.scene.layout;
import com.sun.javafx.css.StyleManager;
import com.sun.javafx.css.SubPropertyConverter;
import com.sun.javafx.scene.layout.region.BorderImageSlices;
import com.sun.javafx.scene.layout.region.Margins;
import com.sun.javafx.scene.layout.region.RepeatStruct;
import java.util.List;
import java.util.Map;
import javafx.css.CssMetaData;
import javafx.css.ParsedValue;
import javafx.css.Styleable;
import javafx.css.StyleConverter;
import javafx.geometry.Insets;
import javafx.scene.image.Image;
import javafx.scene.paint.Color;
import javafx.scene.paint.Paint;
/**
* Converts -fx-border components into a {@link Border}.
*/
class BorderConverter extends StyleConverter
implements SubPropertyConverter {
private static final BorderConverter BORDER_IMAGE_CONVERTER =
new BorderConverter();
public static BorderConverter getInstance() {
return BORDER_IMAGE_CONVERTER;
}
// Disallow instantiation
private BorderConverter() { }
/**
* {@inheritDoc}
*
* @throws NullPointerException if {@code convertedValues} is {@code null}
*/
@Override
public Border convert(Map, Object> convertedValues) {
final Paint[][] strokeFills = (Paint[][])convertedValues.get(Border.BORDER_COLOR);
final BorderStrokeStyle[][] strokeStyles = (BorderStrokeStyle[][]) convertedValues.get(Border.BORDER_STYLE);
final Object[] images = (Object[]) convertedValues.get(Border.BORDER_IMAGE_SOURCE);
//
// In W3C CSS, border colors and border images are not layered. In javafx, they are. We've taken the position
// that there is one layer per -fx-border-color or -fx-border-image-source. This is consistent with
// background-image (see http://www.w3.org/TR/css3-background/#layering). But, in a browser, you can have a
// border-style with no corresponding border-color - the border-color just defaults to 'currentColor' (which
// we don't have so we'll call it 'black' for the time being). So the number of stroke-border layers is now
// determined by the max of strokeFills.length and strokeStyles.length. If there are more styles than fills,
// the remaining styles will use the last fill value (this is consistent with handling of the other stroke
// border properties). If there aren't any fills at all, then the fill is 'currentColor' (i.e., black) just
// as the default stroke is solid.
//
final boolean hasStrokes = (strokeFills != null && strokeFills.length > 0) || (strokeStyles != null && strokeStyles.length > 0);
final boolean hasImages = images != null && images.length > 0;
// If there are neither background fills nor images, then there is nothing for us to construct.
if (!hasStrokes && !hasImages) return null;
BorderStroke[] borderStrokes = null;
if (hasStrokes) {
final int lastStrokeFill = strokeFills != null ? strokeFills.length - 1 : -1;
final int lastStrokeStyle = strokeStyles != null ? strokeStyles.length - 1 : -1;
final int nLayers = (lastStrokeFill >= lastStrokeStyle ? lastStrokeFill : lastStrokeStyle) + 1;
Object tmp = convertedValues.get(Border.BORDER_WIDTH);
final Margins[] borderWidths = tmp == null ? new Margins[0] : (Margins[]) tmp;
final int lastMarginIndex = borderWidths.length - 1;
tmp = convertedValues.get(Border.BORDER_RADIUS);
final CornerRadii[] borderRadii = tmp == null ? new CornerRadii[0] : (CornerRadii[]) tmp;
final int lastRadiusIndex = borderRadii.length - 1;
tmp = convertedValues.get(Border.BORDER_INSETS);
final Insets[] borderInsets = tmp == null ? new Insets[0] : (Insets[]) tmp;
final int lastInsetsIndex = borderInsets.length - 1;
for (int i=0; i 0) {
final RepeatStruct repeat = repeats[i <= lastRepeatIndex ? i : lastRepeatIndex];
repeatX = convertToBorderRepeat(repeat.repeatX);
repeatY = convertToBorderRepeat(repeat.repeatY);
}
final BorderImageSlices slice = slices.length > 0 ? slices[i <= lastSlicesIndex ? i : lastSlicesIndex] : BorderImageSlices.DEFAULT;
final Insets inset = insets.length > 0 ? insets[i <= lastInsetsIndex ? i : lastInsetsIndex] : Insets.EMPTY;
final BorderWidths width = widths.length > 0 ? widths[i <= lastWidthsIndex ? i : lastWidthsIndex] : BorderWidths.DEFAULT;
final Image image;
// The images are either URLs (when they come from CSS) or the actual Image
// instances (when they come from the convertBack operation).
if (images[i] instanceof String url) {
image = StyleManager.getInstance().getCachedImage(url);
} else if (images[i] instanceof Image img) {
image = img;
} else {
throw new IllegalArgumentException("Unexpected type: " + images[i].getClass().getName());
}
borderImages[i] = new BorderImage(image, width, inset, slice.widths, slice.filled, repeatX, repeatY);
}
}
return borderStrokes == null && borderImages == null ? null : new Border(borderStrokes, borderImages);
}
/**
* {@inheritDoc}
*
* @throws NullPointerException if {@code border} is {@code null}
*/
@Override
public Map, Object> convertBack(Border border) {
List strokes = border.getStrokes();
int strokesCount = strokes.size();
Paint[][] borderStrokeFills = new Paint[strokesCount][];
BorderStrokeStyle[][] borderStrokeStyles = new BorderStrokeStyle[strokesCount][];
Margins[] borderWidths = new Margins[strokesCount];
CornerRadii[] borderRadius = new CornerRadii[strokesCount];
Insets[] borderInsets = new Insets[strokesCount];
for (int i = 0; i < strokesCount; ++i) {
BorderStroke stroke = strokes.get(i);
borderStrokeFills[i] = new Paint[4];
borderStrokeFills[i][0] = stroke.getTopStroke();
borderStrokeFills[i][1] = stroke.getRightStroke();
borderStrokeFills[i][2] = stroke.getBottomStroke();
borderStrokeFills[i][3] = stroke.getLeftStroke();
borderStrokeStyles[i] = new BorderStrokeStyle[4];
borderStrokeStyles[i][0] = stroke.getTopStyle();
borderStrokeStyles[i][1] = stroke.getRightStyle();
borderStrokeStyles[i][2] = stroke.getBottomStyle();
borderStrokeStyles[i][3] = stroke.getLeftStyle();
BorderWidths widths = stroke.getWidths();
borderWidths[i] = new Margins(widths.getTop(), widths.getRight(), widths.getBottom(), widths.getLeft(), false);
borderRadius[i] = stroke.getRadii();
borderInsets[i] = stroke.getInsets();
}
List borderImages = border.getImages();
int imagesCount = borderImages.size();
Image[] images = new Image[imagesCount];
RepeatStruct[] imageRepeats = new RepeatStruct[imagesCount];
BorderImageSlices[] imageSlices = new BorderImageSlices[imagesCount];
BorderWidths[] imageWidths = new BorderWidths[imagesCount];
Insets[] imageInsets = new Insets[imagesCount];
for (int i = 0; i < imagesCount; ++i) {
BorderImage image = borderImages.get(i);
images[i] = image.getImage();
imageRepeats[i] = new RepeatStruct(
convertToBackgroundRepeat(image.getRepeatX()),
convertToBackgroundRepeat(image.getRepeatY()));
imageSlices[i] = new BorderImageSlices(image.getSlices(), image.isFilled());
imageWidths[i] = image.getWidths();
imageInsets[i] = image.getInsets();
}
return Map.of(
Border.BORDER_COLOR, borderStrokeFills,
Border.BORDER_STYLE, borderStrokeStyles,
Border.BORDER_WIDTH, borderWidths,
Border.BORDER_RADIUS, borderRadius,
Border.BORDER_INSETS, borderInsets,
Border.BORDER_IMAGE_SOURCE, images,
Border.BORDER_IMAGE_REPEAT, imageRepeats,
Border.BORDER_IMAGE_SLICE, imageSlices,
Border.BORDER_IMAGE_WIDTH, imageWidths,
Border.BORDER_IMAGE_INSETS, imageInsets);
}
private BackgroundRepeat convertToBackgroundRepeat(BorderRepeat repeat) {
return switch (repeat) {
case REPEAT -> BackgroundRepeat.REPEAT;
case ROUND -> BackgroundRepeat.ROUND;
case SPACE -> BackgroundRepeat.SPACE;
case STRETCH -> BackgroundRepeat.NO_REPEAT;
};
}
private BorderRepeat convertToBorderRepeat(BackgroundRepeat repeat) {
return switch (repeat) {
case REPEAT -> BorderRepeat.REPEAT;
case ROUND -> BorderRepeat.ROUND;
case SPACE -> BorderRepeat.SPACE;
case NO_REPEAT -> BorderRepeat.STRETCH;
};
}
/**
* @inheritDoc
*/
@Override public String toString() {
return "BorderConverter";
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy