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

Go to download
/*
 * 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.managers.style.StyleableComponent;

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

/**
 * Component information provider interface.
 *
 * @author Mikle Garin
 */

public interface ComponentInfo
{
    /**
     * Returns icon for the specified component.
     * Can return {@code null} to use default component icon.
     *
     * @param type      styleable component type
     * @param component component to provide icon for
     * @return icon for the specified component
     */
    public ImageIcon getIcon ( final StyleableComponent type, final T component );

    /**
     * Returns string value for the specified component.
     *
     * @param type      styleable component type
     * @param component object to provide text for
     * @return string value for the specified component
     */
    public String getText ( final StyleableComponent type, final T component );
}