org.jhotdraw8.draw.input.ClipboardInputFormat Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.jhotdraw8.draw Show documentation

JHotDraw8 Drawing Framework

The newest version!

/*
 * @(#)ClipboardInputFormat.java
 * Copyright © 2023 The authors and contributors of JHotDraw. MIT License.
 */
package org.jhotdraw8.draw.input;

import javafx.scene.input.Clipboard;
import org.jhotdraw8.draw.figure.Drawing;
import org.jhotdraw8.draw.figure.Figure;
import org.jhotdraw8.draw.model.DrawingModel;
import org.jspecify.annotations.Nullable;

import java.io.IOException;
import java.util.Set;

/**
 * InputFormat for clipboard.
 *
 * @author Werner Randelshofer
 */
public interface ClipboardInputFormat {

    /**
     * Reads a Drawing from the clipboard.
     *
     * @param clipboard The clipboard.
     * @param model     the drawing model over which updates of the drawing must be
     *                  performed.
     * @param drawing   The contents of the clipboard is added to this drawing.
     * @param parent    If you provide a non-null value, the contents of the
     *                  clipboard is added to this parent. Otherwise, the content is added into an
     *                  unspecified layer.
     * @return the figures that were read from the clipboard
     * @throws IOException if an IO error occurs
     */
    Set read(Clipboard clipboard, DrawingModel model, Drawing drawing, @Nullable Figure parent) throws IOException;
}