com.dropsnorz.showcasefx.layers

Class ShowcaseLayerFill

java.lang.Object

com.dropsnorz.showcasefx.layers.ShowcaseLayerFill

All Implemented Interfaces:

ShowcaseLayer

public abstract class ShowcaseLayerFill
extends Object
implements ShowcaseLayer

A ShowcaseLayerFill is a Layer node generator based on JavaFx backgrounds The generated background will be converted as a layer node

Field Summary

Fields

Modifier and Type	Field and Description
static ShowcaseLayerFill	CIRCLE_FLAT
static ShowcaseLayerFill	CIRCLE_GRADIENT

Constructor Summary

Constructors

Constructor and Description
ShowcaseLayerFill()

Method Summary

Modifier and Type	Method and Description
abstract javafx.scene.layout.Background	generate(javafx.geometry.Bounds targetBounds, double parentWidth, double parentHeight) Builds and returns the background
javafx.scene.Node	getNode(javafx.geometry.Bounds targetBounds, double parentWidth, double parentHeight) Builds and returns the layer node.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CIRCLE_GRADIENT

public static ShowcaseLayerFill CIRCLE_GRADIENT

CIRCLE_FLAT

public static ShowcaseLayerFill CIRCLE_FLAT

Constructor Detail

ShowcaseLayerFill

public ShowcaseLayerFill()

Method Detail

generate

public abstract javafx.scene.layout.Background generate(javafx.geometry.Bounds targetBounds,
                                                        double parentWidth,
                                                        double parentHeight)

Builds and returns the background

Parameters:

targetBounds - Highlighted element's bounds

parentWidth - Showcase component width

parentHeight - Showcase component height

Returns:

layering background

getNode

public javafx.scene.Node getNode(javafx.geometry.Bounds targetBounds,
                                 double parentWidth,
                                 double parentHeight)

Description copied from interface: ShowcaseLayer

Builds and returns the layer node.

Specified by:

getNode in interface ShowcaseLayer

Parameters:

targetBounds - Highlighted element's bounds

parentWidth - Showcase component width

parentHeight - Showcase component height

Returns:

layering node