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 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 ImageIcon	icon
protected final List<KeyEvents.Builder>	keyEventBuilders
protected Point	location
protected Component	locationRelativeTo
protected Window	owner
protected ValueObserver<String>	titleProvider

Constructor Summary

Constructors

Constructor	Description
AbstractDialogBuilder()

Method Summary

Modifier and Type	Method	Description
final B	icon(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(Point location)	Overrides DialogBuilder.locationRelativeTo(Component).
final B	locationRelativeTo(Component locationRelativeTo)
final B	owner(Component owner)	Sets the dialog owner as the parent window of the given component.
final B	owner(Window owner)	Sets the dialog owner as the given window.
final B	title(String title)
final B	titleProvider(ValueObserver<String> titleProvider)

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

owner

protected Window owner

locationRelativeTo

protected Component locationRelativeTo

location

protected Point location

titleProvider

protected ValueObserver<String> titleProvider

icon

protected ImageIcon icon

Constructor Details

AbstractDialogBuilder

public AbstractDialogBuilder()

Method Details

owner

public final B owner(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(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(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(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(String title)

Specified by:

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

Parameters:

title - the dialog title

Returns:

this builder instance

titleProvider

public final B titleProvider(ValueObserver<String> titleProvider)

Specified by:

titleProvider in interface DialogBuilder<B extends DialogBuilder<B>>

Parameters:

titleProvider - a value observer for a dynamic dialog title

Returns:

this builder instance

icon

public final B icon(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