org.scijava.AbstractUIDetails 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;
import org.scijava.util.ClassUtils;
import org.scijava.util.MiscUtils;
import org.scijava.util.StringMaker;
/**
* Abstract superclass of {@link UIDetails} implementations.
*
* @author Curtis Rueden
*/
public abstract class AbstractUIDetails extends AbstractBasicDetails implements UIDetails {
/** Path to this object's suggested position in the menu structure. */
private MenuPath menuPath;
/** Name of the menu structure to which the object belongs. */
private String menuRoot = APPLICATION_MENU_ROOT;
/** Resource path to this object's icon. */
private String iconPath;
/** Sort priority of the object. */
private double priority = Priority.NORMAL_PRIORITY;
/** Whether the object can be selected in the user interface. */
private boolean selectable;
/** The name of the selection group to which the object belongs. */
private String selectionGroup;
/** Whether the object is selected in the user interface. */
private boolean selected;
/** Whether the object is enabled in the user interface. */
private boolean enabled = true;
/** Whether the object is visible in the user interface. */
private boolean visible = true;
// -- Object methods --
@Override
public String toString() {
final StringMaker sm = new StringMaker();
sm.append(super.toString());
sm.append("menu", menuPath == null ? null : menuPath.getMenuString());
sm.append("iconPath", iconPath);
sm.append("priority", priority, Integer.MAX_VALUE);
if (selectable) {
sm.append("selectionGroup", selectionGroup);
sm.append("selected", selected);
}
sm.append("enabled", enabled);
return sm.toString();
}
// -- UIDetails methods --
@Override
public String getTitle() {
// use object label, if available
if (getLabel() != null && !getLabel().isEmpty()) return getLabel();
// use name of leaf menu item, if available
if (menuPath != null && menuPath.size() > 0) {
final MenuEntry menuLeaf = menuPath.getLeaf();
final String menuName = menuLeaf.getName();
if (menuName != null && !menuName.isEmpty()) return menuName;
}
// use object name, if available
if (getName() != null && !getName().isEmpty()) return getName();
// use the unique identifier, if available
if (this instanceof Identifiable) {
final String id = ((Identifiable) this).getIdentifier();
if (id != null) return id;
}
// use class name as a last resort
return getClass().getSimpleName();
}
@Override
public MenuPath getMenuPath() {
return menuPath;
}
@Override
public String getMenuRoot() {
return menuRoot;
}
@Override
public String getIconPath() {
return iconPath;
}
@Override
public boolean isEnabled() {
return enabled;
}
@Override
public boolean isVisible() {
return visible;
}
@Override
public boolean isSelectable() {
return selectable;
}
@Override
public String getSelectionGroup() {
return selectionGroup;
}
@Override
public boolean isSelected() {
return selected;
}
@Override
public void setMenuPath(final MenuPath menuPath) {
if (menuPath == null) {
this.menuPath = new MenuPath();
}
else {
this.menuPath = menuPath;
}
}
@Override
public void setMenuRoot(final String menuRoot) {
this.menuRoot = menuRoot;
}
@Override
public void setIconPath(final String iconPath) {
this.iconPath = iconPath;
}
@Override
public void setEnabled(final boolean enabled) {
this.enabled = enabled;
}
@Override
public void setVisible(final boolean visible) {
this.visible = visible;
}
@Override
public void setSelectable(final boolean selectable) {
this.selectable = selectable;
}
@Override
public void setSelectionGroup(final String selectionGroup) {
this.selectionGroup = selectionGroup;
}
@Override
public void setSelected(final boolean selected) {
this.selected = selected;
}
// -- Prioritized methods --
@Override
public double getPriority() {
return priority;
}
@Override
public void setPriority(final double priority) {
this.priority = priority;
}
// -- Comparable methods --
@Override
public int compareTo(final Prioritized that) {
if (that == null) return 1;
// compare priorities
final int priorityCompare = Priority.compare(this, that);
if (priorityCompare != 0) return priorityCompare;
// compare classes
final int classCompare = ClassUtils.compare(getClass(), that.getClass());
if (classCompare != 0) return classCompare;
if (!(that instanceof UIDetails)) return 1;
final UIDetails uiDetails = (UIDetails) that;
// compare names
final String thisName = getName();
final String thatName = uiDetails.getName();
final int nameCompare = MiscUtils.compare(thisName, thatName);
if (nameCompare != 0) return nameCompare;
// compare titles
final String thisTitle = getTitle();
final String thatTitle = uiDetails.getTitle();
return MiscUtils.compare(thisTitle, thatTitle);
}
}