APIdia Launch Partner
Top Description Inners Fields Constructors Methods
tools.maran.svgnode

public Class SvgNode

extends Region
Class Inheritance
Imports
java.util.ArrayList, .Collections, .List, javafx.css.CssMetaData, .Styleable, .StyleableDoubleProperty, .StyleableObjectProperty, .StyleableProperty, .StyleableStringProperty, javafx.css.converter.PaintConverter, .SizeConverter, .StringConverter, javafx.scene.layout.Background, .Region, javafx.scene.paint.Paint, javafx.scene.shape.SVGPath
Node to show an SVG path with the specified size and color.

Java usage

SvgNode icon = new SvgNode("M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z", 32); icon.setColor(Color.RED); 
SvgNode icon = new SvgNode("M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z", 32);
icon.setColor(Color.RED);

FXML usage

<SvgNode path="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z" size="32" color="RED" /> 
<SvgNode path="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z" size="32" color="RED" />

Extended FXML usage from a constant (String or Enum)

<SvgNode size="32" color="RED"> <path> <MyIcons fx:constant="HOME"/> </path> </SvgNode> 
<SvgNode size="32" color="RED">
    <path>
        <MyIcons fx:constant="HOME"/>
    </path>
</SvgNode>

CSS

.svg-node { -fx-path: "M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"; -fx-size: 24; -fx-color: red; } 
.svg-node {
    -fx-path: "M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z";
    -fx-size: 24;
    -fx-color: red;
}
Author
Marius Hanl

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
SvgNode.StyleableProperties

private static class
SvgNode.SvgContent

A Region that uses an SVGPath as its shape so that it can be styled and used as normal children.

Field Summary

Modifier and TypeField and Description
private StyleableObjectProperty<Paint>
color

private static final String
DEFAULT_PATH

private static final double
DEFAULT_SIZE

private StyleableStringProperty
path

private StyleableDoubleProperty
size

private final SvgNode.SvgContent
svgContent

Inherited from javafx.scene.layout.Region:
USE_COMPUTED_SIZEUSE_PREF_SIZE

Constructor Summary

AccessConstructor and Description
public
SvgNode()

Creates an empty SvgNode with no SVG path and the default fit dimensions.

public
SvgNode(String
the SVG path content (e.g. "M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z")
path)

Creates an SvgNode displaying the given SVG path, rasterized to fit within a square of the default size.

public
SvgNode(String
the SVG path content
path, double
the desired width and height in pixels
size)

Creates an SvgNode displaying the given SVG path, rasterized to fit within a square of the specified size.

Method Summary

Modifier and TypeMethod and Description
public final StyleableObjectProperty<Paint>

Returns:

the color property
colorProperty()

The fill color of the SVG shape itself.

protected double
computeMaxHeight(double width)

Overrides javafx.scene.layout.Region.computeMaxHeight.

Computes the maximum height of this region.

protected double
computeMaxWidth(double height)

Overrides javafx.scene.layout.Region.computeMaxWidth.

Computes the maximum width for this region.

protected double
computeMinHeight(double width)

Overrides javafx.scene.layout.Region.computeMinHeight.

Computes the minimum height of this region.

protected double
computeMinWidth(double height)

Overrides javafx.scene.layout.Region.computeMinWidth.

Computes the minimum width of this region.

protected double
computePrefHeight(double width)

Overrides javafx.scene.layout.Region.computePrefHeight.

Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy.

protected double
computePrefWidth(double height)

Overrides javafx.scene.layout.Region.computePrefWidth.

Computes the preferred width of this region for the given height.

public static List<CssMetaData<? extends Styleable, ?>>

Returns:

the CssMetaData
getClassCssMetaData()

Hides javafx.scene.layout.Region.getClassCssMetaData.

Gets the CssMetaData associated with this class.

public final Paint
getColor()

public List<CssMetaData<? extends Styleable, ?>>
getCssMetaData()

Overrides javafx.scene.layout.Region.getCssMetaData.

Implements javafx.css.Styleable.getCssMetaData.

This method should delegate to Node#getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.

public final String
getPath()

public final double
getSize()

protected void
layoutChildren()

Overrides javafx.scene.Parent.layoutChildren.

Invoked during the layout pass to layout the children in this Parent.

public final StyleableStringProperty

Returns:

the path property
pathProperty()

The SVG path content string (e.g. "M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z").

public final void
setColor(Paint value)

public final void
setPath(String value)

public final void
setSize(double value)

public final StyleableDoubleProperty

Returns:

the size property
sizeProperty()

The target size (width and height) the SVG should be rasterized to.

