org.scijava.display.DefaultDisplayService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of scijava-common Show documentation
Show all versions of scijava-common Show documentation
SciJava Common is a shared library for SciJava software. It provides a plugin framework, with an extensible mechanism for service discovery, backed by its own annotation processor, so that plugins can be loaded dynamically. It is used by downstream projects in the SciJava ecosystem, such as ImageJ and SCIFIO.
/*
* #%L
* SciJava Common shared library for SciJava software.
* %%
* Copyright (C) 2009 - 2016 Board of Regents of the University of
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
* Institute of Molecular Cell Biology and Genetics.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
package org.scijava.display;
import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;
import org.scijava.display.event.DisplayActivatedEvent;
import org.scijava.display.event.DisplayCreatedEvent;
import org.scijava.display.event.DisplayDeletedEvent;
import org.scijava.display.event.window.WinActivatedEvent;
import org.scijava.display.event.window.WinClosedEvent;
import org.scijava.event.EventHandler;
import org.scijava.event.EventService;
import org.scijava.log.LogService;
import org.scijava.object.ObjectService;
import org.scijava.plugin.Parameter;
import org.scijava.plugin.Plugin;
import org.scijava.plugin.PluginInfo;
import org.scijava.plugin.PluginService;
import org.scijava.service.AbstractService;
import org.scijava.service.Service;
/**
* Default service for working with {@link Display}s.
*
* @author Barry DeZonia
* @author Curtis Rueden
* @author Grant Harris
*/
@Plugin(type = Service.class)
public final class DefaultDisplayService extends AbstractService implements
DisplayService
{
// -- Parameters --
@Parameter
private LogService log;
@Parameter
private EventService eventService;
@Parameter
private ObjectService objectService;
@Parameter
private PluginService pluginService;
// -- instance variables --
private final LinkedList> displayList =
new LinkedList<>();
// -- DisplayService methods --
@Override
public EventService eventService() {
return eventService;
}
@Override
public ObjectService objectService() {
return objectService;
}
@Override
public PluginService pluginService() {
return pluginService;
}
// -- DisplayService methods - active displays --
@Override
public Display getActiveDisplay() {
if (displayList.size() == 0) return null;
return displayList.get(0);
}
@Override
@SuppressWarnings("unchecked")
public > D getActiveDisplay(final Class displayClass)
{
for (final Display disp : displayList) {
if (displayClass.isAssignableFrom(disp.getClass())) return (D) disp;
}
return null;
}
@Override
public void setActiveDisplay(final Display display) {
if (display != null) {
displayList.remove(display);
displayList.addFirst(display);
eventService.publish(new DisplayActivatedEvent(display));
}
}
// -- DisplayService methods - display plugin discovery --
@Override
@SuppressWarnings({ "rawtypes", "unchecked" })
public List>> getDisplayPlugins() {
return (List) pluginService.getPluginsOfType(Display.class);
}
@Override
public > PluginInfo> getDisplayPlugin(
final Class pluginClass)
{
@SuppressWarnings({ "rawtypes", "unchecked" })
final PluginInfo> displayPlugin =
(PluginInfo) pluginService.getPlugin(pluginClass, Display.class);
return displayPlugin;
}
@Override
@SuppressWarnings({ "rawtypes", "unchecked" })
public PluginInfo> getDisplayPlugin(final String className) {
return (PluginInfo) pluginService.getPlugin(className);
}
@Override
public > List> getDisplayPluginsOfType(
final Class type)
{
return pluginService.getPluginsOfType(type);
}
// -- DisplayService methods - display discovery --
@Override
@SuppressWarnings({ "rawtypes", "unchecked" })
public List> getDisplays() {
return (List) objectService.getObjects(Display.class);
}
@Override
public > List getDisplaysOfType(final Class type)
{
return objectService.getObjects(type);
}
@Override
public Display getDisplay(final String name) {
for (final Display display : getDisplays()) {
if (name.equalsIgnoreCase(display.getName())) {
return display;
}
}
return null;
}
@Override
public List> getDisplays(final Object o) {
final ArrayList> displays = new ArrayList<>();
for (final Display display : getDisplays()) {
if (display.isDisplaying(o)) displays.add(display);
}
return displays;
}
// -- DisplayService methods - display creation --
@Override
public boolean isUniqueName(final String name) {
for (final Display display : getDisplays()) {
if (name.equalsIgnoreCase(display.getName())) {
return false;
}
}
return true;
}
@Override
public Display createDisplay(final Object o) {
return createDisplay(null, o);
}
@Override
public Display createDisplay(final String name, final Object o) {
final Display display = createDisplayQuietly(o);
if (display == null) return null;
if (name != null) display.setName(name);
eventService.publish(new DisplayCreatedEvent(display));
return display;
}
@Override
public Display createDisplayQuietly(final Object o) {
// get available display plugins from the plugin service
final List>> displayPlugins = getDisplayPlugins();
for (final PluginInfo> info : displayPlugins) {
final Display display = pluginService.createInstance(info);
if (display == null) continue;
// display object using the first compatible Display
// TODO: how to handle multiple matches? prompt user with dialog box?
if (display.canDisplay(o)) {
display.display(o);
return display;
}
}
return null;
}
// -- Event handlers --
/** Deletes the display when display window is closed. */
@EventHandler
protected void onEvent(final WinClosedEvent event) {
final Display display = event.getDisplay();
if (display != null) display.close();
}
/** Sets the display to active when its window is activated. */
@EventHandler
protected void onEvent(final WinActivatedEvent event) {
final Display display = event.getDisplay();
if (display != null) setActiveDisplay(display);
}
/** Removes a display from the display list when it is deleted */
@EventHandler
protected void onEvent(final DisplayDeletedEvent evt) {
displayList.remove(evt.getObject());
}
}