/*
 * 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 illarion.client.gui.util;

import de.lessvoid.nifty.Nifty;
import de.lessvoid.nifty.render.NiftyImage;
import illarion.client.gui.EntitySlickRenderImage;
import illarion.client.resources.ItemFactory;
import illarion.client.world.items.SelectionItem;
import illarion.common.types.ItemId;
import org.illarion.nifty.controls.SelectListEntry;

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

/**
 * This implementation of the select item is very similar to the original select item. It just adds a few entries
 * of data that are needed so the item can be displayed properly in the GUI.
 *
 * @author Martin Karing <nitram@illarion.org>
 */
public final class NiftySelectItem extends SelectionItem implements SelectListEntry {
    /**
     * The image that represents this merchant item.
     */
    @Nullable
    private final NiftyImage itemImage;

    /**
     * Create a new instance of that merchant item.
     * <p/>
     * This constructor performs changes to the Nifty-GUI. Do not call it outside the regular update loop of the GUI.
     *
     * @param nifty the instance of the Nifty-GUI used to create the objects for the GUI
     * @param org the original merchant item that contains the actual data
     */
    public NiftySelectItem(@Nonnull Nifty nifty, @Nonnull SelectionItem org) {
        super(org);

        ItemId id = org.getId();
        if (ItemId.isValidItem(id)) {
            itemImage = new NiftyImage(nifty.getRenderEngine(),
                    new EntitySlickRenderImage(ItemFactory.getInstance().getTemplate(id)));
        } else {
            itemImage = null;
        }
    }

    /**
     * Get the image that is meant to display this merchant item in the list.
     *
     * @return the Nifty image
     */
    @Nullable
    @Override
    public NiftyImage getItemImage() {
        return itemImage;
    }
}