Module io.github.sosuisen.api.jfxbuilder.controls
Package io.github.sosuisen.jfxbuilder.controls

Class CheckMenuItemBuilder

java.lang.Object
io.github.sosuisen.jfxbuilder.controls.CheckMenuItemBuilder
public class CheckMenuItemBuilder extends Object
The CheckMenuItemBuilder class constructs instances of the CheckMenuItem class and offers a fluent interface for creating and configuring it.

This class includes a static create method that accepts the same arguments as the original CheckMenuItem constructor and returns an instance of the CheckMenuItemBuilder.

You can use method chaining to call the builder methods for configuring the CheckMenuItem. Finally, invoke the build method to generate an instance of the CheckMenuItem class.

Note that intermediate builder methods are not evaluated until the build method is called, meaning they are evaluated lazily.

Author:
Hidekazu Kubota <hidekazu.kubota@gmail.com>

  • Method Details

    • create

      public static CheckMenuItemBuilder create()
      Returns an instance of the CheckMenuItemBuilder.
      Returns:
      an instance of the CheckMenuItemBuilder.

    • create

      public static CheckMenuItemBuilder create(String text)
      Accepts the constructor arguments of CheckMenuItem(String) and returns an instance of CheckMenuItemBuilder.
      Returns:
      an instance of the CheckMenuItemBuilder.

    • create

      public static CheckMenuItemBuilder create(String text, Node graphic)
      Accepts the constructor arguments of CheckMenuItem(String, Node) and returns an instance of CheckMenuItemBuilder.
      Returns:
      an instance of the CheckMenuItemBuilder.

    • build

      public CheckMenuItem build()
      Builds and returns an instance of the CheckMenuItem class.

      Intermediate builder methods are not evaluated until the build method is called; in other words, they are evaluated lazily.

      Returns:
      new instance of the CheckMenuItem class

    • apply

      public CheckMenuItemBuilder apply(Consumer<CheckMenuItem> func)
      Applies a function to the CheckMenuItem instance being constructed. Most operations on the instance can be performed using this method.
      Returns:
      builder instance

    • accelerator

      public CheckMenuItemBuilder accelerator(KeyCombination value)
      A builder method that invokes the setAccelerator method on the instance being constructed.
      Returns:
      builder instance

    • disable

      public CheckMenuItemBuilder disable(boolean value)
      A builder method that invokes the setDisable method on the instance being constructed.
      Returns:
      builder instance

    • graphic

      public CheckMenuItemBuilder graphic(Node value)
      A builder method that invokes the setGraphic method on the instance being constructed.
      Returns:
      builder instance

    • id

      public CheckMenuItemBuilder id(String value)
      A builder method that invokes the setId method on the instance being constructed.
      Returns:
      builder instance

    • mnemonicParsing

      public CheckMenuItemBuilder mnemonicParsing(boolean value)
      A builder method that invokes the setMnemonicParsing method on the instance being constructed.
      Returns:
      builder instance

    • onAction

      public CheckMenuItemBuilder onAction(EventHandler<ActionEvent> value)
      A builder method that invokes the setOnAction method on the instance being constructed.
      Returns:
      builder instance

    • onMenuValidation

      public CheckMenuItemBuilder onMenuValidation(EventHandler<Event> value)
      A builder method that invokes the setOnMenuValidation method on the instance being constructed.
      Returns:
      builder instance

    • selected

      public CheckMenuItemBuilder selected(boolean value)
      A builder method that invokes the setSelected method on the instance being constructed.
      Returns:
      builder instance

    • style

      public CheckMenuItemBuilder style(String value)
      A builder method that invokes the setStyle method on the instance being constructed.
      Returns:
      builder instance

    • text

      public CheckMenuItemBuilder text(String value)
      A builder method that invokes the setText method on the instance being constructed.
      Returns:
      builder instance

    • userData

      public CheckMenuItemBuilder userData(Object value)
      A builder method that invokes the setUserData method on the instance being constructed.
      Returns:
      builder instance

    • visible

      public CheckMenuItemBuilder visible(boolean value)
      A builder method that invokes the setVisible method on the instance being constructed.
      Returns:
      builder instance

    • addStyleClass

      public final CheckMenuItemBuilder addStyleClass(String... elements)
      Calls the addAll method on the ObservableList returned by the CheckMenuItem#getStyleClass() method.
      Returns:
      builder instance

    • addStyleClass

      public final CheckMenuItemBuilder addStyleClass(Collection<? extends String> col)
      Calls the addAll method on the ObservableList returned by the CheckMenuItem#getStyleClass() method.
      Returns:
      builder instance

    • acceleratorPropertyApply

      public CheckMenuItemBuilder acceleratorPropertyApply(Consumer<ObjectProperty<KeyCombination>> op)
      Applies a function to the acceleratorProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

      // Use apply
