Module org.tquadrat.foundation.fx

Package org.tquadrat.foundation.fx.control

Class ErrorDisplay.MessageTrigger

java.lang.Object

org.tquadrat.foundation.fx.control.ErrorDisplay.MessageTrigger

Enclosing class:

ErrorDisplay

@ClassVersion(sourceVersion="$Id: ErrorDisplay.java 1112 2024-03-10 14:16:51Z tquadrat $")
@API(status=INTERNAL,
     since="0.4.3")
private final class ErrorDisplay.MessageTrigger
extends Object

Wraps a BooleanBinding with a message.

Each time the binding invalidates, it will be verified again and the error message will be added or removed from the error display.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: ErrorDisplay.java 1112 2024-03-10 14:16:51Z tquadrat $

Since:

0.4.3

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.fx.control.ErrorDisplay.MessageTrigger"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final BooleanBinding	m_Binding	The binding.
private final String	m_Id	The message id.
private final Supplier<String>	m_MessageSupplier	The supplier for the message text.

Constructor Summary

Constructors

Constructor	Description
MessageTrigger(String id, Supplier<String> messageSupplier, BooleanBinding binding)	Creates a new instance of MessageTrigger.

Method Summary

Modifier and Type	Method	Description
final void	disable()	Disables this message trigger in preparation of its disposal.
private final void	triggerMessage(Observable observable)	The invalidation listener that updates the error display.

Methods inherited from class java.lang.Object

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

Field Details

m_Binding

private final BooleanBinding m_Binding

The binding.

m_Id

private final String m_Id

The message id.

m_MessageSupplier

private final Supplier<String> m_MessageSupplier

The supplier for the message text.

Constructor Details

MessageTrigger

public MessageTrigger(String id,
 Supplier<String> messageSupplier,
 BooleanBinding binding)

Creates a new instance of MessageTrigger.

The message will be displayed when the given instance of BooleanBinding evaluates to true.

Parameters:

id - The message id.

messageSupplier - The supplier for the message text.

binding - The binding that controls the appearance of the message.

Method Details

disable

public final void disable()

Disables this message trigger in preparation of its disposal.

triggerMessage

private final void triggerMessage(Observable observable)

The invalidation listener that updates the error display.

Parameters:

observable - The observable that became invalid.