PopupManager

git-svn-id: http://svn.dmdirc.com/trunk@2388 00569f92-eb28-0410-84fd-f71c24880f

src/com/dmdirc/commandparser/PopupManager.java

@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.commandparser;
+
+import com.dmdirc.config.ConfigManager;
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * The popup manager manages which commands should be present in popup menus.
+ *
+ * @author Chris
+ */
+public class PopupManager {
+    
+    /**
+     * Creates a new instance of PopupManager.
+     */
+    private PopupManager() {
+        // Shouldn't be instansiated.
+    }
+    
+    /**
+     * Retrieves a map of the menu items that should be in a certain menu type.
+     *
+     * @param menuType The type of menu that is being built
+     * @param configManager The config manager for the current context
+     * @return A map of "friendly names" to commands (without command characters)
+     */
+    public static Map<String, String> getMenuItems(final PopupType menuType,
+            final ConfigManager configManager) {
+        final Map<String, String> res = new HashMap<String, String>();
+        
+        for (String domain : menuType.getDomains()) {
+            for (String option : configManager.getOptions(domain)) {
+                final String command = configManager.getOption(domain, option);
+                if (!command.isEmpty()) {
+                    res.put(option, command);
+                }
+            }
+        }
+        
+        return res;
+    }
+    
+}

src/com/dmdirc/commandparser/PopupType.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.commandparser;
+
+/**
+ * An enumeration of the types of popup menu which are supported by the
+ * PopupManager.
+ * 
+ * @author chris
+ */
+public enum PopupType {
+    
+    /** The menu that appears when right clicking in a channel's nicklist. */
+    CHAN_NICKLIST("chan-nick-list", "chan-nick", "nick"),
+    /** The menu that appears when right clicking on a nickname in normal channel text. */
+    CHAN_NICKTEXT("chan-nick-text", "chan-nick", "nick", "chan"),
+    /** The menu that appears when right clicking in a channel window. */
+    CHAN_CHAN("chan"),
+    /** The menu that appears when right clicking in a query window. */
+    QUERY_QUERY("query", "nick");
+    
+    private final String[] domains;
+    
+    /**
+     * Instansiates one of the PopupTypes.
+     * 
+     * @param domains The configuration domains used for the type
+     */
+    PopupType(final String ... domains) {
+        this.domains = domains;
+    }
+    
+    /**
+     * Retrieve a list of the domains that should be used by this type.
+     * 
+     * @return This type's domains
+     */
+    public String[] getDomains() {
+        return domains.clone();
+    }
+    
+}