org.openpnp.util

Class UiUtils

java.lang.Object

org.openpnp.util.UiUtils

public class UiUtils
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UiUtils.Thrunnable Functional interface for a Runnable that can throw an Exception but returns no value.

Constructor Summary

Constructors

Constructor and Description
UiUtils()

Method Summary

Modifier and Type	Method and Description
static void	confirmMoveToLocationAndAct(java.awt.Component parentComponent, java.lang.String moveBeforeActionDescription, boolean allowWithoutMove, UiUtils.Thrunnable motionThrunnable, UiUtils.Thrunnable actionThrunnable)
static void	confirmMoveToLocationAndAct(java.awt.Component parentComponent, java.lang.String moveBeforeActionDescription, HeadMountable movable, Location location, boolean allowWithoutMove, UiUtils.Thrunnable actionThrunnable) Some UI actions require the machine to move to a certain location as a prerequisite (e.g.
static void	messageBoxOnException(UiUtils.Thrunnable thrunnable) Functional wrapper for actions that may throw an Exception.
static void	messageBoxOnExceptionLater(UiUtils.Thrunnable thrunnable) Functional wrapper for actions that may throw an Exception.
static void	showError(java.lang.Throwable t) Show an error using a message box, if the GUI is present, otherwise just log the error.
static <T> java.util.concurrent.Future<T>	submitUiMachineTask(java.util.concurrent.Callable<T> callable) Wrapper for submitMachineTask(Callable, Consumer, Consumer) which ignores the return value in onSuccess and shows a MessageBox when an Exception is thrown.
static <T> java.util.concurrent.Future<T>	submitUiMachineTask(java.util.concurrent.Callable<T> callable, java.util.function.Consumer<T> onSuccess, java.util.function.Consumer<java.lang.Throwable> onFailure) Functional version of Machine.submit which guarantees that the the onSuccess and onFailure handlers will be run on the Swing event thread.
static <T> java.util.concurrent.Future<T>	submitUiMachineTask(java.util.concurrent.Callable<T> callable, java.util.function.Consumer<T> onSuccess, java.util.function.Consumer<java.lang.Throwable> onFailure, boolean ignoreEnabled) Functional version of Machine.submit which guarantees that the the onSuccess and onFailure handlers will be run on the Swing event thread.
static java.util.concurrent.Future<java.lang.Void>	submitUiMachineTask(UiUtils.Thrunnable thrunnable) Shortcut for submitMachineTask(Callable) which uses a Thrunnable instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

UiUtils

public UiUtils()

Method Detail

submitUiMachineTask

public static java.util.concurrent.Future<java.lang.Void> submitUiMachineTask(UiUtils.Thrunnable thrunnable)

Shortcut for submitMachineTask(Callable) which uses a Thrunnable instead. This allows for simple tasks that may throw an Exception but return nothing.

Parameters:

thrunnable -

Returns:

submitUiMachineTask

public static <T> java.util.concurrent.Future<T> submitUiMachineTask(java.util.concurrent.Callable<T> callable)

Wrapper for submitMachineTask(Callable, Consumer, Consumer) which ignores the return value in onSuccess and shows a MessageBox when an Exception is thrown. Handy for simple tasks that don't care about the return value but want to notify the user in case of failure. Ideal for running Machine tasks from ActionListeners.

Parameters:

callable -

Returns:

showError

public static void showError(java.lang.Throwable t)

Show an error using a message box, if the GUI is present, otherwise just log the error.

Parameters:

t -

submitUiMachineTask

public static <T> java.util.concurrent.Future<T> submitUiMachineTask(java.util.concurrent.Callable<T> callable,
                                                                     java.util.function.Consumer<T> onSuccess,
                                                                     java.util.function.Consumer<java.lang.Throwable> onFailure)

Functional version of Machine.submit which guarantees that the the onSuccess and onFailure handlers will be run on the Swing event thread.

Parameters:

callable -

onSuccess -

onFailure -

Returns:

submitUiMachineTask

public static <T> java.util.concurrent.Future<T> submitUiMachineTask(java.util.concurrent.Callable<T> callable,
                                                                     java.util.function.Consumer<T> onSuccess,
                                                                     java.util.function.Consumer<java.lang.Throwable> onFailure,
                                                                     boolean ignoreEnabled)

Functional version of Machine.submit which guarantees that the the onSuccess and onFailure handlers will be run on the Swing event thread. Includes the ignoreEnabled argument.

Parameters:

callable -

onSuccess -

onFailure -

ignoreEnabled -

Returns:

messageBoxOnException

public static void messageBoxOnException(UiUtils.Thrunnable thrunnable)

Functional wrapper for actions that may throw an Exception. Presents an error box to the user with the Exception contents if one is thrown. Basically saves like 5 lines of boilerplate in actions.

Parameters:

thrunnable -

messageBoxOnExceptionLater

public static void messageBoxOnExceptionLater(UiUtils.Thrunnable thrunnable)

Functional wrapper for actions that may throw an Exception. Presents an error box to the user with the Exception contents if one is thrown. The action is performed later on the GUI thread.

Parameters:

thrunnable -

confirmMoveToLocationAndAct

public static void confirmMoveToLocationAndAct(java.awt.Component parentComponent,
                                               java.lang.String moveBeforeActionDescription,
                                               HeadMountable movable,
                                               Location location,
                                               boolean allowWithoutMove,
                                               UiUtils.Thrunnable actionThrunnable)

Some UI actions require the machine to move to a certain location as a prerequisite (e.g. editing a pipeline). For some actions this might be unexpected for the user. This wrapper asks the user to confirm the move, if not already at the location. It also handles a disabled machine and lets the user proceed, if this is an option. It then moves to the location at safe Z, and executes the action thrunnable. The wrapper also handles all the proper GUI/machine task dispatching and shows message boxes on Exceptions.

Parameters:

parentComponent -

moveBeforeActionDescription -

movable -

location -

allowWithoutMove -

actionThrunnable -

confirmMoveToLocationAndAct

public static void confirmMoveToLocationAndAct(java.awt.Component parentComponent,
                                               java.lang.String moveBeforeActionDescription,
                                               boolean allowWithoutMove,
                                               UiUtils.Thrunnable motionThrunnable,
                                               UiUtils.Thrunnable actionThrunnable)