jidefx.utils

Class AutoRepeatButtonUtils

java.lang.Object

jidefx.utils.AutoRepeatButtonUtils

public class AutoRepeatButtonUtils
extends java.lang.Object

AutoRepeatButtonUtils is a utility class which can make a button automatically trigger action events continuously. To enable this feature on any button, just call AutoRepeatButtonUtils.install(button) or AutoRepeatButtonUtils.install(button, initialDelay, interval).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTO_REPEAT
static java.lang.String	CLIENT_PROPERTY_AUTO_REPEAT
static javafx.util.Duration	DEFAULT_DELAY
static javafx.util.Duration	DEFAULT_INITIAL_DELAY

Constructor Summary

Constructors

Constructor and Description
AutoRepeatButtonUtils()

Method Summary

Modifier and Type	Method and Description
static void	install(javafx.scene.control.ButtonBase button) Enable auto-repeat feature on the button.
static void	install(javafx.scene.control.ButtonBase button, javafx.util.Duration initialDelay, javafx.util.Duration interval) Enable auto-repeat feature on the button.
protected void	installListeners(javafx.scene.control.ButtonBase button, javafx.util.Duration initialDelay, javafx.util.Duration interval)
static void	uninstall(javafx.scene.control.ButtonBase button) Disabled the auto-repeat feature on the button which called install before.
protected void	uninstallListeners()

Methods inherited from class java.lang.Object

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

Field Detail

AUTO_REPEAT

public static final java.lang.String AUTO_REPEAT

See Also:

Constant Field Values

CLIENT_PROPERTY_AUTO_REPEAT

public static final java.lang.String CLIENT_PROPERTY_AUTO_REPEAT

See Also:

Constant Field Values

DEFAULT_DELAY

public static final javafx.util.Duration DEFAULT_DELAY

DEFAULT_INITIAL_DELAY

public static final javafx.util.Duration DEFAULT_INITIAL_DELAY

Constructor Detail

AutoRepeatButtonUtils

public AutoRepeatButtonUtils()

Method Detail

install

public static void install(javafx.scene.control.ButtonBase button)

Enable auto-repeat feature on the button. By default, it will delay for 500 ms and then repeat every 50 ms.

Parameters:

button - the button.

install

public static void install(javafx.scene.control.ButtonBase button,
                           javafx.util.Duration initialDelay,
                           javafx.util.Duration interval)

Enable auto-repeat feature on the button.

Parameters:

button - the button.

initialDelay - the initial delay. It is from the time mouse is pressed to the first action event.

interval - the interval between action events.

uninstall

public static void uninstall(javafx.scene.control.ButtonBase button)

Disabled the auto-repeat feature on the button which called install before.

Parameters:

button - the button that has auto-repeat feature.

installListeners

protected void installListeners(javafx.scene.control.ButtonBase button,
                                javafx.util.Duration initialDelay,
                                javafx.util.Duration interval)

uninstallListeners

protected void uninstallListeners()