VAqua.src.org.violetlib.aqua.fc.BrowserPreviewRenderer Maven / Gradle / Ivy

Go to download

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

An improved native Swing look and feel for macOS

The newest version!

/*
 * @(#)BrowserPreviewRenderer.java
 *
 * Copyright (c) 2005-2013 Werner Randelshofer, Switzerland.
 * You may not use, copy or modify this file, except in compliance with the
 * accompanying license terms.
 */

package org.violetlib.aqua.fc;

import javax.swing.tree.TreePath;
import java.awt.*;

/**
 * Identifies components that can be used to paint the preview column in a
 * JBrowser. Unlike other renderers, this one is not just used for a rubber stamp.
 * The renderer is added to the preview column of the JBrowser.
 * 
 * For example, to use a JLabel as a BrowserPreviewRenderer, you
 * would write something like this:
 * 
 * class MyPreviewRenderer extends JLabel implements BrowserPreviewRenderer {
 *     public MyPreviewRenderer() {
 *         setOpaque(true);
 *     }
 *     public Component getPreviewRendererRendererComponent(
 *         JBrowser browser,
 *         TreePath[] paths
 *         )
 *     {
 *         setText((paths.length == 1)
 *            ? values[0].getLastPathComponent().toString()
 *            : values.length+" items");
 *         return this;
 *     }
 * }
 * 
 *
 * @author  Werner Randelshofer
 * @version $Id$
 */
public interface BrowserPreviewRenderer {
    /**
     * Return a component that has been configured to display the specified
     * value. That component is then added to the preview column of the JBrowser.
     *
     * @param browser The JBrowser we're painting.
     * @param paths The paths returned by browser.getSelectionPaths(). This
     * is granted to be a non-null array containing at least one element.
     * @return The component.
     *
     */
    Component getPreviewRendererComponent(
            JBrowser browser,
            TreePath[] paths
    );
}