Package com.nomagic.magicdraw.export.image

Class ImageExporter

java.lang.Object

com.nomagic.magicdraw.export.image.ImageExporter

@OpenApiAll
public class ImageExporter
extends java.lang.Object

The exporter of diagrams to various images formats.

Field Summary

Fields

Modifier and Type	Field	Description
static int	EMF	EMF image format.
static int	EPS	EPS image format.
static int	JPEG	JPEG image format.
static int	PNG	PNG image format.
static int	SVG	SVG image format.
static int	SVG_NO_BOUNDS_CHANGE	.
static int	TIFF	TIFF image format.
static int	WMF	WMF image format.

Constructor Summary

Constructors

Constructor	Description
ImageExporter()

Method Summary

Modifier and Type	Method	Description
static java.awt.image.BufferedImage	export(AbstractDiagramPresentationElement diagram, boolean justSelected)	Exports diagram into the BufferedImage.
static java.awt.image.BufferedImage	export(AbstractDiagramPresentationElement diagram, boolean justSelected, int scalePercent)	Exports diagram into the BufferedImage.
static java.awt.Rectangle	export(AbstractDiagramPresentationElement diagram, int format, java.io.File file)	Exports diagram into given format image.
static java.awt.Rectangle	export(AbstractDiagramPresentationElement diagram, int format, java.io.File file, boolean justSelected)	Exports diagram into given format image.
static java.awt.Rectangle	export(AbstractDiagramPresentationElement diagram, int format, java.io.File file, boolean justSelected, boolean saveBackground)	Exports diagram into given format image.
static java.awt.Rectangle	export(AbstractDiagramPresentationElement diagram, int format, java.io.File file, boolean justSelected, int dpi, int scalePercent)	Exports diagram into given format image.
static java.awt.Rectangle	export(AbstractDiagramPresentationElement diagram, int format, java.io.File file, boolean justSelected, ProgressStatus progressStatus)	Exports diagram into given format image.
static java.awt.image.BufferedImage	export(PresentationElement element, int scalePercent)	Exports single PresentationElement (for example Class) into the BufferedImage.
static java.awt.Rectangle	export(PresentationElement element, int format, java.io.File file, int dpi, int scalePercent)	Exports single PresentationElement(for example Class) into the given format image.
static ImageExportResult	exportForResult(AbstractDiagramPresentationElement diagram, int format, java.io.File file)	Exports diagram into given format image.
static ImageExportResult	exportForResult(AbstractDiagramPresentationElement diagram, int format, java.io.File file, boolean justSelected, int dpi, int scalePercent)	Exports diagram into given format image.
static ImageExportResult	exportForResult(AbstractDiagramPresentationElement diagram, int format, java.io.File file, boolean justSelected, ProgressStatus progressStatus)	Exports diagram into given format image.
static ImageExportResult	exportForResult(PresentationElement element, int format, java.io.File file, int dpi, int scalePercent)	Exports single PresentationElement(for example Class) into the given format image.
static boolean	isSelectedSymbolsExportable(AbstractDiagramPresentationElement diagram)	Checks if any selected symbol (in given diagram) can be exported into image.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JPEG

public static final int JPEG

JPEG image format.

See Also:

Constant Field Values

PNG

public static final int PNG

PNG image format.

See Also:

Constant Field Values

WMF

public static final int WMF

WMF image format.

See Also:

Constant Field Values

EPS

public static final int EPS

EPS image format.

See Also:

Constant Field Values

SVG

public static final int SVG

SVG image format.

See Also:

Constant Field Values

EMF

public static final int EMF

EMF image format.

See Also:

Constant Field Values

TIFF

public static final int TIFF

TIFF image format.

See Also:

Constant Field Values

SVG_NO_BOUNDS_CHANGE

public static final int SVG_NO_BOUNDS_CHANGE

. SVG image format without bounds change. Used to preview changes in diagrams in merge dialog.

See Also:

Constant Field Values

Constructor Detail

ImageExporter

public ImageExporter()

Method Detail

export

@CheckForNull
public static java.awt.image.BufferedImage export(AbstractDiagramPresentationElement diagram,
                                                  boolean justSelected)
                                           throws java.io.IOException

