be.yildizgames.module.window.widget.WindowMultiLayerImage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of module-window Show documentation

Window module to wrap graphic engine and handle inputs.

The newest version!

package be.yildizgames.module.window.widget;

import java.util.Optional;

/**
 * @author Grégory Van den Borre
 */
public interface WindowMultiLayerImage extends WindowWidget {

    /**
     * Set the image to display.
     *
     * @param url Url of the image to display [not null].
     * @param layer Layer [>=0].
     * @return This object for chaining [not null].
     */
    WindowMultiLayerImage setImage(String url, int layer);

    /**
     * Get the image associated to the layer.
     * @param layer Layer [>=0].
     * @return The image associated to the layer [not null].
     */
    Optional getImage(int layer);

    /**
     * Force the displayed image ratio to be preserved.
     *
     * @return This object for chaining [not null].
     */
    WindowMultiLayerImage preserveRatio();
}