Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.dialog

Interface ProgressWorkerDialogBuilder<T,V>

Type Parameters:

T - the type of result this ProgressWorker produces.

V - the type of intermediate result this ProgressWorker produces.

All Superinterfaces:

DialogBuilder<ProgressWorkerDialogBuilder<T,V>>

public interface ProgressWorkerDialogBuilder<T,V>
extends DialogBuilder<ProgressWorkerDialogBuilder<T,V>>

A builder for a ProgressWorker implementation which displays a progress bar in a modal dialog while background work is being performed. The progress bar can be of type 'indeterminate' or with the progress ranging from 0 to 100.

See Also:

• to indicate work progress

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ProgressWorkerDialogBuilder.BuilderFactory	Provides builders for a given task type.

Method Summary

Modifier and Type	Method	Description
ProgressWorkerDialogBuilder<T,V>	border(@Nullable Border border)
ProgressWorker<T,V>	build()
ProgressWorkerDialogBuilder<T,V>	control(Control control)
ProgressWorkerDialogBuilder<T,V>	control(Control.Builder<?,?> controlBuilder)
ProgressWorkerDialogBuilder<T,V>	eastPanel(@Nullable JPanel eastPanel)
ProgressWorker<T,V>	execute()	Builds and executes a new ProgressWorker based on this builder
ProgressWorkerDialogBuilder<T,V>	indeterminate(boolean indeterminate)
ProgressWorkerDialogBuilder<T,V>	maximum(int maximum)	Note that calling this method renders the progress bar determinate
ProgressWorkerDialogBuilder<T,V>	northPanel(@Nullable JPanel northPanel)
ProgressWorkerDialogBuilder<T,V>	onException(String exceptionTitle)
ProgressWorkerDialogBuilder<T,V>	onException(Consumer<Exception> onException)
ProgressWorkerDialogBuilder<T,V>	onPublish(Consumer<List<V>> onPublish)
ProgressWorkerDialogBuilder<T,V>	onResult(Runnable onResult)
ProgressWorkerDialogBuilder<T,V>	onResult(String resultMessage)
ProgressWorkerDialogBuilder<T,V>	onResult(Consumer<T> onResult)
ProgressWorkerDialogBuilder<T,V>	progressBarSize(@Nullable Dimension progressBarSize)
ProgressWorkerDialogBuilder<T,V>	stringPainted(boolean stringPainted)
ProgressWorkerDialogBuilder<T,V>	westPanel(@Nullable JPanel westPanel)

Methods inherited from interface is.codion.swing.common.ui.dialog.DialogBuilder

icon, keyEvent, location, locationRelativeTo, onBuild, owner, owner, title, title

Method Details

indeterminate

ProgressWorkerDialogBuilder<T,V> indeterminate(boolean indeterminate)

Parameters:

indeterminate - true if the progress bar should be indeterminate

Returns:

this Builder instance

maximum

ProgressWorkerDialogBuilder<T,V> maximum(int maximum)

Note that calling this method renders the progress bar determinate

Parameters:

maximum - the maximum progress, 100 by default

Returns:

this Builder instance

See Also:

• indeterminate(boolean)

stringPainted

ProgressWorkerDialogBuilder<T,V> stringPainted(boolean stringPainted)

Parameters:

stringPainted - the string painted status of the progress bar

Returns:

this Builder instance

border

ProgressWorkerDialogBuilder<T,V> border(@Nullable Border border)

Parameters:

border - the border to add around the progress bar

Returns:

this Builder instance

northPanel

ProgressWorkerDialogBuilder<T,V> northPanel(@Nullable JPanel northPanel)

Parameters:

northPanel - if specified this panel will be added to the BorderLayout.NORTH position of the dialog

Returns:

this Builder instance

westPanel

ProgressWorkerDialogBuilder<T,V> westPanel(@Nullable JPanel westPanel)

Parameters:

westPanel - if specified this panel will be added to the BorderLayout.WEST position of the dialog

Returns:

this Builder instance

eastPanel

ProgressWorkerDialogBuilder<T,V> eastPanel(@Nullable JPanel eastPanel)

Parameters:

eastPanel - if specified this panel will be added to the BorderLayout.EAST position of the dialog

Returns:

this Builder instance

control

ProgressWorkerDialogBuilder<T,V> control(Control.Builder<?,?> controlBuilder)

Parameters:

controlBuilder - the control built by this builder will be added to the dialog as a button

Returns:

this Builder instance

control

ProgressWorkerDialogBuilder<T,V> control(Control control)

Parameters:

control - this control will be added to the dialog as a button

Returns:

this Builder instance

progressBarSize

ProgressWorkerDialogBuilder<T,V> progressBarSize(@Nullable Dimension progressBarSize)

Parameters:

progressBarSize - the size of the progress bar

Returns:

this Builder instance

onPublish

ProgressWorkerDialogBuilder<T,V> onPublish(Consumer<List<V>> onPublish)

Parameters:

onPublish - called on the Event Dispatch Thread when chunks are available for publishing

Returns:

this builder instance

onResult

ProgressWorkerDialogBuilder<T,V> onResult(Runnable onResult)

Parameters:

onResult - executed on the Event Dispatch Thread after a successful run

Returns:

this Builder instance

onResult

ProgressWorkerDialogBuilder<T,V> onResult(Consumer<T> onResult)

Parameters:

onResult - executed on the Event Dispatch Thread after a successful run

Returns:

this Builder instance

onResult

ProgressWorkerDialogBuilder<T,V> onResult(String resultMessage)

Parameters:

resultMessage - if specified then this message is displayed after the task has successfully run

Returns:

this Builder instance

onException

ProgressWorkerDialogBuilder<T,V> onException(Consumer<Exception> onException)

Parameters:

onException - the exception handler

Returns:

this Builder instance

onException

ProgressWorkerDialogBuilder<T,V> onException(String exceptionTitle)

Parameters:

exceptionTitle - the title of the exception dialog

Returns:

this Builder instance

execute

ProgressWorker<T,V> execute()

Builds and executes a new ProgressWorker based on this builder

Returns:

a ProgressWorker based on this builder

build

ProgressWorker<T,V> build()

Returns:

a ProgressWorker based on this builder