com.alee.extended.inspector.info.ComponentPreview Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of weblaf-ui Show documentation

WebLaF UI components

There is a newer version: 1.2.14

/*
 * This file is part of WebLookAndFeel library.
 *
 * WebLookAndFeel library 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.
 *
 * WebLookAndFeel library 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with WebLookAndFeel library.  If not, see .
 */

package com.alee.extended.inspector.info;

import com.alee.api.annotations.NotNull;

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

/**
 * Short component information provider interface.
 *
 * @param  component type
 * @author Mikle Garin
 */
public interface ComponentPreview
{
    /**
     * Returns icon for the specified {@link Component}.
     *
     * @param component {@link Component} to provide icon for
     * @return icon for the specified {@link Component}
     */
    @NotNull
    public Icon getIcon ( @NotNull C component );

    /**
     * Returns text value for the specified {@link Component}.
     *
     * @param component {@link Component} to provide text for
     * @return text value for the specified {@link Component}
     */
    @NotNull
    public String getText ( @NotNull C component );
}