Class ImageExportResult
- java.lang.Object
-
- com.nomagic.magicdraw.export.image.ImageExportResult
-
@OpenApiAll public class ImageExportResult extends java.lang.Object
Class providing image export result.Diagram: +-------------------------+ | HEADER | +-------------------------+ | | | +-------------+ | | | | | | | A | | | | | | | +-------------+ | | | +-------------------------+ | FOOTER | +-------------------------+ Exported image with banners: +-- | +-------------+ | | HEADER | | +-------------+ | | | B | | C | | | | | +-------------+ | | FOOTER | | +-------------+ +-- Exported image without banners: +-- | +-------------+ | | | B | | C | | | | | +-------------+ +-- Failed export image: +- | +----------------+ B | | Error message | | +----------------+ +- A -
exportedAreaRect
Start point and dimension of exported area. In case of failed export (over time/dimension limits, error) rectangle will be empty as no part of diagram was exported B -imageRect
Rectangle of exported image. ContainsimageWithoutBannersRect
and banners, or is same asimageWithoutBannersRect
if banners are not exported Might also be just size of failed export image C -imageWithoutBannersRect
Rectangle within exported image containingexportedAreaRect
(same height and width, only starting coordinates are different) In case of failed export (over time/dimension limits, error) rectangle will be empty as it does not exist in exported image A and C only differs in starting coordinate since one is in diagram coordinates, other in exported image
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImageExportResult.ImageExportStatus
-
Field Summary
Fields Modifier and Type Field Description private java.awt.Rectangle
exportedAreaRect
Start point in the diagram and dimension exported diagram areaprivate ImageExportResult.ImageExportStatus
exportStatus
private java.awt.Rectangle
imageRect
Rectangle of exported image.private java.awt.Rectangle
imageWithoutBannersRect
Rectangle within exported image containing exported are
-
Constructor Summary
Constructors Constructor Description ImageExportResult()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.awt.Rectangle
getExportedAreaRect()
ImageExportResult.ImageExportStatus
getExportStatus()
java.awt.Rectangle
getImageRect()
java.awt.Rectangle
getImageWithoutBannersRect()
boolean
isDiagramNotExported()
boolean
isExportSuccessful()
void
setExportedAreaRect(java.awt.Rectangle exportedAreaRect)
void
setExportStatus(ImageExportResult.ImageExportStatus exportStatus)
void
setImageRect(java.awt.Rectangle imageRect)
void
setImageWithoutBannersRect(java.awt.Rectangle imageWithoutBannersRect)
-
-
-
Field Detail
-
exportStatus
private ImageExportResult.ImageExportStatus exportStatus
-
exportedAreaRect
private java.awt.Rectangle exportedAreaRect
Start point in the diagram and dimension exported diagram area
-
imageWithoutBannersRect
private java.awt.Rectangle imageWithoutBannersRect
Rectangle within exported image containing exported are
-
imageRect
private java.awt.Rectangle imageRect
Rectangle of exported image.
-
-
Method Detail
-
isExportSuccessful
public boolean isExportSuccessful()
-
isDiagramNotExported
public boolean isDiagramNotExported()
- Returns:
- true if diagram was not exported due to exceeding limits or some error
-
getExportStatus
public ImageExportResult.ImageExportStatus getExportStatus()
-
setExportStatus
public void setExportStatus(ImageExportResult.ImageExportStatus exportStatus)
-
getExportedAreaRect
public java.awt.Rectangle getExportedAreaRect()
-
setExportedAreaRect
public void setExportedAreaRect(java.awt.Rectangle exportedAreaRect)
-
getImageWithoutBannersRect
public java.awt.Rectangle getImageWithoutBannersRect()
-
setImageWithoutBannersRect
public void setImageWithoutBannersRect(java.awt.Rectangle imageWithoutBannersRect)
-
getImageRect
public java.awt.Rectangle getImageRect()
-
setImageRect
public void setImageRect(java.awt.Rectangle imageRect)
-
-