Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.frame

Interface FrameBuilder

public interface FrameBuilder

A builder for a JFrame.

Method Summary

Modifier and Type	Method	Description
FrameBuilder	alwaysOnTop(boolean alwaysOnTop)
JFrame	build()
FrameBuilder	centerFrame(boolean centerFrame)	This is overridden by location(Point) or by setting the locationRelativeTo(Component) component.
FrameBuilder	component(@Nullable JComponent component)	Note: sets the layout to BorderLayout and adds the component at location BorderLayout.CENTER
FrameBuilder	componentListener(ComponentListener componentListener)
FrameBuilder	defaultCloseOperation(int defaultCloseOperation)	Default WindowConstants.DISPOSE_ON_CLOSE.
FrameBuilder	extendedState(int extendedState)
FrameBuilder	focusableWindowState(boolean focusableWindowState)
FrameBuilder	icon(@Nullable ImageIcon icon)	Clears any icon images previously set via iconImage(Image) or iconImages(List)
FrameBuilder	iconImage(@Nullable Image iconImage)	Clears any icons previously set via icon(ImageIcon), iconImage(Image) or iconImages(List)
FrameBuilder	iconImages(List<Image> iconImages)	Clears any icons previously set via icon(ImageIcon), iconImage(Image) or iconImages(List)
FrameBuilder	location(@Nullable Point location)	Overrides locationRelativeTo(Component) and centerFrame(boolean).
FrameBuilder	locationRelativeTo(@Nullable Component locationRelativeTo)
FrameBuilder	menuBar(@Nullable JMenuBar menuBar)
FrameBuilder	onBuild(Consumer<JFrame> onBuild)
FrameBuilder	onClosed(Consumer<WindowEvent> onClosed)
FrameBuilder	onClosing(Consumer<WindowEvent> onClosing)
FrameBuilder	onOpened(Consumer<WindowEvent> onOpened)
FrameBuilder	resizable(boolean resizable)
JFrame	show()	Builds and shows a JFrame based on this builder
FrameBuilder	size(@Nullable Dimension size)
FrameBuilder	title(@Nullable Observable<String> title)
FrameBuilder	title(@Nullable String title)
FrameBuilder	windowListener(WindowListener windowListener)

Method Details

component

FrameBuilder component(@Nullable JComponent component)

Note: sets the layout to BorderLayout and adds the component at location BorderLayout.CENTER

Parameters:

component - the component to display

Returns:

this builder instance

title

FrameBuilder title(@Nullable String title)

Parameters:

title - the title

Returns:

this builder instance

title

FrameBuilder title(@Nullable Observable<String> title)

Parameters:

title - an observable for a dynamic dialog title

Returns:

this builder instance

icon

FrameBuilder icon(@Nullable ImageIcon icon)

Clears any icon images previously set via iconImage(Image) or iconImages(List)

Parameters:

icon - the icon

Returns:

this builder instance

iconImage

FrameBuilder iconImage(@Nullable Image iconImage)

Clears any icons previously set via icon(ImageIcon), iconImage(Image) or iconImages(List)

Parameters:

iconImage - the icon image

Returns:

ths builder instance

See Also:

• JFrame.setIconImage(Image)

iconImages

FrameBuilder iconImages(List<Image> iconImages)

Clears any icons previously set via icon(ImageIcon), iconImage(Image) or iconImages(List)

Parameters:

iconImages - the icon images

Returns:

ths builder instance

See Also:

• Window.setIconImages(List)

size

FrameBuilder size(@Nullable Dimension size)

Parameters:

size - the size

Returns:

this builder instance

resizable

FrameBuilder resizable(boolean resizable)

Parameters:

resizable - true if the frame should be resizable

Returns:

this builder instance

alwaysOnTop

FrameBuilder alwaysOnTop(boolean alwaysOnTop)

Parameters:

alwaysOnTop - true if the frame should always be on top

Returns:

this builder instance

See Also:

• Window.setAlwaysOnTop(boolean)

focusableWindowState

FrameBuilder focusableWindowState(boolean focusableWindowState)

Parameters:

focusableWindowState - the focusable window state

Returns:

this builder instance

See Also:

• Window.setFocusableWindowState(boolean)

location

FrameBuilder location(@Nullable Point location)

Overrides locationRelativeTo(Component) and centerFrame(boolean).

Parameters:

location - the frame location

Returns:

this builder instance

locationRelativeTo

FrameBuilder locationRelativeTo(@Nullable Component locationRelativeTo)

Parameters:

locationRelativeTo - the component to which the location should be relative

Returns:

this builder instance

onOpened

FrameBuilder onOpened(Consumer<WindowEvent> onOpened)

Parameters:

onOpened - called when the frame has been opened

Returns:

this builder instance

onClosed

FrameBuilder onClosed(Consumer<WindowEvent> onClosed)

Parameters:

onClosed - called when the frame has been closed

Returns:

this builder instance

onClosing

FrameBuilder onClosing(Consumer<WindowEvent> onClosing)

Parameters:

onClosing - called when the frame is about to be closed

Returns:

this builder instance

defaultCloseOperation

FrameBuilder defaultCloseOperation(int defaultCloseOperation)

Default WindowConstants.DISPOSE_ON_CLOSE.

Parameters:

defaultCloseOperation - the default frame close operation

Returns:

this builder instance

menuBar

FrameBuilder menuBar(@Nullable JMenuBar menuBar)

Parameters:

menuBar - the main menu bar

Returns:

this builder instance

extendedState

FrameBuilder extendedState(int extendedState)

Parameters:

extendedState - the extends state

Returns:

this builder instance

See Also:

• Frame.setExtendedState(int)

centerFrame

FrameBuilder centerFrame(boolean centerFrame)

This is overridden by location(Point) or by setting the locationRelativeTo(Component) component.

Parameters:

centerFrame - true if the frame should be centered in on the screen

Returns:

this builder instance

windowListener

FrameBuilder windowListener(WindowListener windowListener)

Parameters:

windowListener - a window listener

Returns:

this builder instance

componentListener

FrameBuilder componentListener(ComponentListener componentListener)

Parameters:

componentListener - the component listener

Returns:

this builder instance

onBuild

FrameBuilder onBuild(Consumer<JFrame> onBuild)

Parameters:

onBuild - called when the frame has been built.

Returns:

this builder instance

build

JFrame build()

Returns:

a JFrame based on this builder

show

JFrame show()

Builds and shows a JFrame based on this builder

Returns:

a JFrame based on this builder