/*
 * This file is part of the Illarion project.
 *
 * Copyright © 2015 - Illarion e.V.
 *
 * Illarion is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Illarion 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.
 */

/**
 *
 */
package org.illarion.nifty.controls;

import de.lessvoid.nifty.controls.NiftyControl;
import de.lessvoid.nifty.render.NiftyImage;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * The interface to control a single slot of the inventory.
 *
 * @author Martin Karing <nitram@illarion.org>
 */
public interface InventorySlot extends NiftyControl {
    /**
     * The different stages for the merchant overlay.
     */
    enum MerchantBuyLevel {
        /**
         * The lowest level. Displayed with a copper coin.
         */
        Copper,

        /**
         * Medium level. Displayed with a silver coin.
         */
        Silver,

        /**
         * Highest level. Displayed with a gold coin.
         */
        Gold
    }

    /**
     * Set the image that is supposed to be displayed in this inventory slot.
     *
     * @param image the displayed image
     */
    void setImage(@Nullable NiftyImage image);

    /**
     * Set the image that is displayed as background of this slot.
     *
     * @param image the image in the background of this slot
     */
    void setBackgroundImage(@Nullable NiftyImage image);

    /**
     * Show the label in this inventory slot.
     */
    void showLabel();

    /**
     * Hide the label in this inventory slot.
     */
    void hideLabel();

    /**
     * Set the text that is displayed in the label of this slot.
     *
     * @param text the label text
     */
    void setLabelText(@Nonnull String text);

    /**
     * Send the draggable object back to this slot.
     */
    void retrieveDraggable();

    /**
     * This function causes the visibility stare of the component to be restored. This is needed in case the parent
     * object changed its visibility.
     */
    void restoreVisibility();

    /**
     * Hide the merchant overlay in case its currently displayed.
     */
    void hideMerchantOverlay();

    /**
     * Show the specified merchant overlay.
     *
     * @param level the overlay level to show
     */
    void showMerchantOverlay(@Nonnull MerchantBuyLevel level);
}