com.dropsnorz.showcasefx

Class Showcase

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.layout.Pane

javafx.scene.layout.StackPane

com.dropsnorz.showcasefx.Showcase

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget

public class Showcase
extends javafx.scene.layout.StackPane

Note: for Showcase to work properly, the root node MUST be of type StackPane

Property Summary

Properties inherited from class javafx.scene.layout.StackPane

alignmentProperty

Properties inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Showcase.ShowcaseBehaviour

Field Summary

Fields

Modifier and Type	Field and Description
protected javafx.beans.value.ChangeListener<javafx.geometry.Bounds>	boundsListener
protected javafx.event.EventHandler<javafx.scene.input.MouseEvent>	clickHandler
protected javafx.scene.Node	currentLayoutNode
protected int	currentStep
protected ShowcaseLayer	defaultLayer
protected ShowcaseLayout	defaultLayout
protected javafx.scene.layout.Pane	layerPane
protected Showcase.ShowcaseBehaviour	onClickBehaviour
protected javafx.scene.layout.StackPane	showcaseContainer
protected ArrayList<ShowcaseStep>	steps
protected boolean	updateOnTargetBoundsChange

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
Showcase() Creates a Showcase control
Showcase(javafx.scene.layout.StackPane showCaseContainer) Creates a Showcase control with the specified root container

Method Summary

