public class com.jfxia.wipe.SwingInOutWipe

Inherits from: com.sun.javafx.runtime.FXBase > com.jfxia.wipe.SwingInOutWipe 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	Integer					Wipe from/to the bottom edge.
public	BOTTOM_LEFT	Integer					Wipe from/to the bottom left corner, outwards.
public	BOTTOM_RIGHT	Integer					Wipe from/to the bottom right corner, outwards.
public	IN	Integer					New node swings in, hiding existing node.
public	LEFT	Integer					Wipe from/to the left edge.
public	OUT	Integer					Existing node swings away, revealing new node.
public	RIGHT	Integer					Wipe from/to the right edge.
public	TOP	Integer					Wipe from/to the top edge.
public	TOP_LEFT	Integer					Wipe from/to the top left corner, outwards.
public	TOP_RIGHT	Integer					Wipe from/to the top right corner, outwards.

access	name	type	Can Read	Can Init	Can Write	Default Value	description
public	anchor	Integer					Anchor of the wipe: which edge or a corner provides the 'hinge' (default: LEFT).
public	direction	Integer					Direction of the wipe (default: IN).

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