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

Interface ControlBuilder<C extends Control,B extends ControlBuilder<C,B>>

Type Parameters:
C - the Control type
B - the builder type
All Superinterfaces:
Supplier<C>
All Known Subinterfaces:
CommandControl.CommandControlBuilder, ControlsBuilder, ToggleControlBuilder
public interface ControlBuilder<C extends Control,B extends ControlBuilder<C,B>> extends Supplier<C>
A builder for Control

  • Method Details

    • caption

      B caption(@Nullable String caption)
      Parameters:
      caption - the caption for the control
      Returns:
      this Builder instance

    • enabled

      B enabled(@Nullable ObservableState enabled)
      Parameters:
      enabled - the state observer which controls the enabled state of the control
      Returns:
      this Builder instance

    • mnemonic

      B mnemonic(int mnemonic)
      Parameters:
      mnemonic - the control mnemonic
      Returns:
      this Builder instance

    • icon

      B icon(@Nullable ControlIcon icon)
      Sets both the small and large icons.
      Parameters:
      icon - the control icon
      Returns:
      this Builder instance
      See Also:

    • smallIcon

      B smallIcon(@Nullable Icon smallIcon)
      Parameters:
      smallIcon - the small control icon
      Returns:
      this Builder instance

    • largeIcon

      B largeIcon(@Nullable Icon largeIcon)
      Parameters:
      largeIcon - the large control icon
      Returns:
      this Builder instance

    • description

      B description(@Nullable String description)
      Parameters:
      description - a string describing the control
      Returns:
      this Builder instance

    • foreground

      B foreground(@Nullable Color foreground)
      Parameters:
      foreground - the foreground color
      Returns:
      this Builder instance

    • background

      B background(@Nullable Color background)
      Parameters:
      background - the background color
      Returns:
      this Builder instance

    • font

      B font(@Nullable Font font)
      Parameters:
      font - the font
      Returns:
      this Builder instance

    • keyStroke

      B keyStroke(@Nullable KeyStroke keyStroke)
      Parameters:
      keyStroke - the keystroke to associate with the control
      Returns:
      this Builder instance

    • value

      B value(String key, @Nullable Object value)
      Note that any values added will overwrite the property, if already present, i.e. setting the 'SmallIcon' value via this method will overwrite the one set via smallIcon(Icon).
      Parameters:
      key - the key
      value - the value
      Returns:
      this builder
      See Also:

    • build

      C build()
      Returns:
      a new Control instance
      Throws:
      IllegalStateException - in case no command has been set

    • get

      default C get()
      Specified by:
      get in interface Supplier<C extends Control>