src/main/java/de/uapcore/lightpit/MenuEntry.java

Sat, 23 May 2020 13:24:49 +0200

author
Mike Becker <universe@uap-core.de>
date
Sat, 23 May 2020 13:24:49 +0200
changeset 76
82f71fb1758a
parent 71
dca186d3911f
child 79
f64255a88d66
permissions
-rw-r--r--

issue and version form now also work if no project is selected in the session

10
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1 /*
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
34
824d4042c857 cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents: 29
diff changeset
3 *
24
8137ec335416 updates copyright header
Mike Becker <universe@uap-core.de>
parents: 11
diff changeset
4 * Copyright 2018 Mike Becker. All rights reserved.
34
824d4042c857 cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents: 29
diff changeset
5 *
10
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
6 * Redistribution and use in source and binary forms, with or without
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
7 * modification, are permitted provided that the following conditions are met:
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
8 *
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
9 * 1. Redistributions of source code must retain the above copyright
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
10 * notice, this list of conditions and the following disclaimer.
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
11 *
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
12 * 2. Redistributions in binary form must reproduce the above copyright
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
13 * notice, this list of conditions and the following disclaimer in the
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
14 * documentation and/or other materials provided with the distribution.
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
15 *
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
26 * POSSIBILITY OF SUCH DAMAGE.
34
824d4042c857 cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents: 29
diff changeset
27 *
10
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
28 */
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
29 package de.uapcore.lightpit;
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
30
36
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
31 import java.util.Objects;
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
32
10
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
33 /**
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
34 * Maps a resource key for the menu label to the path name for the underlying
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
35 * site.
34
824d4042c857 cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents: 29
diff changeset
36 * <p>
10
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
37 * Objects of this class are internally instantiated by the
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
38 * {@link ModuleManager}.
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
39 */
36
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
40 public class MenuEntry implements Comparable<MenuEntry> {
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
41
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
42 /**
11
737ab27e37b3 implements simple request mapper
Mike Becker <universe@uap-core.de>
parents: 10
diff changeset
43 * Resource key for the menu label.
737ab27e37b3 implements simple request mapper
Mike Becker <universe@uap-core.de>
parents: 10
diff changeset
44 */
36
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
45 private final ResourceKey resourceKey;
34
824d4042c857 cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents: 29
diff changeset
46
11
737ab27e37b3 implements simple request mapper
Mike Becker <universe@uap-core.de>
parents: 10
diff changeset
47 /**
71
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
48 * Custom menu text.
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
49 */
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
50 private final String text;
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
51
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
52 /**
11
737ab27e37b3 implements simple request mapper
Mike Becker <universe@uap-core.de>
parents: 10
diff changeset
53 * Path name of the module, linked by this menu entry.
737ab27e37b3 implements simple request mapper
Mike Becker <universe@uap-core.de>
parents: 10
diff changeset
54 */
36
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
55 private final String pathName;
10
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
56
36
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
57 /**
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
58 * Sequence number to determine the ordering of the menu.
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
59 */
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
60 private final int sequence;
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
61
71
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
62 /**
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
63 * True if this menu entry is active.
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
64 */
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
65 private boolean active = false;
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
66
45
cc7f082c5ef3 simplifies menu generation, adds submenus and removes VersionsModule (versions will be part of the ProjectsModule)
Mike Becker <universe@uap-core.de>
parents: 36
diff changeset
67 public MenuEntry(ResourceKey resourceKey, String pathName, int sequence) {
71
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
68 this.text = null;
36
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
69 this.resourceKey = resourceKey;
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
70 this.pathName = pathName;
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
71 this.sequence = sequence;
10
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
72 }
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
73
71
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
74 public MenuEntry(String text, String pathName, int sequence) {
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
75 this.text = text;
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
76 this.resourceKey = null;
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
77 this.pathName = pathName;
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
78 this.sequence = sequence;
70
821c4950b619 removes the sub menu and removes the home module
Mike Becker <universe@uap-core.de>
parents: 45
diff changeset
79 }
821c4950b619 removes the sub menu and removes the home module
Mike Becker <universe@uap-core.de>
parents: 45
diff changeset
80
10
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
81 public ResourceKey getResourceKey() {
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
82 return resourceKey;
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
83 }
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
84
71
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
85 public String getText() {
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
86 return text;
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
87 }
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
88
10
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
89 public String getPathName() {
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
90 return pathName;
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
91 }
34
824d4042c857 cleanup and simplification of database access layer
Mike Becker <universe@uap-core.de>
parents: 29
diff changeset
92
36
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
93 public int getSequence() {
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
94 return sequence;
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
95 }
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
96
71
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
97 public boolean isActive() {
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
98 return this.active;
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
99 }
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
100
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
101 public void setActive(boolean active) {
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
102 this.active = true;
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
103 }
dca186d3911f adds breadcrumb menu
Mike Becker <universe@uap-core.de>
parents: 70
diff changeset
104
36
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
105 @Override
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
106 public boolean equals(Object o) {
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
107 if (this == o) return true;
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
108 if (o == null || getClass() != o.getClass()) return false;
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
109 MenuEntry menuEntry = (MenuEntry) o;
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
110 return resourceKey.equals(menuEntry.resourceKey) &&
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
111 pathName.equals(menuEntry.pathName);
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
112 }
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
113
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
114 @Override
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
115 public int hashCode() {
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
116 return Objects.hash(resourceKey, pathName);
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
117 }
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
118
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
119 @Override
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
120 public int compareTo(MenuEntry menuEntry) {
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
121 return Integer.compare(this.sequence, menuEntry.sequence);
0f4f8f255c32 removes features that are not (and probably will not) used anyway
Mike Becker <universe@uap-core.de>
parents: 34
diff changeset
122 }
10
89e3e6e28b69 implements automatic menu generation from module information
Mike Becker <universe@uap-core.de>
parents:
diff changeset
123 }

mercurial