Modifier and Type	Method and Description
void	addStep(ShowcaseStep step) Add the given Step to the step list
StepBuilder	createStep(javafx.scene.Node targetNode, javafx.scene.Node content) Generate a StepBuilder and add it's related step to the Showcase
StepBuilder	createStep(javafx.scene.Node targetNode, String body) Generate a StepBuilder based on a SimpleStepView component and add the related step to the Showcase
StepBuilder	createStep(javafx.scene.Node targetNode, String title, String body) Generate a StepBuilder based on a SimpleStepView component and add the related step to the Showcase
int	getCurrentPosition()
ShowcaseStep	getCurrentStep()
ShowcaseLayer	getDefaultLayer() Get the default layer used if the current ShowcaseStep doesn't provide any layer object
ShowcaseLayout	getDefaultLayout() Get the default layout used if the current ShowcaseStep doesn't provide any layout object
javafx.event.EventHandler<? super ShowcaseEvent>	getOnShowcaseStarted()
javafx.event.EventHandler<? super ShowcaseEvent>	getOnShowcaseStepDisplay()
javafx.event.EventHandler<? super ShowcaseEvent>	getOnShowcaseStopped()
boolean	isStarted()
boolean	isUpdateOnTargetBoundsChange()
void	jumpTo(int stepIndex) /** Displays the specified step.
void	next() Displays the next step.
void	setDefaultLayer(ShowcaseLayer layer) Set the default layer used if the current ShowcaseStep doesn't provide any layer object
void	setDefaultLayout(ShowcaseLayout layout) Set the default layout used if the current ShowcaseStep doesn't provide any layout object
void	setOnClickBehaviour(Showcase.ShowcaseBehaviour onClickBehaviour)
void	setOnShowcaseStarted(javafx.event.EventHandler<? super ShowcaseEvent> handler) Defines a function to be called when the showcase is started.
void	setOnShowcaseStepDisplay(javafx.event.EventHandler<? super ShowcaseEvent> handler) Defines a function to be called when the showcase is stopped.
void	setOnShowcaseStopped(javafx.event.EventHandler<? super ShowcaseEvent> handler) Defines a function to be called when the showcase is stopped.
void	setShowcaseContainer(javafx.scene.layout.StackPane showcaseContainer)
void	setTransitionDelay(int delay) Set the Showcase transition animation delay in miliseconds.
void	setUpdateOnTargetBoundsChange(boolean updateOnTargetBoundsChange) Sets the value of updateOnTargetBoundsChange property.
void	start() Start the showcase component and display the first step
void	stop() Stop the Showcase component.

Methods inherited from class javafx.scene.layout.StackPane

alignmentProperty, clearConstraints, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getAlignment, getAlignment, getClassCssMetaData, getContentBias, getCssMetaData, getMargin, layoutChildren, requestLayout, setAlignment, setAlignment, setMargin

Methods inherited from class javafx.scene.layout.Pane

getChildren

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getBaselineOffset, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Field Detail

showcaseContainer

protected javafx.scene.layout.StackPane showcaseContainer

layerPane

protected javafx.scene.layout.Pane layerPane

defaultLayout

protected ShowcaseLayout defaultLayout

defaultLayer

protected ShowcaseLayer defaultLayer

steps

protected ArrayList<ShowcaseStep> steps

currentStep

protected int currentStep

boundsListener

protected javafx.beans.value.ChangeListener<javafx.geometry.Bounds> boundsListener

clickHandler

protected javafx.event.EventHandler<javafx.scene.input.MouseEvent> clickHandler

currentLayoutNode

protected javafx.scene.Node currentLayoutNode

onClickBehaviour

protected Showcase.ShowcaseBehaviour onClickBehaviour

updateOnTargetBoundsChange

protected boolean updateOnTargetBoundsChange

Constructor Detail

Showcase

public Showcase()

Creates a Showcase control

Showcase

public Showcase(javafx.scene.layout.StackPane showCaseContainer)

Creates a Showcase control with the specified root container

Parameters:

showCaseContainer - root container

Method Detail

start

public void start()

Start the showcase component and display the first step

next

public void next()

Displays the next step. If the last step has been reached the stop() method is called NOTE: The Showcase component must be started by calling start() before any call to next()

jumpTo

public void jumpTo(int stepIndex)

/** Displays the specified step. NOTE: The Showcase component must be started by calling start() before any call to jumpTo()

Parameters:

stepIndex - the step index to display

stop

public void stop()

Stop the Showcase component. Automatically called when the last step have been reached NOTE: The Showcase component must be started

setShowcaseContainer

public void setShowcaseContainer(javafx.scene.layout.StackPane showcaseContainer)

setDefaultLayer

public void setDefaultLayer(ShowcaseLayer layer)

Set the default layer used if the current ShowcaseStep doesn't provide any layer object

Parameters:

layer - the default layer

getDefaultLayer

public ShowcaseLayer getDefaultLayer()

Get the default layer used if the current ShowcaseStep doesn't provide any layer object

Returns:

the default layer

setDefaultLayout

public void setDefaultLayout(ShowcaseLayout layout)

Set the default layout used if the current ShowcaseStep doesn't provide any layout object

Parameters:

layout - the default layout

getDefaultLayout

public ShowcaseLayout getDefaultLayout()

Get the default layout used if the current ShowcaseStep doesn't provide any layout object

Returns:

the default layout

addStep

public void addStep(ShowcaseStep step)

Add the given Step to the step list

Parameters:

step -

createStep

public StepBuilder createStep(javafx.scene.Node targetNode,
                              javafx.scene.Node content)

Generate a StepBuilder and add it's related step to the Showcase

Parameters:

targetNode - the target node

content - the content node

Returns:

the step builder

createStep

public StepBuilder createStep(javafx.scene.Node targetNode,
                              String title,
                              String body)

Generate a StepBuilder based on a SimpleStepView component and add the related step to the Showcase

Parameters:

targetNode - the target node

title - Title of the SimpleStepView

body - Body of the simple step view

Returns:

the step builder

createStep

public StepBuilder createStep(javafx.scene.Node targetNode,
                              String body)

Generate a StepBuilder based on a SimpleStepView component and add the related step to the Showcase

Parameters:

targetNode - the target node

body - Body of the SimpleStepView

Returns:

the step builder

getCurrentPosition

public int getCurrentPosition()

getCurrentStep

public ShowcaseStep getCurrentStep()

isStarted

public boolean isStarted()

isUpdateOnTargetBoundsChange

public boolean isUpdateOnTargetBoundsChange()

setOnClickBehaviour

public void setOnClickBehaviour(Showcase.ShowcaseBehaviour onClickBehaviour)

setUpdateOnTargetBoundsChange

public void setUpdateOnTargetBoundsChange(boolean updateOnTargetBoundsChange)

Sets the value of updateOnTargetBoundsChange property. Defines if the showcase should be updated if target node's bounds changes. Default value: true

Parameters:

updateOnTargetBoundsChange -

setTransitionDelay

public void setTransitionDelay(int delay)

Set the Showcase transition animation delay in miliseconds.

Parameters:

delay - The delay value is applied to fade-in and fade-out animations.

setOnShowcaseStarted

public void setOnShowcaseStarted(javafx.event.EventHandler<? super ShowcaseEvent> handler)

Defines a function to be called when the showcase is started. It will be triggered after the start animation is finished.

getOnShowcaseStarted

public javafx.event.EventHandler<? super ShowcaseEvent> getOnShowcaseStarted()

setOnShowcaseStopped

public void setOnShowcaseStopped(javafx.event.EventHandler<? super ShowcaseEvent> handler)

Defines a function to be called when the showcase is stopped. It will be triggered after the close animation is finished.

getOnShowcaseStopped

public javafx.event.EventHandler<? super ShowcaseEvent> getOnShowcaseStopped()

setOnShowcaseStepDisplay

public void setOnShowcaseStepDisplay(javafx.event.EventHandler<? super ShowcaseEvent> handler)

Defines a function to be called when the showcase is stopped. It will be triggered after the close animation is finished.

getOnShowcaseStepDisplay

public javafx.event.EventHandler<? super ShowcaseEvent> getOnShowcaseStepDisplay()