Package: MenuBarControl

MenuBarControl

Coverage

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:
28: import jakarta.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: * @param <B> the type of the binder
38: * @param <MB> the type of the menubar
39: * @since 1.1-ALPHA-6
40: * @author Fabrizio Giudici
41: *
42: **************************************************************************************************************************************************************/
43: public interface MenuBarControl<B, MB>
44: {
45: /** A class describing the standard sequence of typical main menu bar elements. */
46: @RequiredArgsConstructor @Getter
47: public enum MenuIndex
48: {
49: FILE("File", 0),
50: EDIT("Edit", 2),
51: SELECT("Select", 3),
52: HELP("Help", 999);
53:
54: /** {@return the position of the menu with the given label}.
55: * @param label the label */
56: public static int findPosition (@Nonnull final String label)
57: {
58: return Arrays.stream(values()).filter(i -> i.getLabel().equals(label)).findFirst().map(MenuIndex::getIndex).orElse(-1);
59: }
60:
61: @Nonnull
62: private final String label;
63: private final int index;
64: }
65:
66: /***********************************************************************************************************************************************************
67: *
68: * A role that describes the placement of a menu item.
69: *
70: * @stereotype Role
71: * @since 1.1-ALPHA-6
72: * @author Fabrizio Giudici
73: *
74: **********************************************************************************************************************************************************/
75: @RequiredArgsConstructor(staticName = "under") @Getter
76: public static class MenuPlacement
77: {
78: public static final Class<MenuPlacement> _MenuItemPlacement_ = MenuPlacement.class;
79:
80: @Nonnull
81: private String path;
82: }
83:
84: /***********************************************************************************************************************************************************
85: * Populates the menu bar with menus.
86: * @param binder the binder
87: * @param menuBar the menu bar
88: **********************************************************************************************************************************************************/
89: public void populate (@Nonnull B binder, @Nonnull MB menuBar);
90: }