public class com.jfxia.wipe.BlindWipe

Inherits from: com.sun.javafx.runtime.FXBase > com.jfxia.wipe.BlindWipe com.jfxia.wipe.Wipe,

Known subclasses:

• Jump to Section:
• overview
• variables
• functions

access	name	type	Can Read	Can Init	Can Write	Default Value	description
public	BOTTOM_TO_TOP	Integer					Wipe from bottom to top (horizontal blinds).
public	LEFT_TO_RIGHT	Integer					Wipe from left to right (vertical blinds).
public	RIGHT_TO_LEFT	Integer					Wipe from right to left (vertical blinds).
public	TOP_TO_BOTTOM	Integer					Wipe from top to bottom (horizontal blinds).

access	name	type	Can Read	Can Init	Can Write	Default Value	description
public	blinds	Integer					Number of blind segments (default 5).
public	direction	Integer					Direction of the blinds (default: LEFT_TO_RIGHT).

Inherited Variables

com.jfxia.wipe.Wipe

access	name	type	Can Read	Can Init	Can Write	Default Value	description
public	time	Duration					Duration of the wipe effect.

Inherited Functions

com.jfxia.wipe.Wipe

public abstract postWipe(wp: WipePanel, frm: Node, to: Node) : Void

Called after the wipe ends.

Called after the wipe ends. Any clean up should be done here, and the 'to' node should be hooked into the WipePanel as its only child. Important: this function is called even if the wipe was abandoned mid-way through, so do not assume the 'to' node is in its final state.

Parameters

wp

The containing panel

frm

The node showing at the start of the wipe

to

The node showing at the end of the wipe

 

public abstract preWipe(wp: WipePanel, frm: Node, to: Node) : Void

Called before the wipe begins.

Called before the wipe begins. If the wipe needs to perform any prep before running, or clean up from a previous run, this is where it should be done.

Parameters

wp

The containing panel

frm

The node showing at the start of the wipe

to

The node showing at the end of the wipe

 

public abstract wipe(wp: WipePanel, frm: Node, to: Node) : javafx.animation.Timeline

Creates a timeline object that performs the wipe.

Creates a timeline object that performs the wipe.

Parameters

wp

The containing panel

frm

The node showing at the start of the wipe

to

The node showing at the end of the wipe

Returns

Timeline