Module is.codion.swing.common.ui

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

Interface ProgressDialog.Builder

All Superinterfaces:

DialogBuilder<ProgressDialog.Builder>

Enclosing class:

ProgressDialog

public static interface ProgressDialog.Builder
extends DialogBuilder<ProgressDialog.Builder>

A builder for ProgressDialog.

Method Summary

Modifier and Type	Method	Description
ProgressDialog.Builder	border(@Nullable Border border)
ProgressDialog	build()
ProgressDialog.Builder	control(Control control)	Adds a button based on the given control to the BorderLayout.SOUTH position
ProgressDialog.Builder	control(Supplier<? extends Control> control)	Adds a button based on the given control to the BorderLayout.SOUTH position
ProgressDialog.Builder	eastComponent(@Nullable JComponent eastComponent)
ProgressDialog.Builder	indeterminate(boolean indeterminate)
ProgressDialog.Builder	maximum(int maximum)	Note that calling this method renders the progress bar determinate
ProgressDialog.Builder	northComponent(@Nullable JComponent northComponent)
ProgressDialog.Builder	progressBarSize(@Nullable Dimension progressBarSize)
ProgressDialog.Builder	stringPainted(boolean stringPainted)
ProgressDialog.Builder	westComponent(@Nullable JComponent westComponent)

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

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

Method Details

indeterminate

ProgressDialog.Builder indeterminate(boolean indeterminate)

Parameters:

indeterminate - the indeterminate status of the progress bar

Returns:

this ProgressDialogBuilder instance

maximum

ProgressDialog.Builder maximum(int maximum)

Note that calling this method renders the progress bar determinate

Parameters:

maximum - the maximum progress, 100 by default

Returns:

this ProgressDialogBuilder instance

See Also:

• indeterminate(boolean)

stringPainted

ProgressDialog.Builder stringPainted(boolean stringPainted)

Parameters:

stringPainted - the string painted status of the progress bar

Returns:

this ProgressDialogBuilder instance

northComponent

ProgressDialog.Builder northComponent(@Nullable JComponent northComponent)

Parameters:

northComponent - if specified this component is added to the BorderLayout.NORTH position

Returns:

this ProgressDialogBuilder instance

westComponent

ProgressDialog.Builder westComponent(@Nullable JComponent westComponent)

Parameters:

westComponent - if specified this component is added to the BorderLayout.WEST position

Returns:

this ProgressDialogBuilder instance

eastComponent

ProgressDialog.Builder eastComponent(@Nullable JComponent eastComponent)

Parameters:

eastComponent - if specified this component is added to the BorderLayout.EAST position

Returns:

this ProgressDialogBuilder instance

control

ProgressDialog.Builder control(Supplier<? extends Control> control)

Adds a button based on the given control to the BorderLayout.SOUTH position

Parameters:

control - the control to add

Returns:

this ProgressDialogBuilder instance

control

ProgressDialog.Builder control(Control control)

Adds a button based on the given control to the BorderLayout.SOUTH position

Parameters:

control - the control to add

Returns:

this ProgressDialogBuilder instance

progressBarSize

ProgressDialog.Builder progressBarSize(@Nullable Dimension progressBarSize)

Parameters:

progressBarSize - the progress bar size

Returns:

this ProgressDialogBuilder instance

border

ProgressDialog.Builder border(@Nullable Border border)

Parameters:

border - the border to add around the progress bar

Returns:

this ProgressDialogBuilder instance

build

ProgressDialog build()

Returns:

a new ProgressDialog