123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226 |
- /*
- * Copyright (c) 2006-2014 DMDirc Developers
- *
- * 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.addons.osd;
-
- import com.dmdirc.addons.ui_swing.SwingController;
- import com.dmdirc.config.prefs.CategoryChangeListener;
- import com.dmdirc.config.prefs.PluginPreferencesCategory;
- import com.dmdirc.config.prefs.PreferencesCategory;
- import com.dmdirc.config.prefs.PreferencesDialogModel;
- import com.dmdirc.config.prefs.PreferencesInterface;
- import com.dmdirc.config.prefs.PreferencesSetting;
- import com.dmdirc.config.prefs.PreferencesType;
- import com.dmdirc.config.prefs.SettingChangeListener;
- import com.dmdirc.interfaces.CommandController;
- import com.dmdirc.interfaces.config.IdentityController;
- import com.dmdirc.plugins.Exported;
- import com.dmdirc.plugins.PluginInfo;
- import com.dmdirc.plugins.implementations.BaseCommandPlugin;
- import com.dmdirc.ui.messages.ColourManager;
- import com.dmdirc.util.validators.NumericalValidator;
- import com.dmdirc.util.validators.OptionalValidator;
-
- import java.awt.Frame;
- import java.util.HashMap;
- import java.util.Map;
-
- /**
- * Allows the user to display on-screen-display messages.
- */
- public class OsdPlugin extends BaseCommandPlugin implements
- CategoryChangeListener, PreferencesInterface, SettingChangeListener {
-
- /** Config OSD Window. */
- private OsdWindow osdWindow;
- /** The OSD Manager that this plugin is using. */
- private final OsdManager osdManager;
- /** X-axis position of OSD. */
- private int x;
- /** Y-axis potion of OSD. */
- private int y;
- /** Setting objects with registered change listeners. */
- private PreferencesSetting fontSizeSetting;
- private PreferencesSetting backgroundSetting;
- private PreferencesSetting foregroundSetting;
- private PreferencesSetting widthSetting;
- private PreferencesSetting timeoutSetting;
- private PreferencesSetting maxWindowsSetting;
- /** This plugin's plugin info. */
- private final PluginInfo pluginInfo;
- /** The controller to read/write settings with. */
- private final IdentityController identityController;
- /** The manager to use to parse colours. */
- private final ColourManager colourManager;
- /** The frame that the OSDs will be associated with. */
- private final Frame mainFrame;
- /** This plugin's settings domain. */
- private final String domain;
-
- /**
- * Creates a new instance of this plugin.
- *
- * @param swingController The controller that owns this plugin.
- * @param pluginInfo This plugin's plugin info
- * @param identityController The controller to use to read and write settings.
- * @param commandController Command controller to register commands
- * @param colourManager The manager to use to parse colours.
- */
- public OsdPlugin(
- final SwingController swingController,
- final PluginInfo pluginInfo,
- final IdentityController identityController,
- final CommandController commandController,
- final ColourManager colourManager) {
- this.pluginInfo = pluginInfo;
- this.identityController = identityController;
- this.colourManager = colourManager;
- this.mainFrame = swingController.getMainFrame();
- this.domain = pluginInfo.getDomain();
- osdManager = new OsdManager(mainFrame, identityController, colourManager, pluginInfo);
- registerCommand(new OsdCommand(commandController, osdManager), OsdCommand.INFO);
- }
-
- @Override
- public void showConfig(final PreferencesDialogModel manager) {
- x = identityController.getGlobalConfiguration()
- .getOptionInt(domain, "locationX");
- y = identityController.getGlobalConfiguration()
- .getOptionInt(domain, "locationY");
-
- final PreferencesCategory category = new PluginPreferencesCategory(
- pluginInfo, "OSD",
- "General configuration for OSD plugin.", "category-osd");
-
- fontSizeSetting = new PreferencesSetting(PreferencesType.INTEGER,
- domain, "fontSize", "Font size", "Changes the font " + "size of the OSD",
- manager.getConfigManager(),
- manager.getIdentity()).registerChangeListener(this);
- backgroundSetting = new PreferencesSetting(PreferencesType.COLOUR,
- domain, "bgcolour", "Background colour",
- "Background colour for the OSD", manager.getConfigManager(),
- manager.getIdentity()).registerChangeListener(this);
- foregroundSetting = new PreferencesSetting(PreferencesType.COLOUR,
- domain, "fgcolour", "Foreground colour",
- "Foreground colour for the OSD", manager.getConfigManager(),
- manager.getIdentity()).registerChangeListener(this);
- widthSetting = new PreferencesSetting(PreferencesType.INTEGER,
- domain, "width", "OSD Width", "Width of the OSD Window",
- manager.getConfigManager(), manager.getIdentity())
- .registerChangeListener(this);
- timeoutSetting = new PreferencesSetting(PreferencesType.OPTIONALINTEGER,
- new OptionalValidator(new NumericalValidator(1, Integer.MAX_VALUE)),
- domain, "timeout", "Timeout", "Length of time in "
- + "seconds before the OSD window closes", manager.getConfigManager(),
- manager.getIdentity());
- maxWindowsSetting = new PreferencesSetting(PreferencesType.OPTIONALINTEGER,
- new OptionalValidator(new NumericalValidator(1, Integer.MAX_VALUE)),
- domain, "maxWindows", "Maximum open windows",
- "Maximum number of OSD windows that will be displayed at any given time",
- manager.getConfigManager(), manager.getIdentity());
-
- category.addSetting(fontSizeSetting);
- category.addSetting(backgroundSetting);
- category.addSetting(foregroundSetting);
- category.addSetting(widthSetting);
- category.addSetting(timeoutSetting);
- category.addSetting(maxWindowsSetting);
-
- final Map<String, String> posOptions = new HashMap<>();
-
- //Populate policy MULTICHOICE
- for (OsdPolicy policy : OsdPolicy.values()) {
- posOptions.put(policy.name(), policy.getDescription());
- }
-
- category.addSetting(new PreferencesSetting(domain, "newbehaviour",
- "New window policy", "What to do when an OSD Window "
- + "is opened when there are other, existing windows open",
- posOptions, manager.getConfigManager(), manager.getIdentity()));
-
- category.addChangeListener(this);
- manager.getCategory("Plugins").addSubCategory(category);
- manager.registerSaveListener(this);
- }
-
- @Override
- public void categorySelected(final PreferencesCategory category) {
- osdWindow = new OsdWindow(mainFrame, identityController, osdManager, colourManager,
- -1, "Please drag this OSD to position", true, x, y, domain);
- osdWindow.setBackgroundColour(backgroundSetting.getValue());
- osdWindow.setForegroundColour(foregroundSetting.getValue());
- osdWindow.setFontSize(Integer.parseInt(fontSizeSetting.getValue()));
- }
-
- @Override
- public void categoryDeselected(final PreferencesCategory category) {
- x = osdWindow.getLocationOnScreen().x;
- y = osdWindow.getLocationOnScreen().y;
-
- osdWindow.dispose();
- osdWindow = null;
- }
-
- @Override
- public void save() {
- identityController.getUserSettings().setOption(domain, "locationX", x);
- identityController.getUserSettings().setOption(domain, "locationY", y);
- }
-
- @Override
- public void settingChanged(final PreferencesSetting setting) {
- if (osdWindow == null) {
- // They've changed categories but are somehow poking settings.
- // Ignore the request.
- return;
- }
-
- if (setting.equals(fontSizeSetting)) {
- osdWindow.setFontSize(Integer.parseInt(setting.getValue()));
- } else if (setting.equals(backgroundSetting)) {
- osdWindow.setBackgroundColour(setting.getValue());
- } else if (setting.equals(foregroundSetting)) {
- osdWindow.setForegroundColour(setting.getValue());
- } else if (setting.equals(widthSetting)) {
- int width = 500;
- try {
- width = Integer.parseInt(setting.getValue());
- } catch (NumberFormatException e) {
- //Ignore
- }
- osdWindow.setSize(width, osdWindow.getHeight());
- }
- }
-
- /**
- * Shows an OSD with the specified message, title is ignored, exported method used for
- * showNotification.
- *
- * @param title Ignored
- * @param message Message to show
- */
- @Exported
- public void showOSD(final String title, final String message) {
- osdManager.showWindow(-1, message);
- }
-
- }
|