de.ipcon.form

Interface AsyncRefreshExecutorI

All Known Implementing Classes:

FCanvas, FChart, FComboBox, FDateChooser, FEmail, FImage, FLabel, FPDFViewer, FPopup, FScheduler, FSimpleDurationChooser, FSimpleTimespanChooser, FText, FTextInputComponent, FTimespanChooser, FUri, LiquidSeparatorLabel

public interface AsyncRefreshExecutorI

An interface for executing asynchronous refresh operations. This interface defines the contract for an object that can handle the full lifecycle of an asynchronous UI refresh, including calculating a value off the main thread, rendering it on the main thread, and managing the display state to prevent race conditions.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	calculateDisplayValue(AsyncRefreshRequestI asyncRefreshRequest) Calculates a display value for an asynchronous refresh request.
void	lockDisplayValue() Locks the UI component that displays the value to prevent concurrent inputs during async refresh operations.
void	renderDisplayValue(AsyncRefreshRequestI asyncRefreshRequest, java.lang.Object displayValue) Renders the calculated value on the UI.
void	restoreLockstateOfDisplayValue() Unlocks the UI component that displays the value again.

Method Detail

calculateDisplayValue

java.lang.Object calculateDisplayValue(AsyncRefreshRequestI asyncRefreshRequest)

Calculates a display value for an asynchronous refresh request. Possibly also calculates some internal settings for the component. This method is intended to be executed on a background thread to perform a potentially long-running or resource-intensive calculation without blocking the UI. Therefore it must not run on the EDT thread and must not directly modify the GUI. The returned object is the raw, non-rendered value that will be passed to the renderDisplayValue method.

Parameters:

asyncRefreshRequest - The refresh request containing all necessary context and data for the calculation.

Returns:

The calculated value, which can be any Object.

renderDisplayValue

void renderDisplayValue(AsyncRefreshRequestI asyncRefreshRequest,
                        java.lang.Object displayValue)

Renders the calculated value on the UI. This method is executed on the EDT thread (the Event Dispatch Thread in Swing) and is responsible for safely updating the visual component with the provided value. This ensures that UI modifications happen in a thread-safe manner.

Parameters:

asyncRefreshRequest - The original refresh request.

displayValue - The raw Object value returned by the calculateDisplayValue method, or a caught Exception.

lockDisplayValue

void lockDisplayValue()

Locks the UI component that displays the value to prevent concurrent inputs during async refresh operations. This method is called before the background calculation begins. It should lock or disable the relevant UI component to prevent the user from interacting with it while it is being updated, thereby avoiding inconsistent state or unexpected behavior.

restoreLockstateOfDisplayValue

void restoreLockstateOfDisplayValue()

Unlocks the UI component that displays the value again. This method is called after the value has been rendered. It is responsible for restoring the UI component's state to its original, unlocked state.