Inherited from javafx.scene.layout.Region:
backgroundPropertyborderPropertycacheShapePropertycenterShapePropertygetBackgroundgetBordergetHeightgetInsetsgetMaxHeightgetMaxWidthgetMinHeightgetMinWidthgetOpaqueInsetsgetPaddinggetPrefHeightgetPrefWidthgetShapegetUserAgentStylesheetgetWidthheightPropertyinsetsPropertyisCacheShapeisCenterShapeisResizableisScaleShapeisSnapToPixellayoutInArealayoutInArealayoutInArealayoutInAreamaxHeightmaxHeightPropertymaxWidthmaxWidthPropertyminHeightminHeightPropertyminWidthminWidthPropertyopaqueInsetsPropertypaddingPropertypositionInAreapositionInAreaprefHeightprefHeightPropertyprefWidthprefWidthPropertyresizescaleShapePropertysetBackgroundsetBordersetCacheShapesetCenterShapesetHeightsetMaxHeightsetMaxSizesetMaxWidthsetMinHeightsetMinSizesetMinWidthsetOpaqueInsetssetPaddingsetPrefHeightsetPrefSizesetPrefWidthsetScaleShapesetShapesetSnapToPixelsetWidthshapePropertysnappedBottomInsetsnappedLeftInsetsnappedRightInsetsnappedTopInsetsnapPositionsnapPositionXsnapPositionYsnapSizesnapSizeXsnapSizeYsnapSpacesnapSpaceXsnapSpaceYsnapToPixelPropertywidthProperty

Field Detail

colorback to summary
private StyleableObjectProperty<Paint> color
DEFAULT_PATHback to summary
private static final String DEFAULT_PATH
DEFAULT_SIZEback to summary
private static final double DEFAULT_SIZE
pathback to summary
private StyleableStringProperty path
sizeback to summary
private StyleableDoubleProperty size
svgContentback to summary
private final SvgNode.SvgContent svgContent

Constructor Detail

SvgNodeback to summary
public SvgNode()

Creates an empty SvgNode with no SVG path and the default fit dimensions.

SvgNodeback to summary
public SvgNode(String path)

Creates an SvgNode displaying the given SVG path, rasterized to fit within a square of the default size.

Parameters
path:String

the SVG path content (e.g. "M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z")

SvgNodeback to summary
public SvgNode(String path, double size)

Creates an SvgNode displaying the given SVG path, rasterized to fit within a square of the specified size.

Parameters
path:String

the SVG path content

size:double

the desired width and height in pixels

Method Detail

colorPropertyback to summary
public final StyleableObjectProperty<Paint> colorProperty()

The fill color of the SVG shape itself.

Can be set in CSS with -fx-color.

Returns:StyleableObjectProperty<Paint>

the color property

Default Value
null
computeMaxHeightback to summary
protected double computeMaxHeight(double width)

Overrides javafx.scene.layout.Region.computeMaxHeight.

Doc from javafx.scene.layout.Region.computeMaxHeight.

Computes the maximum height of this region. Returns Double.MAX_VALUE by default. Region subclasses may override this method to return a different value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Annotations
@Override
computeMaxWidthback to summary
protected double computeMaxWidth(double height)

Overrides javafx.scene.layout.Region.computeMaxWidth.

Doc from javafx.scene.layout.Region.computeMaxWidth.

Computes the maximum width for this region. Returns Double.MAX_VALUE by default. Region subclasses may override this method to return an different value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored.

Annotations
@Override
computeMinHeightback to summary
protected double computeMinHeight(double width)

Overrides javafx.scene.layout.Region.computeMinHeight.

Doc from javafx.scene.layout.Region.computeMinHeight.

Computes the minimum height of this region. Returns the sum of the top and bottom insets by default. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Annotations
@Override
computeMinWidthback to summary
protected double computeMinWidth(double height)

Overrides javafx.scene.layout.Region.computeMinWidth.

Doc from javafx.scene.layout.Region.computeMinWidth.

Computes the minimum width of this region. Returns the sum of the left and right insets by default. region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored.

Annotations
@Override
computePrefHeightback to summary
protected double computePrefHeight(double width)

Overrides javafx.scene.layout.Region.computePrefHeight.

Doc from javafx.scene.layout.Region.computePrefHeight.

Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Annotations
@Override
computePrefWidthback to summary
protected double computePrefWidth(double height)

Overrides javafx.scene.layout.Region.computePrefWidth.

Doc from javafx.scene.layout.Region.computePrefWidth.

Computes the preferred width of this region for the given height. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored.

Annotations
@Override
getClassCssMetaDataback to summary
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData()

Hides javafx.scene.layout.Region.getClassCssMetaData.

Gets the CssMetaData associated with this class. Includes the CssMetaData of its superclasses.

Returns:List<CssMetaData<? extends Styleable, ?>>

the CssMetaData

getColorback to summary
public final Paint getColor()
getCssMetaDataback to summary
public List<CssMetaData<? extends Styleable, ?>> getCssMetaData()

