fr.techad.edc.popover.swing.EdcSwingHelp Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of edc-popover Show documentation

Java Popover to display a summary of the documentation published by edc

There is a newer version: 3.0.0

package fr.techad.edc.popover.swing;

import fr.techad.edc.popover.EdcHelp;

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

/**
 * Use i to create a Swing Component to display the documentation.
 */
public interface EdcSwingHelp extends EdcHelp {

    /**
     * Create a Swing component which will display the documentation.
     *
     * @param mainKey the main key
     * @param subKey  the subkey
     * @return the GUI component
     */
    JComponent createComponent(String mainKey, String subKey);

    /**
     * Create a Swing component which will display the documentation.
     *
     * @param mainKey  the main key
     * @param subKey   the subkey
     * @param iconPath the icon path to override the default
     * @return the GUI component
     */
    JComponent createComponent(String mainKey, String subKey, String iconPath);

    /**
     * Create a Swing Mouse Listener which will manage the mouse event to display the documentation
     *
     * @param mainKey the main key
     * @param subKey  the subket
     * @return the Mouse Listener
     */
    MouseListener getMouseListener(String mainKey, String subKey);

    /**
     * Define the background color for the component summary
     *
     * @param backgroundColor the color to set
     */
    void setBackgroundColor(Color backgroundColor);
}