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

Interface Controls.Layout

Enclosing interface:
Controls
public static interface Controls.Layout
Specifies a layout for a Controls instance.

  • Method Details

    • separator

      Controls.Layout separator()
      Adds a separator
      Returns:
      this layout instance

    • control

      Controls.Layout control(ControlKey<?> controlKey)
      Adds a standard control
      Parameters:
      controlKey - the key identifying the standard control to add
      Returns:
      this layout instance

    • control

      Controls.Layout control(Control control)
      Parameters:
      control - the control to add
      Returns:
      this layout instance

    • control

      Controls.Layout control(Supplier<? extends Control> control)
      Parameters:
      control - the control to add
      Returns:
      this layout instance

    • controls

      Controls.Layout controls(ControlKey<Controls> controlsKey)
      Adds standard controls
      Parameters:
      controlsKey - the key identifying the standard controls to add
      Returns:
      this layout instance

    • controls

      Controls.Layout controls(Controls.ControlsKey controlsKey, Consumer<Controls.Layout> layout)
      Adds standard configurable controls
      Parameters:
      controlsKey - the controls key
      layout - provides a way to configure the layout
      Returns:
      this layout instance
      Throws:
      IllegalArgumentException - in case the Controls associated with controlsKey does not provide a default layout

    • action

      Controls.Layout action(Action action)
      Parameters:
      action - the Action to add
      Returns:
      this layout instance

    • defaults

      Controls.Layout defaults()
      Adds all remaining default controls
      Returns:
      this layout instance

    • defaults

      Controls.Layout defaults(ControlKey<?> stopAt)
      Adds all remaining default controls, up until and including stopAt
      Parameters:
      stopAt - the standard control to stop at (inclusive)
      Returns:
      this layout instance

    • clear

      Controls.Layout clear()
      Clears all controls from this layout
      Returns:
      this layout instance

    • copy

      Controls.Layout copy()
      Returns:
      a copy of this Controls.Layout instance

    • create

      Controls create(ControlMap controlMap)
      Parameters:
      controlMap - provides the standard controls
      Returns:
      a Controls instance based on this layout