org.jhotdraw8.draw.input.ClipboardOutputFormat 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!

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

import javafx.scene.input.DataFormat;
import org.jhotdraw8.draw.figure.Drawing;
import org.jhotdraw8.draw.figure.Figure;

import java.io.IOException;
import java.util.Collection;
import java.util.Collections;
import java.util.Map;

/**
 * OutputFormat for clipboard.
 *
 * @author Werner Randelshofer
 */
public interface ClipboardOutputFormat {

    /**
     * Writes a Drawing into a clipboard
     *
     * @param out     The clipboard
     * @param drawing The drawing.
     * @throws IOException if an IO error occurs
     */
    default void write(Map out, Drawing drawing) throws IOException {
        write(out, drawing, Collections.singleton(drawing));
    }

    /**
     * Writes a selection of figures from a Drawing into a clipboard
     *
     * @param out       The clipboard
     * @param drawing   The drawing.
     * @param selection A selection
     * @throws IOException if an IO error occurs
     */
    void write(Map out, Drawing drawing, Collection selection) throws IOException;
}