Skip to content

Package: MenuBarControl$MenuPlacement

MenuBarControl$MenuPlacement

nameinstructionbranchcomplexitylinemethod
static {...}
M: 0 C: 3
100%
M: 0 C: 0
100%
M: 0 C: 1
100%
M: 0 C: 1
100%
M: 0 C: 1
100%

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: VIEW("View", 4),
53: HELP("Help", 999);
54:
55: /** {@return the position of the menu with the given label}.
56: * @param label the label */
57: public static int findPosition (@Nonnull final String label)
58: {
59: return Arrays.stream(values()).filter(i -> i.getLabel().equals(label)).findFirst().map(MenuIndex::getIndex).orElse(-1);
60: }
61:
62: @Nonnull
63: private final String label;
64: private final int index;
65: }
66:
67: /***********************************************************************************************************************************************************
68: *
69: * A role that describes the placement of a menu item.
70: *
71: * @stereotype Role
72: * @since 1.1-ALPHA-6
73: * @author Fabrizio Giudici
74: *
75: **********************************************************************************************************************************************************/
76: @RequiredArgsConstructor(staticName = "under") @Getter
77: public static class MenuPlacement
78: {
79: public static final Class<MenuPlacement> _MenuItemPlacement_ = MenuPlacement.class;
80:
81: @Nonnull
82: private String path;
83: }
84:
85: /***********************************************************************************************************************************************************
86: * Populates the menu bar with menus.
87: * @param binder the binder
88: * @param menuBar the menu bar
89: **********************************************************************************************************************************************************/
90: public void populate (@Nonnull B binder, @Nonnull MB menuBar);
91: }