Class mxGraphViewImageReader

  • All Implemented Interfaces:
    org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

    public class mxGraphViewImageReader
    extends mxGraphViewReader
    A converter that renders display XML data onto a graphics canvas. This reader can only be used to generate images for encoded graph views.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean antiAlias
      Specifies if the image should be anti-aliased.
      protected java.awt.Color background
      Specifies the background color.
      protected int border
      Specifies the border which is added to the size of the graph.
      protected mxRectangle clip
      Defines the clip to be drawn.
      protected boolean cropping
      Specifies the border which is added to the size of the graph.
    • Constructor Summary

      Constructors 
      Constructor Description
      mxGraphViewImageReader()
      Constructs a new reader with a transparent background.
      mxGraphViewImageReader​(java.awt.Color background)
      Constructs a new reader with the given background color.
      mxGraphViewImageReader​(java.awt.Color background, int border)
      Constructs a new reader with a transparent background.
      mxGraphViewImageReader​(java.awt.Color background, int border, boolean antiAlias)
      Constructs a new reader with a transparent background.
      mxGraphViewImageReader​(java.awt.Color background, int border, boolean antiAlias, boolean cropping)
      Constructs a new reader with a transparent background.
    • Field Detail

      • background

        protected java.awt.Color background
        Specifies the background color. Default is null.
      • antiAlias

        protected boolean antiAlias
        Specifies if the image should be anti-aliased. Default is true.
      • border

        protected int border
        Specifies the border which is added to the size of the graph. Default is 0.
      • cropping

        protected boolean cropping
        Specifies the border which is added to the size of the graph. Default is true.
      • clip

        protected mxRectangle clip
        Defines the clip to be drawn. Default is null.
    • Constructor Detail

      • mxGraphViewImageReader

        public mxGraphViewImageReader()
        Constructs a new reader with a transparent background.
      • mxGraphViewImageReader

        public mxGraphViewImageReader​(java.awt.Color background)
        Constructs a new reader with the given background color.
      • mxGraphViewImageReader

        public mxGraphViewImageReader​(java.awt.Color background,
                                      int border)
        Constructs a new reader with a transparent background.
      • mxGraphViewImageReader

        public mxGraphViewImageReader​(java.awt.Color background,
                                      int border,
                                      boolean antiAlias)
        Constructs a new reader with a transparent background.
      • mxGraphViewImageReader

        public mxGraphViewImageReader​(java.awt.Color background,
                                      int border,
                                      boolean antiAlias,
                                      boolean cropping)
        Constructs a new reader with a transparent background.
    • Method Detail

      • getBackground

        public java.awt.Color getBackground()
      • setBackground

        public void setBackground​(java.awt.Color background)
      • getBorder

        public int getBorder()
      • setBorder

        public void setBorder​(int border)
      • isAntiAlias

        public boolean isAntiAlias()
      • setAntiAlias

        public void setAntiAlias​(boolean antiAlias)
      • isCropping

        public boolean isCropping()
        Specifies the optional clipping rectangle.
      • setCropping

        public void setCropping​(boolean value)
      • createCanvas

        public mxICanvas createCanvas​(java.util.Map<java.lang.String,​java.lang.Object> attrs)
        Description copied from class: mxGraphViewReader
        Returns the canvas to be used for rendering.
        Specified by:
        createCanvas in class mxGraphViewReader
        Parameters:
        attrs - Specifies the attributes of the new canvas.
        Returns:
        Returns a new canvas.
      • createGraphicsCanvas

        protected mxGraphics2DCanvas createGraphicsCanvas()
        Hook that creates the graphics canvas.
      • convert

        public static java.awt.image.BufferedImage convert​(java.lang.String filename,
                                                           mxGraphViewImageReader viewReader)
                                                    throws javax.xml.parsers.ParserConfigurationException,
                                                           org.xml.sax.SAXException,
                                                           java.io.IOException
        Creates the image for the given display XML file. (Note: The XML file is an encoded mxGraphView, not mxGraphModel.)
        Parameters:
        filename - Filename of the display XML file.
        Returns:
        Returns an image representing the display XML file.
        Throws:
        javax.xml.parsers.ParserConfigurationException
        org.xml.sax.SAXException
        java.io.IOException
      • convert

        public static java.awt.image.BufferedImage convert​(org.xml.sax.InputSource inputSource,
                                                           mxGraphViewImageReader viewReader)
                                                    throws javax.xml.parsers.ParserConfigurationException,
                                                           org.xml.sax.SAXException,
                                                           java.io.IOException
        Creates the image for the given display XML input source. (Note: The XML is an encoded mxGraphView, not mxGraphModel.)
        Parameters:
        inputSource - Input source that contains the display XML.
        Returns:
        Returns an image representing the display XML input source.
        Throws:
        javax.xml.parsers.ParserConfigurationException
        org.xml.sax.SAXException
        java.io.IOException