Exports diagram into the BufferedImage. Exports all symbols from the diagram.

Parameters:

diagram - the given diagram.

justSelected - export only selected symbols in the diagram. If diagram does not have selected symbols, all symbols are exported

Returns:

the BufferedImage instance of the diagram.

Throws:

java.io.IOException - in case of some io error.

export

@CheckForNull
public static java.awt.image.BufferedImage export(AbstractDiagramPresentationElement diagram,
                                                  boolean justSelected,
                                                  int scalePercent)
                                           throws java.io.IOException

Exports diagram into the BufferedImage. Exports all symbols from the diagram.

Parameters:

diagram - the given diagram.

justSelected - export only selected symbols in the diagram. If diagram does not have selected symbols, all symbols are exported

scalePercent - defines scaling the output image to given percentage. Value of 100 does not scale image.

Returns:

the BufferedImage instance of the diagram.

Throws:

java.io.IOException - in case of some io error.

export

public static java.awt.Rectangle export(AbstractDiagramPresentationElement diagram,
                                        int format,
                                        java.io.File file)
                                 throws java.io.IOException

Exports diagram into given format image. Writes this image into given file. Exports all symbols from the diagram.

Parameters:

diagram - the given diagram.

format - format of the image.

file - the output file

Returns:

saved image bounds(start point in the diagram and dimension of image).

Throws:

java.io.IOException - in case of some io error.

exportForResult

public static ImageExportResult exportForResult(AbstractDiagramPresentationElement diagram,
                                                int format,
                                                java.io.File file)
                                         throws java.io.IOException

Exports diagram into given format image. Writes this image into given file. Exports all symbols from the diagram.

Parameters:

diagram - the given diagram.

format - format of the image.

file - the output file

Returns:

Image export result.

Throws:

java.io.IOException - in case of some io error.

export

public static java.awt.Rectangle export(AbstractDiagramPresentationElement diagram,
                                        int format,
                                        java.io.File file,
                                        boolean justSelected)
                                 throws java.io.IOException

Exports diagram into given format image. Writes this image into given file. Exports all or just selected symbols from the diagram.

Parameters:

diagram - the given diagram.

format - format of the image.

file - the output file

justSelected - export only selected symbols in the diagram. If diagram does not have selected symbols, all symbols are exported

Returns:

saved image bounds(start point in the diagram and dimension of image).

Throws:

java.io.IOException - in case of some io error.

export

@CheckForNull
public static java.awt.Rectangle export(AbstractDiagramPresentationElement diagram,
                                        int format,
                                        java.io.File file,
                                        boolean justSelected,
                                        @CheckForNull
                                        ProgressStatus progressStatus)
                                 throws java.io.IOException

Exports diagram into given format image. Writes this image into given file. Exports all or just selected symbols from the diagram.

Parameters:

diagram - the given diagram.

format - format of the image.

file - the output file

justSelected - export only selected symbols in the diagram. If diagram does not have selected symbols, all symbols are exported

progressStatus - instance of ProgressStatus can be null.

Returns:

saved image bounds(start point in the diagram and dimension of image).

Throws:

java.io.IOException - in case of some io error.

exportForResult

@CheckForNull
public static ImageExportResult exportForResult(AbstractDiagramPresentationElement diagram,
                                                int format,
                                                java.io.File file,
                                                boolean justSelected,
                                                @CheckForNull
                                                ProgressStatus progressStatus)
                                         throws java.io.IOException

Exports diagram into given format image. Writes this image into given file. Exports all or just selected symbols from the diagram.

Parameters:

diagram - the given diagram.

format - format of the image.

file - the output file

justSelected - export only selected symbols in the diagram. If diagram does not have selected symbols, all symbols are exported

progressStatus - instance of ProgressStatus can be null.

Returns:

Image export result.

Throws:

java.io.IOException - in case of some io error.

export

public static java.awt.Rectangle export(AbstractDiagramPresentationElement diagram,
                                        int format,
                                        java.io.File file,
                                        boolean justSelected,
                                        boolean saveBackground)
                                 throws java.io.IOException

Exports diagram into given format image. Writes this image into given file. Exports all or just selected symbols from the diagram.

