DMDirc-Plugins/osd/src/main/java/com/dmdirc/addons/osd/OsdPlugin.java

/*
 * Copyright (c) 2006-2017 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.plugins.Exported;
import com.dmdirc.plugins.PluginInfo;
import com.dmdirc.plugins.implementations.BaseCommandPlugin;

import dagger.ObjectGraph;

/**
 * Allows the user to display on-screen-display messages.
 */
public class OsdPlugin extends BaseCommandPlugin {

    /** The OSD Manager that this plugin is using. */
    private OsdManager osdManager;

    @Override
    public void load(final PluginInfo pluginInfo, final ObjectGraph graph) {
        super.load(pluginInfo, graph);

        setObjectGraph(graph.plus(new OsdModule(pluginInfo)));
        osdManager = getObjectGraph().get(OsdManager.class);

        registerCommand(OsdCommand.class, OsdCommand.INFO);
    }

    @Override
    public void onLoad() {
        osdManager.onLoad();
    }

    @Override
    public void onUnload() {
        osdManager.onUnload();
    }

    /**
     * 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);
    }

}