ToolBarModelSupport.java

  1. /*
  2.  * *************************************************************************************************************************************************************
  3.  *
  4.  * SteelBlue: DCI User Interfaces
  5.  * http://tidalwave.it/projects/steelblue
  6.  *
  7.  * Copyright (C) 2015 - 2024 by Tidalwave s.a.s. (http://tidalwave.it)
  8.  *
  9.  * *************************************************************************************************************************************************************
  10.  *
  11.  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
  12.  * You may obtain a copy of the License at
  13.  *
  14.  *     http://www.apache.org/licenses/LICENSE-2.0
  15.  *
  16.  * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
  17.  * CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and limitations under the License.
  18.  *
  19.  * *************************************************************************************************************************************************************
  20.  *
  21.  * git clone https://bitbucket.org/tidalwave/steelblue-src
  22.  * git clone https://github.com/tidalwave-it/steelblue-src
  23.  *
  24.  * *************************************************************************************************************************************************************
  25.  */
  26. package it.tidalwave.role.ui.spi;

  27. import javax.annotation.Nonnull;
  28. import java.util.Collection;
  29. import java.util.function.Supplier;
  30. import it.tidalwave.util.As;
  31. import it.tidalwave.role.ui.ToolBarModel;
  32. import it.tidalwave.role.ui.UserAction;
  33. import it.tidalwave.role.ui.UserActionProvider;
  34. import lombok.AccessLevel;
  35. import lombok.RequiredArgsConstructor;
  36. import lombok.experimental.Delegate;
  37. import static java.util.Collections.emptyList;
  38. import static it.tidalwave.role.ui.UserActionProvider._UserActionProvider_;

  39. /***************************************************************************************************************************************************************
  40.  *
  41.  * A support implementation for {@link ToolBarModel}.
  42.  *
  43.  * @param   <B>               the concrete type of the binder
  44.  * @param   <T>               the concrete type of the toolbar
  45.  * @since   1.1-ALPHA-6
  46.  * @author  Fabrizio Giudici
  47.  *
  48.  **************************************************************************************************************************************************************/
  49. @RequiredArgsConstructor(access = AccessLevel.PROTECTED)
  50. public abstract class ToolBarModelSupport<B, T> implements ToolBarModel
  51.   {
  52.     @Delegate
  53.     private final As as = As.forObject(this);

  54.     /** The default supplier of {@link UserAction}s, can be injected for testing. */
  55.     @Nonnull
  56.     protected final Supplier<Collection<? extends UserAction>> userActionsSupplier;

  57.     /***********************************************************************************************************************************************************
  58.      * Default constructor.
  59.      **********************************************************************************************************************************************************/
  60.     protected ToolBarModelSupport()
  61.       {
  62.         userActionsSupplier = () -> maybeAs(_UserActionProvider_).map(UserActionProvider::getActions).orElse(emptyList());
  63.       }

  64.     /***********************************************************************************************************************************************************
  65.      * {@inheritDoc}
  66.      **********************************************************************************************************************************************************/
  67.     @SuppressWarnings("unchecked")
  68.     public final void populate (@Nonnull final Object binder, @Nonnull final Object toolBar)
  69.       {
  70.         populateImpl((B)binder, (T)toolBar);
  71.       }

  72.     /***********************************************************************************************************************************************************
  73.      * Populates the menu bar with menus.
  74.      * @param   binder    the binder
  75.      * @param   toolBar   the toolbar
  76.      **********************************************************************************************************************************************************/
  77.     protected abstract void populateImpl (@Nonnull B binder, @Nonnull T toolBar);
  78.   }