xy.reflect.ui.info.IInfo Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (C) 2018 OTK Software
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * The GNU General Public License allows you also to freely redistribute 
 * the libraries under the same license, if you provide the terms of the 
 * GNU General Public License with them and add the following 
 * copyright notice at the appropriate place (with a link to 
 * http://javacollection.net/reflectionui/ web site when possible).
 ******************************************************************************/
package xy.reflect.ui.info;

import java.util.Map;

/**
 * This is the base interface for all the abstract UI model elements.
 * 
 * @author olitank
 *
 */
public interface IInfo {

	/**
	 * @return the name of this abstract UI model element.
	 */
	String getName();

	/**
	 * @return the displayed name of this abstract UI model element.
	 */
	String getCaption();

	/**
	 * @return the help text of this abstract UI model element.
	 */
	String getOnlineHelp();

	/**
	 * @return custom properties intended to be used to extend the abstract UI model
	 *         for specific renderers.
	 */
	Map getSpecificProperties();

}