MenuBarControl.java

  1. /*
  2.  * *************************************************************************************************************************************************************
  3.  *
  4.  * SteelBlue: DCI User Interfaces
  5.  * http://tidalwave.it/projects/steelblue
  6.  *
  7.  * Copyright (C) 2015 - 2025 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.ui.core;

  27. import jakarta.annotation.Nonnull;
  28. import java.util.Arrays;
  29. import lombok.Getter;
  30. import lombok.RequiredArgsConstructor;

  31. /***************************************************************************************************************************************************************
  32.  *
  33.  * A model for the application menubar.
  34.  *
  35.  * @param   <B>               the type of the binder
  36.  * @param   <MB>              the type of the menubar
  37.  * @since   1.1-ALPHA-6
  38.  * @author  Fabrizio Giudici
  39.  *
  40.  **************************************************************************************************************************************************************/
  41. public interface MenuBarControl<B, MB>
  42.   {
  43.     /** A class describing the standard sequence of typical main menu bar elements. */
  44.     @RequiredArgsConstructor @Getter
  45.     public enum MenuIndex
  46.       {
  47.         FILE("File", 0),
  48.         EDIT("Edit", 2),
  49.         SELECT("Select", 3),
  50.         VIEW("View", 4),
  51.         HELP("Help", 999);

  52.         /** {@return the position of the menu with the given label}.
  53.          *  @param label  the label */
  54.         public static int findPosition (@Nonnull final String label)
  55.           {
  56.             return Arrays.stream(values()).filter(i -> i.getLabel().equals(label)).findFirst().map(MenuIndex::getIndex).orElse(-1);
  57.           }

  58.         @Nonnull
  59.         private final String label;
  60.         private final int index;
  61.       }

  62.     /***********************************************************************************************************************************************************
  63.      *
  64.      * A role that describes the placement of a menu item.
  65.      *
  66.      * @stereotype  Role
  67.      * @since       1.1-ALPHA-6
  68.      * @author      Fabrizio Giudici
  69.      *
  70.      **********************************************************************************************************************************************************/
  71.     @RequiredArgsConstructor(staticName = "under") @Getter
  72.     public static class MenuPlacement
  73.       {
  74.         /** Shortcut for {@link it.tidalwave.util.As}. */
  75.         public static final Class<MenuPlacement> _MenuItemPlacement_ = MenuPlacement.class;

  76.         @Nonnull
  77.         private String path;
  78.       }

  79.     /***********************************************************************************************************************************************************
  80.      * Populates the menu bar with menus.
  81.      * @param   binder    the binder
  82.      * @param   menuBar   the menu bar
  83.      **********************************************************************************************************************************************************/
  84.     public void populate (@Nonnull B binder, @Nonnull MB menuBar);
  85.   }