com.dropsnorz.showcasefx.layers

Class ShowcaseLayerShape

java.lang.Object

com.dropsnorz.showcasefx.layers.ShowcaseLayerShape

All Implemented Interfaces:

ShowcaseLayer

public abstract class ShowcaseLayerShape
extends Object
implements ShowcaseLayer

A ShowcaseLayerShape is a Layer node generator based on JavaFx shapes The generated shape is substracted to a rectangle background sized as the showcase components.

Field Summary

Fields

Modifier and Type	Field and Description
static ShowcaseLayerShape	CIRCLE_FLAT
static ShowcaseLayerShape	RECTANGLE_FLAT

Constructor Summary

Constructors

Constructor and Description
ShowcaseLayerShape()

Method Summary

Modifier and Type	Method and Description
abstract javafx.scene.shape.Shape	generate(javafx.geometry.Bounds targetBounds, double parentWidth, double parentHeight) Builds and returns the highlight shape
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_FLAT

public static ShowcaseLayerShape CIRCLE_FLAT

RECTANGLE_FLAT

public static ShowcaseLayerShape RECTANGLE_FLAT

Constructor Detail

ShowcaseLayerShape

public ShowcaseLayerShape()

Method Detail

generate

public abstract javafx.scene.shape.Shape generate(javafx.geometry.Bounds targetBounds,
                                                  double parentWidth,
                                                  double parentHeight)

Builds and returns the highlight shape

Parameters:

targetBounds - Highlighted element's bounds

parentWidth - Showcase component width

parentHeight - Showcase component height

Returns:

highlight shape

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