Overrides javafx.scene.layout.Region.getCssMetaData.

Implements javafx.css.Styleable.getCssMetaData.

Doc from javafx.scene.layout.Region.getCssMetaData.

This method should delegate to Node#getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.

Annotations
@Override
getPathback to summary
public final String getPath()
getSizeback to summary
public final double getSize()
layoutChildrenback to summary
protected void layoutChildren()

Overrides javafx.scene.Parent.layoutChildren.

Doc from javafx.scene.Parent.layoutChildren.

Invoked during the layout pass to layout the children in this Parent. By default it will only set the size of managed, resizable content to their preferred sizes and does not do any node positioning.

Subclasses should override this function to layout content as needed.

Annotations
@Override
pathPropertyback to summary
public final StyleableStringProperty pathProperty()

The SVG path content string (e.g. "M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z").

Can be set in CSS with -fx-path.

Returns:StyleableStringProperty

the path property

Default Value
""
setColorback to summary
public final void setColor(Paint value)
setPathback to summary
public final void setPath(String value)
setSizeback to summary
public final void setSize(double value)
sizePropertyback to summary
public final StyleableDoubleProperty sizeProperty()

The target size (width and height) the SVG should be rasterized to.

The SVG path is rasterized uniformly to fit within a square of this size while preserving its original aspect ratio.

Can be set in CSS with -fx-size.

Returns:StyleableDoubleProperty

the size property

Default Value
24
tools.maran.svgnode back to summary

private Class SvgNode.StyleableProperties

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final CssMetaData<SvgNode, Paint>
COLOR

private static final CssMetaData<SvgNode, String>
PATH

private static final CssMetaData<SvgNode, Number>
SIZE

private static final List<CssMetaData<? extends Styleable, ?>>
STYLEABLES

Constructor Summary

AccessConstructor and Description
private
StyleableProperties()

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

COLORback to summary
private static final CssMetaData<SvgNode, Paint> COLOR
PATHback to summary
private static final CssMetaData<SvgNode, String> PATH
SIZEback to summary
private static final CssMetaData<SvgNode, Number> SIZE
STYLEABLESback to summary
private static final List<CssMetaData<? extends Styleable, ?>> STYLEABLES

Constructor Detail

StyleablePropertiesback to summary
private StyleableProperties()
tools.maran.svgnode back to summary

private Class SvgNode.SvgContent

extends Region
Class Inheritance
A Region that uses an SVGPath as its shape so that it can be styled and used as normal children.
Author
Marius Hanl

Field Summary

Modifier and TypeField and Description
private double
svgHeight

private final SVGPath
svgPath

private double
svgWidth

Inherited from javafx.scene.layout.Region:
USE_COMPUTED_SIZEUSE_PREF_SIZE

Constructor Summary

AccessConstructor and Description
pack-priv
SvgContent()

Method Summary

Modifier and TypeMethod and Description
private void
calculateSvgSize(double rasterizedSize)

protected double
computeMaxHeight(double width)

Overrides javafx.scene.layout.Region.computeMaxHeight.

Computes the maximum height of this region.

protected double
computeMaxWidth(double height)

Overrides javafx.scene.layout.Region.computeMaxWidth.

Computes the maximum width for this region.

protected double
computeMinHeight(double width)

Overrides javafx.scene.layout.Region.computeMinHeight.

Computes the minimum height of this region.

protected double
computeMinWidth(double height)

Overrides javafx.scene.layout.Region.computeMinWidth.

Computes the minimum width of this region.

protected double
computePrefHeight(double width)

Overrides javafx.scene.layout.Region.computePrefHeight.

Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy.

protected double
computePrefWidth(double height)

Overrides javafx.scene.layout.Region.computePrefWidth.

Computes the preferred width of this region for the given height.

public String
getUserAgentStylesheet()

Overrides javafx.scene.layout.Region.getUserAgentStylesheet.

An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method.

pack-priv void
updatePath(String path, double rasterizedSize)

pack-priv void
updateRasterizedSize(double rasterizedSize)

