1 /**
2 * This file Copyright (c) 2012-2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.ui.api.app.launcherlayout;
35
36 import info.magnolia.ui.api.app.AppDescriptor;
37
38 import java.util.ArrayList;
39 import java.util.List;
40
41 import org.apache.commons.lang3.StringUtils;
42
43 /**
44 * Describes the layout in the app launcher. Provides convenience methods for querying the layout.
45 *
46 * @see AppLauncherGroup
47 * @see AppLauncherGroupEntry
48 * @see AppLauncherLayoutManager
49 * @see AppLauncherLayoutManager#getLayoutForCurrentUser()
50 */
51 public class AppLauncherLayout {
52
53 private List<AppLauncherGroup> groups;
54
55 public List<AppLauncherGroup> getGroups() {
56 if (groups == null) {
57 groups = new ArrayList<AppLauncherGroup>();
58 }
59 return groups;
60 }
61
62 public void setGroups(List<AppLauncherGroup> groups) {
63 this.groups = groups;
64 }
65
66 public void addGroup(AppLauncherGroup group) {
67 getGroups().add(group);
68 }
69
70 public boolean containsApp(String name) {
71 return getAppGroupEntry(name) != null;
72 }
73
74 public AppLauncherGroup getGroup(String name) {
75 for (AppLauncherGroup group : getGroups()) {
76 if (StringUtils.equals(group.getName(), name)) {
77 return group;
78 }
79 }
80 return null;
81 }
82
83 public AppLauncherGroupEntry getAppGroupEntry(String name) {
84 for (AppLauncherGroup group : getGroups()) {
85 for (AppLauncherGroupEntry entry : group.getApps()) {
86 if (StringUtils.equals(entry.getName(), name)) {
87 return entry;
88 }
89 }
90 }
91 return null;
92 }
93
94 public AppDescriptor getAppDescriptor(String name) {
95 AppLauncherGroupEntry entry = getAppGroupEntry(name);
96 return entry != null ? entry.getAppDescriptor() : null;
97 }
98 }