.apply(obj -> obj.acceleratorProperty().bind(anotherProperty))

// Use shorthand form
.acceleratorPropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance

    • disablePropertyApply

      public CheckMenuItemBuilder disablePropertyApply(Consumer<BooleanProperty> op)
      Applies a function to the disableProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

      // Use apply
.apply(obj -> obj.disableProperty().bind(anotherProperty))

// Use shorthand form
.disablePropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance

    • graphicPropertyApply

      public CheckMenuItemBuilder graphicPropertyApply(Consumer<ObjectProperty<Node>> op)
      Applies a function to the graphicProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

      // Use apply
.apply(obj -> obj.graphicProperty().bind(anotherProperty))

// Use shorthand form
.graphicPropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance

    • idPropertyApply

      public CheckMenuItemBuilder idPropertyApply(Consumer<StringProperty> op)
      Applies a function to the idProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

      // Use apply
.apply(obj -> obj.idProperty().bind(anotherProperty))

// Use shorthand form
.idPropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance

    • mnemonicParsingPropertyApply

      public CheckMenuItemBuilder mnemonicParsingPropertyApply(Consumer<BooleanProperty> op)
      Applies a function to the mnemonicParsingProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

      // Use apply
.apply(obj -> obj.mnemonicParsingProperty().bind(anotherProperty))

// Use shorthand form
.mnemonicParsingPropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance

    • onActionPropertyApply

      public CheckMenuItemBuilder onActionPropertyApply(Consumer<ObjectProperty<EventHandler<ActionEvent>>> op)
      Applies a function to the onActionProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

      // Use apply
.apply(obj -> obj.onActionProperty().bind(anotherProperty))

// Use shorthand form
.onActionPropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance

    • onMenuValidationPropertyApply

      public CheckMenuItemBuilder onMenuValidationPropertyApply(Consumer<ObjectProperty<EventHandler<Event>>> op)
      Applies a function to the onMenuValidationProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

      // Use apply
.apply(obj -> obj.onMenuValidationProperty().bind(anotherProperty))

// Use shorthand form
.onMenuValidationPropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance

    • parentMenuPropertyApply

      public CheckMenuItemBuilder parentMenuPropertyApply(Consumer<ReadOnlyObjectProperty<Menu>> op)
      Applies a function to the parentMenuProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

      // Use apply
.apply(obj -> obj.parentMenuProperty().bind(anotherProperty))

// Use shorthand form
.parentMenuPropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance

    • parentPopupPropertyApply

      public CheckMenuItemBuilder parentPopupPropertyApply(Consumer<ReadOnlyObjectProperty<ContextMenu>> op)
      Applies a function to the parentPopupProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

      // Use apply
.apply(obj -> obj.parentPopupProperty().bind(anotherProperty))

// Use shorthand form
.parentPopupPropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance

    • selectedPropertyApply

      public CheckMenuItemBuilder selectedPropertyApply(Consumer<BooleanProperty> op)
      Applies a function to the selectedProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

      // Use apply
.apply(obj -> obj.selectedProperty().bind(anotherProperty))

// Use shorthand form
.selectedPropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance

    • stylePropertyApply

      public CheckMenuItemBuilder stylePropertyApply(Consumer<StringProperty> op)
      Applies a function to the styleProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

      // Use apply
.apply(obj -> obj.styleProperty().bind(anotherProperty))

// Use shorthand form
.stylePropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance

    • textPropertyApply

      public CheckMenuItemBuilder textPropertyApply(Consumer<StringProperty> op)
      Applies a function to the textProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

      // Use apply
.apply(obj -> obj.textProperty().bind(anotherProperty))

// Use shorthand form
.textPropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance

    • visiblePropertyApply

      public CheckMenuItemBuilder visiblePropertyApply(Consumer<BooleanProperty> op)
      Applies a function to the visibleProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

      // Use apply
.apply(obj -> obj.visibleProperty().bind(anotherProperty))

// Use shorthand form
.visiblePropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance