Module is.codion.swing.common.ui

Package is.codion.swing.common.ui

Interface Windows.FrameBuilder

Enclosing class:

Windows

public static interface Windows.FrameBuilder

A builder for a JFrame.

Method Summary

Modifier and Type	Method	Description
JFrame	build()
Windows.FrameBuilder	centerFrame(boolean centerFrame)	This is overridden by location(Point) or by setting the locationRelativeTo(Component) component.
Windows.FrameBuilder	defaultCloseOperation(int defaultCloseOperation)	Default WindowConstants.DISPOSE_ON_CLOSE.
Windows.FrameBuilder	extendedState(int extendedState)
Windows.FrameBuilder	icon(ImageIcon icon)
Windows.FrameBuilder	location(Point location)	Overrides locationRelativeTo(Component) and centerFrame(boolean).
Windows.FrameBuilder	locationRelativeTo(Component locationRelativeTo)
Windows.FrameBuilder	menuBar(JMenuBar menuBar)
Windows.FrameBuilder	onClosed(Consumer<WindowEvent> onClosed)
Windows.FrameBuilder	onClosing(Consumer<WindowEvent> onClosing)
Windows.FrameBuilder	onOpened(Consumer<WindowEvent> onOpened)
Windows.FrameBuilder	resizable(boolean resizable)
JFrame	show()	Builds and shows a JFrame based on this builder
Windows.FrameBuilder	size(Dimension size)
Windows.FrameBuilder	title(String title)
Windows.FrameBuilder	titleProvider(ValueObserver<String> titleProvider)
Windows.FrameBuilder	windowListener(WindowListener windowListener)

Method Details

title

Windows.FrameBuilder title(String title)

Parameters:

title - the title

Returns:

this builder instance

titleProvider

Windows.FrameBuilder titleProvider(ValueObserver<String> titleProvider)

Parameters:

titleProvider - a value observer for a dynamic dialog title

Returns:

this builder instance

icon

Windows.FrameBuilder icon(ImageIcon icon)

Parameters:

icon - the icon

Returns:

this builder instance

size

Windows.FrameBuilder size(Dimension size)

Parameters:

size - the size

Returns:

this builder instance

resizable

Windows.FrameBuilder resizable(boolean resizable)

Parameters:

resizable - true if the frame should be resizable

Returns:

this builder instance

location

Windows.FrameBuilder location(Point location)

Overrides locationRelativeTo(Component) and centerFrame(boolean).

Parameters:

location - the frame location

Returns:

this builder instance

locationRelativeTo

Windows.FrameBuilder locationRelativeTo(Component locationRelativeTo)

Parameters:

locationRelativeTo - the component to which the location should be relative

Returns:

this builder instance

onOpened

Windows.FrameBuilder onOpened(Consumer<WindowEvent> onOpened)

Parameters:

onOpened - called when the frame has been opened

Returns:

this builder instance

onClosed

Windows.FrameBuilder onClosed(Consumer<WindowEvent> onClosed)

Parameters:

onClosed - called when the frame has been closed

Returns:

this builder instance

onClosing

Windows.FrameBuilder onClosing(Consumer<WindowEvent> onClosing)

Parameters:

onClosing - called when the frame is about to be closed

Returns:

this builder instance

defaultCloseOperation

Windows.FrameBuilder defaultCloseOperation(int defaultCloseOperation)

Default WindowConstants.DISPOSE_ON_CLOSE.

Parameters:

defaultCloseOperation - the default frame close operation

Returns:

this builder instance

menuBar

Windows.FrameBuilder menuBar(JMenuBar menuBar)

Parameters:

menuBar - the main menu bar

Returns:

this builder instance

extendedState

Windows.FrameBuilder extendedState(int extendedState)

Parameters:

extendedState - the extends state

Returns:

this builder instance

See Also:

• Frame.setExtendedState(int)

centerFrame

Windows.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

Windows.FrameBuilder windowListener(WindowListener windowListener)

Parameters:

windowListener - a window listener

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