/*
 * 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.inventoryslot.builder;

import de.lessvoid.nifty.Nifty;
import de.lessvoid.nifty.NiftyIdCreator;
import de.lessvoid.nifty.controls.dynamic.attributes.ControlAttributes;
import de.lessvoid.nifty.elements.Element;
import de.lessvoid.nifty.loaderv2.types.ControlType;
import de.lessvoid.nifty.loaderv2.types.ElementType;
import de.lessvoid.nifty.screen.Screen;
import org.illarion.nifty.controls.InventorySlot;

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

public class CreateInventorySlotControl extends ControlAttributes {
    /**
     * The identifier string of the inventory slot control.
     */
    static final String NAME = "inventorySlot";

    /**
     * Create a new inventory slot with a automatically generated ID.
     */
    public CreateInventorySlotControl() {
        setAutoId(NiftyIdCreator.generate());
        setName(NAME);
    }

    /**
     * Create a new inventory slot with a user defined ID.
     *
     * @param id the ID of the new control
     */
    public CreateInventorySlotControl(@Nonnull String id) {
        setId(id);
        setName(NAME);
    }

    /**
     * Create the inventory slot.
     *
     * @param nifty the instance of the Nifty-GUI that will display the slot
     * @param screen the screen this slot will be a part of
     * @param parent the parent element of this slot
     * @return the newly created inventory slot
     */
    @Nullable
    public InventorySlot create(
            @Nonnull Nifty nifty, @Nonnull Screen screen, @Nonnull Element parent) {
        return nifty.addControl(screen, parent, getStandardControl()).getNiftyControl(InventorySlot.class);
    }

    /**
     * Create the element type of this slot.
     *
     * @return the element type of the slot
     */
    @Nonnull
    @Override
    public ElementType createType() {
        return new ControlType(getAttributes());
    }
}