Inherited from javafx.scene.layout.Region:
backgroundPropertyborderPropertycacheShapePropertycenterShapePropertygetBackgroundgetBordergetClassCssMetaDatagetCssMetaDatagetHeightgetInsetsgetMaxHeightgetMaxWidthgetMinHeightgetMinWidthgetOpaqueInsetsgetPaddinggetPrefHeightgetPrefWidthgetShapegetWidthheightPropertyinsetsPropertyisCacheShapeisCenterShapeisResizableisScaleShapeisSnapToPixellayoutInArealayoutInArealayoutInArealayoutInAreamaxHeightmaxHeightPropertymaxWidthmaxWidthPropertyminHeightminHeightPropertyminWidthminWidthPropertyopaqueInsetsPropertypaddingPropertypositionInAreapositionInAreaprefHeightprefHeightPropertyprefWidthprefWidthPropertyresizescaleShapePropertysetBackgroundsetBordersetCacheShapesetCenterShapesetHeightsetMaxHeightsetMaxSizesetMaxWidthsetMinHeightsetMinSizesetMinWidthsetOpaqueInsetssetPaddingsetPrefHeightsetPrefSizesetPrefWidthsetScaleShapesetShapesetSnapToPixelsetWidthshapePropertysnappedBottomInsetsnappedLeftInsetsnappedRightInsetsnappedTopInsetsnapPositionsnapPositionXsnapPositionYsnapSizesnapSizeXsnapSizeYsnapSpacesnapSpaceXsnapSpaceYsnapToPixelPropertywidthProperty

Field Detail

svgHeightback to summary
private double svgHeight
svgPathback to summary
private final SVGPath svgPath
svgWidthback to summary
private double svgWidth

Constructor Detail

SvgContentback to summary
pack-priv SvgContent()

Method Detail

calculateSvgSizeback to summary
private void calculateSvgSize(double rasterizedSize)
computeMaxHeightback to summary
protected double computeMaxHeight(double width)

Overrides javafx.scene.layout.Region.computeMaxHeight.

Doc from javafx.scene.layout.Region.computeMaxHeight.

Computes the maximum height of this region. Returns Double.MAX_VALUE by default. Region subclasses may override this method to return a different value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Annotations
@Override
computeMaxWidthback to summary
protected double computeMaxWidth(double height)

Overrides javafx.scene.layout.Region.computeMaxWidth.

Doc from javafx.scene.layout.Region.computeMaxWidth.

Computes the maximum width for this region. Returns Double.MAX_VALUE by default. Region subclasses may override this method to return an different value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored.

Annotations
@Override
computeMinHeightback to summary
protected double computeMinHeight(double width)

Overrides javafx.scene.layout.Region.computeMinHeight.

Doc from javafx.scene.layout.Region.computeMinHeight.

Computes the minimum height of this region. Returns the sum of the top and bottom insets by default. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Annotations
@Override
computeMinWidthback to summary
protected double computeMinWidth(double height)

Overrides javafx.scene.layout.Region.computeMinWidth.

Doc from javafx.scene.layout.Region.computeMinWidth.

Computes the minimum width of this region. Returns the sum of the left and right insets by default. region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored.

Annotations
@Override
computePrefHeightback to summary
protected double computePrefHeight(double width)

Overrides javafx.scene.layout.Region.computePrefHeight.

Doc from javafx.scene.layout.Region.computePrefHeight.

Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Annotations
@Override
computePrefWidthback to summary
protected double computePrefWidth(double height)

Overrides javafx.scene.layout.Region.computePrefWidth.

Doc from javafx.scene.layout.Region.computePrefWidth.

Computes the preferred width of this region for the given height. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored.

Annotations
@Override
getUserAgentStylesheetback to summary
public String getUserAgentStylesheet()

Overrides javafx.scene.layout.Region.getUserAgentStylesheet.

Doc from javafx.scene.layout.Region.getUserAgentStylesheet.

An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method. These styles are used in addition to whatever user-agent stylesheets are in use. This provides a mechanism for third parties to introduce styles for custom controls.

The URL is a hierarchical URI of the form [scheme:][//authority][path]. If the URL does not have a [scheme:] component, the URL is considered to be the [path] component only. Any leading '/' character of the [path] is ignored and the [path] is treated as a path relative to the root of the application's classpath.

Subclasses overriding this method should not assume any particular implementation approach as to the number and frequency with which it is called. For this reason, attempting any kind of dynamic implementation (i.e. returning different user agent stylesheet values) based on some state change is highly discouraged, as there is no guarantee when, or even if, this method will be called. Some JavaFX CSS implementations may choose to cache this response for an indefinite period of time, and therefore there should be no expectation around when this method is called. 



package com.example.javafx.app;

import javafx.application.Application;
import javafx.scene.Group;
import javafx.scene.Scene;
import javafx.stage.Stage;

public class MyApp extends Application {

    @Override public void start(Stage stage) {
        Scene scene = new Scene(new Group());
        scene.getStylesheets().add("/com/example/javafx/app/mystyles.css");
        stage.setScene(scene);
        stage.show();
    }

    public static void main(String[] args) {
        launch(args);
    }
}
For additional information about using CSS with the scene graph, see the CSS Reference Guide.
Annotations
@Override
updatePathback to summary
pack-priv void updatePath(String path, double rasterizedSize)
updateRasterizedSizeback to summary
pack-priv void updateRasterizedSize(double rasterizedSize)