com.jgoodies.common.display.Displayable Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2013-2014 JGoodies Software GmbH. All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  o Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 *  o 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.
 *
 *  o Neither the name of JGoodies Software GmbH nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * 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 OWNER 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.
 */

package com.jgoodies.common.display;


/**
 * Describes objects with a default String presentation.
 * Useful for implementing reusable object presentations in Formats,
 * ListCellRenderers, TableCellRenderers, etc.
 * 
 * If the object shall have a special default presentation in lists or tables,
 * they may additionally implement {@link ListDisplayable} and/or
 * {@link TableDisplayable}.
 * 
 * Used by the reusable JGoodies list and table cell renderers:
 * {@code JGDisplayableListCellRenderer} and {@code JGDisplayableTableCellRenderer}.
 *
 * @author  Karsten Lentzsch
 * 
 * @since 1.7
 */
public interface Displayable {
	
	/**
	 * Returns this object's default String presentation for views such as
	 * read-only text fields, list, tables, tree nodes, etc.
	 * 
	 * @return this object's standard representation
	 */
    String getDisplayString();
    
}