Module is.codion.swing.common.ui

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

Class AbstractDialogBuilder<B extends DialogBuilder<B>>

java.lang.Object

is.codion.swing.common.ui.dialog.AbstractDialogBuilder<B>

Type Parameters:

B - the builder type

All Implemented Interfaces:

DialogBuilder<B>

public abstract class AbstractDialogBuilder<B extends DialogBuilder<B>>
extends Object
implements DialogBuilder<B>

A base class for Dialog builders.

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable ImageIcon	icon
protected final List<KeyEvents.Builder>	keyEventBuilders
protected @Nullable Point	location
protected @Nullable Component	locationRelativeTo
protected final List<Consumer<JDialog>>	onBuildConsumers
protected @Nullable Window	owner
protected @Nullable Observable<String>	title
protected boolean	undecorated
protected final List<WindowFocusListener>	windowFocusListeners

Constructor Summary

Constructors

Constructor	Description
AbstractDialogBuilder()

Method Summary

Modifier and Type	Method	Description
protected final <T extends DialogBuilder<?>> T	configure(T builder)	Configures the given builder with the options this builder holds, the ones of DialogBuilder: the owner, the location, the title, the icon, undecorated, the key events, the window focus listeners and the on-build consumers, for a builder that has another build its dialog.
final B	icon(@Nullable ImageIcon icon)
final B	keyEvent(KeyEvents.Builder keyEventBuilder)	Enables the key event defined by the given KeyEvents.Builder on the dialog root pane.
final B	location(@Nullable Point location)	Overrides DialogBuilder.locationRelativeTo(Component).
final B	locationRelativeTo(@Nullable Component locationRelativeTo)
final B	onBuild(Consumer<JDialog> onBuild)
final B	owner(@Nullable Component owner)	Sets the dialog owner as the parent window of the given component.
final B	owner(@Nullable Window owner)	Sets the dialog owner as the given window.
protected final B	self()
final B	title(@Nullable Observable<String> title)
final B	title(@Nullable String title)
final B	undecorated(boolean undecorated)
final B	windowFocusListener(WindowFocusListener windowFocusListener)

Methods inherited from class java.lang.Object

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

Field Details

keyEventBuilders

protected final List<KeyEvents.Builder> keyEventBuilders

onBuildConsumers

protected final List<Consumer<JDialog>> onBuildConsumers

windowFocusListeners

protected final List<WindowFocusListener> windowFocusListeners

owner

protected @Nullable Window owner

locationRelativeTo

protected @Nullable Component locationRelativeTo

location

protected @Nullable Point location

title

protected @Nullable Observable<String> title

icon

protected @Nullable ImageIcon icon

undecorated

protected boolean undecorated

Constructor Details

AbstractDialogBuilder

public AbstractDialogBuilder()

Method Details

owner

public final B owner(@Nullable Window owner)

Description copied from interface: DialogBuilder

Sets the dialog owner as the given window. Also sets the DialogBuilder.locationRelativeTo(Component) to the given window in case one has not been specified.

Specified by:

owner in interface DialogBuilder<B extends DialogBuilder<B>>

Parameters:

owner - the dialog owner

Returns:

this DialogBuilder instance

owner

public final B owner(@Nullable Component owner)

Description copied from interface: DialogBuilder

Sets the dialog owner as the parent window of the given component. Also sets the DialogBuilder.locationRelativeTo(Component) using the given component in case one has not been specified.

Specified by:

owner in interface DialogBuilder<B extends DialogBuilder<B>>

Parameters:

owner - the dialog parent component

Returns:

this builder instance

locationRelativeTo

public final B locationRelativeTo(@Nullable Component locationRelativeTo)

Specified by:

locationRelativeTo in interface DialogBuilder<B extends DialogBuilder<B>>

Parameters:

locationRelativeTo - the component for the relative location

Returns:

this builder instance

location

public final B location(@Nullable Point location)

Description copied from interface: DialogBuilder

Overrides DialogBuilder.locationRelativeTo(Component).

Specified by:

location in interface DialogBuilder<B extends DialogBuilder<B>>

Parameters:

location - the location of the dialog

Returns:

this builder instance

title

public final B title(@Nullable String title)

Specified by:

title in interface DialogBuilder<B extends DialogBuilder<B>>

Parameters:

title - the dialog title

Returns:

this builder instance

title

public final B title(@Nullable Observable<String> title)

Specified by:

title in interface DialogBuilder<B extends DialogBuilder<B>>

Parameters:

title - an observable for a dynamic dialog title

Returns:

this builder instance

icon

public final B icon(@Nullable ImageIcon icon)

Specified by:

icon in interface DialogBuilder<B extends DialogBuilder<B>>

Parameters:

icon - the dialog icon

Returns:

this builder instance

keyEvent

public final B keyEvent(KeyEvents.Builder keyEventBuilder)

Description copied from interface: DialogBuilder

Enables the key event defined by the given KeyEvents.Builder on the dialog root pane.

Specified by:

keyEvent in interface DialogBuilder<B extends DialogBuilder<B>>

Parameters:

keyEventBuilder - a key event builder to enable on the dialog root pane

Returns:

this builder instance

undecorated

public final B undecorated(boolean undecorated)

Specified by:

undecorated in interface DialogBuilder<B extends DialogBuilder<B>>

Parameters:

undecorated - true if the dialog should be undecorated

Returns:

this builder instance

windowFocusListener

public final B windowFocusListener(WindowFocusListener windowFocusListener)

Specified by:

windowFocusListener in interface DialogBuilder<B extends DialogBuilder<B>>

Parameters:

windowFocusListener - a window focus listener

Returns:

this builder instance

onBuild

public final B onBuild(Consumer<JDialog> onBuild)

Specified by:

onBuild in interface DialogBuilder<B extends DialogBuilder<B>>

Parameters:

onBuild - called when the dialog has been built, before it is shown

Returns:

this builder instance

configure

protected final <T extends DialogBuilder<?>> T configure(T builder)

Configures the given builder with the options this builder holds, the ones of DialogBuilder: the owner, the location, the title, the icon, undecorated, the key events, the window focus listeners and the on-build consumers, for a builder that has another build its dialog. Null options are left to the builder given, whose own settings, chained after this, override.

Type Parameters:

T - the builder type

Parameters:

builder - the builder building the dialog

Returns:

the builder given

self

protected final B self()