Package swingtree

Class UIForAnyTextComponent<I,C extends JTextComponent>

java.lang.Object
swingtree.UIForAnySwing<I,C>
swingtree.UIForAnyTextComponent<I,C>
Direct Known Subclasses:
UIForAnyEditorPane, UIForFormattedTextField, UIForPasswordField, UIForTextArea, UIForTextField
public abstract class UIForAnyTextComponent<I,C extends JTextComponent> extends UIForAnySwing<I,C>
A SwingTree builder node designed for configuring various kinds of JTextComponent instances in a fluent and declarative way. It also allows for the binding of text properties to the text component so that the text of the text component is dynamically updated whenever the value of the property changes and conversely, the value of the property is dynamically updated whenever the text of the text component changes.

Please take a look at the living swing-tree documentation where you can browse a large collection of examples demonstrating how to use the API of this class.

  • Constructor Details

    • UIForAnyTextComponent

      public UIForAnyTextComponent()

  • Method Details

    • withText

      public final I withText(String text)
      Sets the text of the wrapped TextComponent to the specified text. If the text is null an exception is thrown. Please use an empty string instead of null! When text has been inserted, the resulting caret location is determined by the implementation of the caret class.

      Note that text is not a bound property, so no PropertyChangeEvent is fired when it changes. To listen for changes to the text, register action lambdas through onTextChange(Action) or use DocumentListener directly.

      Parameters:
      text - The new text to be set for the wrapped text component type.
      Returns:
      This very builder to allow for method chaining.

    • withText

      public final I withText(sprouts.Val<String> text)
      Binds the text of the wrapped TextComponent to the specified Val property instance so that the text of the wrapped text component is dynamically updated whenever the value of the property changes.

      Note that the text of the wrapped text component is only updated if the new value is different from the old value. This is to avoid infinite feedback loops.

      Parameters:
      text - The property instance to bind the text of the wrapped text component to.
      Returns:
      This very builder to allow for method chaining.
      Throws:
      IllegalArgumentException - if the specified property is null.
      IllegalArgumentException - if the specified property allows null values.

    • withText

      public final I withText(sprouts.Var<String> text)
      Binds the text of the wrapped TextComponent to the specified Val property instance so that the text of the wrapped text component is dynamically updated whenever the value of the property changes.

      This method is the same as withText(Val) except that the Var property is used instead of the Val property which allows for the text of the wrapped text component to be changed by the user.

      Parameters:
      text - The property instance to bind the text of the wrapped text component to.
      Returns:
      This very builder to allow for method chaining.
      Throws:
      IllegalArgumentException - if the specified property is null.
      IllegalArgumentException - if the specified property allows null values.

    • _setTextSilently

      protected final void _setTextSilently(C thisComponent, String text)

    • withFont

      public final I withFont(Font font)
      Use this to set the font of the wrapped JTextComponent.
      Parameters:
      font - The font of the text which should be displayed on the text component.
      Returns:
      This builder instance, to allow for method chaining.
      Throws:
      IllegalArgumentException - if font is null.

    • withFont

      public final I withFont(sprouts.Val<Font> font)
      Use this to dynamically set the font of the wrapped JTextComponent through the provided view model property. When the font wrapped by the provided property changes, then so does the font of this text component.
      Parameters:
      font - The font property of the text which should be displayed on the text component.
      Returns:
      This builder instance, to allow for method chaining.
      Throws:
      IllegalArgumentException - if font is null.
      IllegalArgumentException - if font is a property which can wrap null.

    • isEditableIf

      public final I isEditableIf(boolean isEditable)
      Use this to modify the components' modifiability.
      Parameters:
      isEditable - The flag determining if the underlying JTextComponent should be editable or not.
      Returns:
      This very builder to allow for method chaining.

    • onContentChange

      public final I onContentChange(sprouts.Action<ComponentDelegate<JTextComponent,DocumentEvent>> action)
      Use this to register any change in the contents of the text component including both the displayed text and its attributes.
      Parameters:
      action - An action which will be executed when the text or its attributes in the underlying JTextComponent changes.
      Returns:
      This very builder to allow for method chaining.

    • onTextChange

      public final I onTextChange(sprouts.Action<ComponentDelegate<JTextComponent,DocumentEvent>> action)
      Use this to register if the text in this text component changes. This does not include style attributes like font size.
      Parameters:
      action - An action which will be executed when the text string in the underlying JTextComponent changes.
      Returns:
      This very builder to allow for method chaining.

    • _onTextChange

      protected final void _onTextChange(C thisComponent, Consumer<DocumentEvent> action)

    • onTextRemove

      public final I onTextRemove(sprouts.Action<TextRemoveDelegate> action)
      Allows you to register a user action listener which will be called whenever parts (or all) of the text in the underlying text component gets removed. This event is based on the DocumentFilter.remove(DocumentFilter.FilterBypass, int, int) method of the underlying AbstractDocument.
      Parameters:
      action - A Action lambda which will be called when parts (or all) of the text in the underlying text component gets removed.
      Returns:
      This very builder to allow for method chaining.

    • onTextInsert

      public final I onTextInsert(sprouts.Action<TextInsertDelegate> action)
      Allows you to register a user action listener which will be called whenever new text gets inserted into the underlying text component. This event is based on the DocumentFilter.insertString(DocumentFilter.FilterBypass, int, String, AttributeSet) method of the underlying AbstractDocument. Use the TextInsertDelegate that is supplied to your action to get access to the underlying text component and the text insertion details.
      Parameters:
      action - A Action lambda which will be called when new text gets inserted into the underlying text component.
      Returns:
      This very builder to allow for method chaining.

    • onTextReplace

      public final I onTextReplace(sprouts.Action<TextReplaceDelegate> action)
      This method allows you to register a user action which will be called whenever the text in the underlying text component gets replaced. This event is based on the DocumentFilter.replace(DocumentFilter.FilterBypass, int, int, String, AttributeSet) method of the underlying AbstractDocument. Use the TextReplaceDelegate that is supplied to your action to get access to the underlying text component and the text replacement details.
      Parameters:
      action - A Action lambda which will be called when the text in the underlying text component gets replaced.
      Returns:
      This very builder to allow for method chaining.

    • getType

      public final Class<C> getType()
      The type class of the component managed by this builder. See documentation for method "build" for more information.
      Returns:
      The type class of the component managed by this builder.

    • getComponent

      @Deprecated public final C getComponent()
      Deprecated.
      Use get(Class) instead.
      The component managed by this builder.
      Returns:
      The component managed by this builder.
      Throws:
      IllegalStateException - if this method is called from a thread other than the EDT and this UI is configured to be decoupled from the application thread. See UIFactoryMethods.use(EventProcessor, Supplier).

    • component

      @Deprecated public final OptionalUI<C> component()
      Deprecated.
      Use get(Class) instead.
      The optional component managed by this builder.
      Returns:
      An OptionalUI wrapping a component or null. This optional will throw an exception if the application has an application thread (see UIFactoryMethods.use(EventProcessor, Supplier)) and this method is called from a thread other than the EDT.

    • peek

      public final I peek(Peeker<C> action)
      Use this if you wish to access the component wrapped by this builder directly. This is useful for more fine-grained control, like for example calling methods like "setName", "setTitle", and so on...
      This method accepts a lambda to which the component wrapped by this builder will be supplied. The lambda can then call said methods or perform other tasks which might be relevant to the component while also not breaking the benefits of nesting and method chaining provided by this class...
      The below example shows how this method allows for more fine-grained control over the wrapped component: 
      
      UI.panel()
      peek( panel -> panel.setDebugGraphicsOptions(true) );


      Parameters:
      action - A Consumer lambda which simply returned the wrapped JComponent type for interacting it.
      Returns:
      This very instance, which enables builder-style method chaining.

    • applyIf

      public final I applyIf(boolean condition, Consumer<I> building)
      Use this to only build a certain part of the UI if the provided boolean condition is true. Which is to say, if the condition is false, then the second lambda is ignored, if on the other hand the condition is true, then the second lambda is executed with the current builder instance passed to it as a parameter. Inside the lambda, one can then continue building the UI while also not breaking the benefits of nesting and method chaining provided by this builder...

      This is in essence a more advanced version of apply(Consumer).
      Here a simple usage example: 

      
    UI.panel()
    .applyIf( userIsLoggedIn, ui -> ui
      .add( UI.label("Welcome back!") )
      .add( UI.button("Logout")).onClick( () -> logout() )
      .add( UI.button("Settings")).onClick( () -> showSettings() )
    )
    .applyIf( !userIsLoggedIn, ui -> ui
      .add( UI.label("Please login to continue.") )
      .add( UI.button("Login")).onClick( () -> login() );
    );
      Here we use theis method to build a panel with different content depending on whether the user is logged in or not.

      Parameters:
      condition - The truth value which determines if the second consumer lambda is executed or not.
      building - A Consumer lambda which simply consumes this builder instance.
      Returns:
      This very instance, which enables builder-style method chaining.

    • applyIfPresent

      public final I applyIfPresent(Optional<Consumer<I>> building)
      Allows you to build declarative UI conditionally, meaning that the UI is only built if the provided Optional value is present. If the value is not present, meaning it is null, then the second lambda (containing UI declarations relevant to the value) is simply ignored.

      Consider the following example: 

      
 // In your view model:
 public Optional<MySubModel> getM() {
   return Optional.ofNullable(this.model);
 }

 // In your view:
 UI.panel()
 .add(UI.label("Maybe Sub Model:"))
 .applyIfPresent(vm.getM().map(m->ui->ui
   .add(UI.label("Hello Sub Model!"))
   .add(UI.label("A:")
   .add(UI.textField(m.getA()))
   .add(UI.label("B:"))
   .add(UI.textField(m.getB()))
   // ...
 ))
 .add(UI.label("Some other stuff..."));
      The applyIfPresent method takes an Optional<Consumer<I>> as parameter, where I is the type of the UI builder. This allows you to map the optional value to a consumer which is only executed if the value is present. If the optional value is present, the consumer is executed with the current UI builder as a parameter, which allows you to continue building the UI as usual.
      The m->ui->ui may look a bit confusing at first, but it is simply a lambda expression which takes the optional value and returns a consumer (ui->ui... ) which takes the UI builder as a parameter.
      This is in essence a more advanced Optional centric version of applyIf(boolean, Consumer) and apply(Consumer).
      Parameters:
      building - An optional consumer lambda which simply consumes this builder node.
      Returns:
      This very instance, which enables builder-style method chaining.

    • apply

      public final I apply(Consumer<I> building)
      Use this to continue building UI inside a provided lambda if you need to introduce some imperative code in between the building process.
      This is especially useful for when you need to build UI based on loops. The current builder instance will simply be supplied to the provided Consumer lambda. Inside the supplied lambda, you can then continue building the UI while also not breaking the benefits of nesting and method chaining, effectively preserving the declarative nature of the builder.

      Here is a simple example of how this method can be used to build a panel with a variable amount of images displayed in a grid: 
      
      UI.panel("wrap 3")
      .apply( ui -> {
          for ( String path : imagePaths )
              ui.add( UI.label(UI.icon(path)) );
      });


      Here is another example of how this method can be used to build a panel with a variable amount of buttons displayed in a grid: 
      
    UI.panel("wrap 4")
    .apply( ui -> {
      for ( int i = 0; i < numOfButtons; i++ )
          ui.add( UI.button("Button " + i)
          .onClick( () -> {...} );
    });


      Parameters:
      building - A Consumer lambda which simply consumes this builder instance.
      Returns:
      This very instance, which enables builder-style method chaining.

    • get

      public final C get(Class<C> type)
      This method completes the building process for the wrapped JComponent type by returning it. However, it also expects the user to pass the class of the JComponent wrapped by this builder! This is not out of necessity but for better readability when using the builder in more extensive ways where the beginning and end of the method chaining and nesting of the builder does not fit on one screen.
      In such cases the expression ".get(MyJComponent.class)" helps to identify which type of JComponent is currently being built on a given nesting layer...

      Here is a simple example that demonstrates this technique using a JPanel and a JMenuBar: 
      
      UI.panel()
      .add(
          UI.menuBar()
          .add( UI.menu("File") )
          .add( UI.menuItem("Open") )
          .add( UI.menuItem("Save") )
          // ...
          .add( UI.menuItem("Exit") )
          .get(JMenuBar.class)
      )
      .add( UI.button("Click me!") )
      .get(JPanel.class);
      As you can see, the expression ".get(JMenuBar.class)" as well as the expression ".get(JPanel.class)" at the end of the builder chain help to identify which type of JComponent is currently being built and returned.
      Parameters:
      type - The type class of the component which this builder wraps.
      Returns:
      The result of the building process, namely: a type of JComponent.

    • add

      @SafeVarargs public final I add(JComponent... components)
      This builder class expects its implementations to be builder types for anything which can be built in a nested tree-like structure. Implementations of this abstract method ought to enable support for nested building.

      Parameters:
      components - An array of component instances which ought to be added to the wrapped component type.
      Returns:
      This very instance, which enables builder-style method chaining.

    • add

      public final <T extends JComponent> I add(UIForAnySwing<?,T> builder)
      Uses the supplied builder to build its component and then add it to the component that is being built by this builder instance. This directly allows you to nest your builder based UI declarations in an HTML-like fashion.
      Type Parameters:
      T - The type of the JComponent which is wrapped by the provided builder.
      Parameters:
      builder - A builder for another JComponent instance which ought to be added to the wrapped component type.
      Returns:
      This very instance, which enables builder-style method chaining.

    • add

      @SafeVarargs public final <B extends swingtree.UIForAnything<?, ?, JComponent>> I add(B... builders)
      This method provides the same functionality as the other "add" methods. However, it bypasses the necessity to call the "get" method by calling it internally for you.
      This helps to improve readability, especially when the degree of nesting is very low.
      Type Parameters:
      B - The type of the builder instances which are used to configure the components that will be added to the component wrapped by this builder.
      Parameters:
      builders - An array of builder instances whose JComponents ought to be added to the one wrapped by this builder.
      Returns:
      This very instance, which enables builder-style method chaining.

    • add

      public final I add(List<JComponent> components)
      This builder class expects its implementations to be builder types for anything which can be built in a nested tree-like structure. Implementations of this abstract method ought to enable support for nested building.

      Parameters:
      components - A list of component instances which ought to be added to the wrapped component type.
      Returns:
      This very instance, which enables builder-style method chaining.

    • _addBuildersTo

      @SafeVarargs protected final <B extends swingtree.UIForAnything<?, ?, JComponent>> void _addBuildersTo(C thisComponent, B... builders)

    • _addComponentsTo

      @SafeVarargs protected final void _addComponentsTo(C thisComponent, JComponent... componentsToBeAdded)

    • _addBuilderTo

      protected final void _addBuilderTo(C thisComponent, swingtree.UIForAnything<?,?,?> builder, @Nullable Object conf)

    • _state

      protected abstract swingtree.BuilderState<C> _state()
      Returns the state of the builder, which is a container for the wrapped component as well as it's type and current EventProcessor.
      Returns:
      The state of the builder.

    • _newBuilderWithState

      protected abstract swingtree.UIForAnything<I,C,JComponent> _newBuilderWithState(swingtree.BuilderState<C> newState)
      An internal wither method which creates a new builder instance with the provided BuilderState stored inside it.
      Parameters:
      newState - The new state which should be stored inside the new builder instance.
      Returns:
      A new builder instance with the provided state stored inside it.

    • _with

      protected final swingtree.UIForAnything<I,C,JComponent> _with(Consumer<C> componentMutator)
      Creates a new builder with the provided component mutation applied to the wrapped component.
      Note that the SwingTree builders are immutable, which means that this method does not mutate the current builder instance, but instead creates a new builder instance with a new BuilderState which contains the provided component mutation (see BuilderState.withMutator(Consumer)). Also see _newBuilderWithState(BuilderState).
      Parameters:
      componentMutator - A consumer lambda which receives the wrapped component and is then used to apply some builder action to it.
      Returns:
      A new builder instance with the provided component mutation applied to the wrapped component.

    • _runInUI

      protected final void _runInUI(Runnable action)
      A convenient shortcut to the EventProcessor.registerUIEvent(Runnable) method to the current EventProcessor attached to the current BuilderState. In practice, this method will ultimately just delegate tasks to the AWT Event Dispatch Thread (EDT).
      Parameters:
      action - An action which should be executed by the UI thread, which is determined by implementations of the EventProcessor, also see UIFactoryMethods.use(EventProcessor, Supplier).
      Usually the UI thread is AWT's Event Dispatch Thread (EDT).

    • _runInApp

      protected final void _runInApp(Runnable action)
      A convenient delegate to the EventProcessor.registerAppEvent(Runnable) method, which allows you to execute an action on the current application thread. To configure the current EventProcessor see UIFactoryMethods.use(EventProcessor, Supplier) or the underlying SwingTree.setEventProcessor(EventProcessor) method.
      Parameters:
      action - An action which should be executed by the application thread, which is determined by implementations of the current EventProcessor, also see UIFactoryMethods.use(EventProcessor, Supplier).

    • _runInApp

      protected final <T> void _runInApp(T value, Consumer<T> action)
      A convenient delegate to the EventProcessor.registerAppEvent(Runnable) method, which allows you to execute an action on the current application thread. Which thread executes these tasks is determined by the current EventProcessor. Usually this is the EventProcessor.COUPLED or EventProcessor.COUPLED_STRICT event processor.
      Type Parameters:
      T - The type of the value.
      Parameters:
      value - A value which should be captured and then passed to the provided action on the current application thread (see EventProcessor and UIFactoryMethods.use(EventProcessor, Supplier)).
      action - A consumer lambda which is executed by the application thread and receives the provided value.

    • _onShow

      protected final <T> void _onShow(sprouts.Val<T> val, C thisComponent, BiConsumer<C,T> displayAction)
      Use this to register a state change listener for the provided property which will be executed by the UI thread (see EventProcessor).
      Type Parameters:
      T - The type of the item wrapped by the provided property.
      Parameters:
      val - A property whose state changes should be listened to on the UI thread.
      thisComponent - The component which is wrapped by this builder.
      displayAction - A consumer lambda receiving the provided value and is then executed by the UI thread.

    • _withOnShow

      protected final <T> swingtree.UIForAnything<I,C,JComponent> _withOnShow(sprouts.Val<T> val, BiConsumer<C,T> displayAction)

    • _onShow

      protected final <T> void _onShow(sprouts.Vals<T> vals, C c, BiConsumer<C,sprouts.ValsDelegate<T>> displayAction)
      Use this to register a state change listener for the provided property list which will be executed by the UI thread (see EventProcessor).
      Type Parameters:
      T - The type of the items wrapped by the provided property list.
      Parameters:
      vals - A property list whose state changes should be listened to on the UI thread.
      c - The component which is wrapped by this builder.
      displayAction - A consumer lambda receiving the action delegate and is then executed by the UI thread.

    • _withOnShow

      protected final <T> swingtree.UIForAnything<I,C,JComponent> _withOnShow(sprouts.Vals<T> vals, BiConsumer<C,sprouts.ValsDelegate<T>> displayAction)

    • _this

      protected final I _this()
      Exposes the this-pointer of the builder instance cast to the I type parameter of the builder class.
      This is done to reduce the amount of type casting and warnings in the codebase.
      Returns:
      The builder instance itself based on the type parameter <I>.

    • _disposeState

      protected final void _disposeState()
      This method is used to dispose of the state of the builder, which means that the builder state disposes of its reference to either the wrapped component or the wrapped component or the composite of component factories which are used to build the wrapped component eagerly each time the wrapped component is accessed.
      This is important to avoid memory leaks, as a component is typically part of a tree of components, and if one component is not garbage collected, then the whole tree is not garbage collected.

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public final String toString()
      Overrides:
      toString in class Object