net.vectorpublish.desktop.vp.api.vpd.StatusName Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of API Show documentation

The newest version!

/*
 * Copyright (c) 2016, Peter Rader. All rights reserved.
 *  ___ ___               __                 ______         __     __  __         __
 * |   |   |.-----..----.|  |_ .-----..----.|   __ \.--.--.|  |--.|  ||__|.-----.|  |--.
 * |   |   ||  -__||  __||   _||  _  ||   _||    __/|  |  ||  _  ||  ||  ||__ --||     |
 *  \_____/ |_____||____||____||_____||__|  |___|   |_____||_____||__||__||_____||__|__|
 *
 * http://www.gnu.org/licenses/gpl-3.0.html
 */
package net.vectorpublish.desktop.vp.api.vpd;

import net.vectorpublish.desktop.vp.api.InheritanceExclusion;

/**
 * Defines a getter for the representation of the node in the status-bar.
 * 
 * If nodes does not implement this interface: no contribution to the status-bar
 * for the instance is used. If none of the nodes selected implements this
 * interface, the message like No description available is used.
 */
public interface StatusName extends InheritanceExclusion {
	/**
	 * The representation of the node in the statusbar seperated by comma.
	 * 
	 * @return The name in the statusbar if this element is selected,
	 *         null will converted into the String-representation
	 *         of null.
	 */
	String getStatusName();
}