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

Interface FrameBuilder

public interface FrameBuilder
A builder for a JFrame.

  • Method Details

    • component

      FrameBuilder component(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(String title)
      Parameters:
      title - the title
      Returns:
      this builder instance

    • title

      FrameBuilder title(Observable<String> title)
      Parameters:
      title - an observable for a dynamic dialog title
      Returns:
      this builder instance

    • icon

      FrameBuilder icon(ImageIcon icon)
      Parameters:
      icon - the icon
      Returns:
      this builder instance

    • size

      FrameBuilder size(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

    • location

      FrameBuilder location(Point location)
      Overrides locationRelativeTo(Component) and centerFrame(boolean).
      Parameters:
      location - the frame location
      Returns:
      this builder instance

    • locationRelativeTo

      FrameBuilder locationRelativeTo(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

    • extendedState

      FrameBuilder extendedState(int extendedState)
      Parameters:
      extendedState - the extends state
      Returns:
      this builder instance
      See Also:

    • 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

    • 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