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; 27 28 import javax.annotation.Nonnull; 29 import java.util.Arrays; 30 import lombok.Getter; 31 import lombok.RequiredArgsConstructor; 32 33 /*************************************************************************************************************************************************************** 34 * 35 * A model for the application menubar. 36 * 37 * @since 1.1-ALPHA-6 38 * @author Fabrizio Giudici 39 * 40 **************************************************************************************************************************************************************/ 41 public interface MenuBarModel 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", -999), 48 EDIT("Edit", 2), 49 SELECT("Select", 3), 50 HELP("Help", 999); 51 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 59 @Nonnull 60 private final String label; 61 private final int index; 62 } 63 64 /*********************************************************************************************************************************************************** 65 * 66 * A role that describes the placement of a menu item. 67 * 68 * @stereotype Role 69 * @since 1.1-ALPHA-6 70 * @author Fabrizio Giudici 71 * 72 **********************************************************************************************************************************************************/ 73 @RequiredArgsConstructor(staticName = "under") @Getter 74 public static class MenuPlacement 75 { 76 public static final Class<MenuPlacement> _MenuItemPlacement_ = MenuPlacement.class; 77 78 @Nonnull 79 private String path; 80 } 81 82 /*********************************************************************************************************************************************************** 83 * Populates the menu bar with menus. 84 * @param binder the binder 85 * @param menuBar the menu bar 86 **********************************************************************************************************************************************************/ 87 public void populate (@Nonnull Object binder, @Nonnull Object menuBar); 88 }