Parameters:

diagram - the given diagram.

format - format of the image.

file - the output file

justSelected - export only selected symbols in the diagram. If diagram does not have selected symbols, all symbols are exported

saveBackground - save diagram background in image.

Returns:

saved image bounds(start point in the diagram and dimension of image).

Throws:

java.io.IOException - in case of some io error.

exportForResult

public static ImageExportResult exportForResult(AbstractDiagramPresentationElement diagram,
                                                int format,
                                                java.io.File file,
                                                boolean justSelected,
                                                int dpi,
                                                int scalePercent)
                                         throws java.io.IOException

Exports diagram into given format image. Writes this image into given file. Exports all or just selected symbols from the diagram.

Parameters:

diagram - the given diagram.

format - format of the image.

file - the output file

justSelected - export only selected symbols in the diagram. If diagram does not have selected symbols, all symbols are exported

dpi - sets the DPI flag in output image. Parameter is ignored for vector images.

scalePercent - defines scaling the output image to given percentage. Value of 100 does not scale image. Is ignored by WMF file format.

Returns:

Image export result.

Throws:

java.io.IOException - in case of some io error.

export

public static java.awt.Rectangle export(AbstractDiagramPresentationElement diagram,
                                        int format,
                                        java.io.File file,
                                        boolean justSelected,
                                        int dpi,
                                        int scalePercent)
                                 throws java.io.IOException

Exports diagram into given format image. Writes this image into given file. Exports all or just selected symbols from the diagram.

Parameters:

diagram - the given diagram.

format - format of the image.

file - the output file

justSelected - export only selected symbols in the diagram. If diagram does not have selected symbols, all symbols are exported

dpi - sets the DPI flag in output image. Parameter is ignored for vector images.

scalePercent - defines scaling the output image to given percentage. Value of 100 does not scale image. Is ignored by WMF file format.

Returns:

saved image bounds(start point in the diagram and dimension of image).

Throws:

java.io.IOException - in case of some io error.

isSelectedSymbolsExportable

public static boolean isSelectedSymbolsExportable(AbstractDiagramPresentationElement diagram)

Checks if any selected symbol (in given diagram) can be exported into image. E.g. the selected link can not be exported if the connected elements symbols are not selected.

Parameters:

diagram - given diagram.

Returns:

true - if any of selected symbols can be exported; otherwise - false.

export

@CheckForNull
public static java.awt.Rectangle export(PresentationElement element,
                                        int format,
                                        java.io.File file,
                                        int dpi,
                                        int scalePercent)
                                 throws java.io.IOException

Exports single PresentationElement(for example Class) into the given format image. Writes this image into the given file.

Parameters:

element - the given presentation element.

format - format of the image.

file - the output file

dpi - sets the DPI flag in output image. Parameter is ignored for vector images.

scalePercent - defines scaling the output image to given percentage. Value of 100 does not scale image. Is ignored by WMF file format.

Returns:

saved image bounds(start point in the diagram and dimension of image).

Throws:

java.io.IOException - in case of some io error.

exportForResult

@CheckForNull
public static ImageExportResult exportForResult(PresentationElement element,
                                                int format,
                                                java.io.File file,
                                                int dpi,
                                                int scalePercent)
                                         throws java.io.IOException

Exports single PresentationElement(for example Class) into the given format image. Writes this image into the given file.

Parameters:

element - the given presentation element.

format - format of the image.

file - the output file

dpi - sets the DPI flag in output image. Parameter is ignored for vector images.

scalePercent - defines scaling the output image to given percentage. Value of 100 does not scale image. Is ignored by WMF file format.

Returns:

Image export result.

Throws:

java.io.IOException - in case of some io error.

export

@CheckForNull
public static java.awt.image.BufferedImage export(PresentationElement element,
                                                  int scalePercent)
                                           throws java.io.IOException

Exports single PresentationElement (for example Class) into the BufferedImage.

Parameters:

element - the given element.

scalePercent - defines scaling the output image to given percentage. Value of 100 does not scale image.

Returns:

the BufferedImage instance of the diagram.

Throws:

java.io.IOException - in case of some io error.