Documentation of 'kcl.waterloo.common.deploy.AbstractDeployableGraphics2D' Java class
AbstractDeployableGraphics2D
Skip navigation links
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method
kcl.waterloo.common.deploy

Class AbstractDeployableGraphics2D

  • Direct Known Subclasses:
    PDEGraphics2D, WSVGGraphics2D

    public abstract class AbstractDeployableGraphics2D
extends java.awt.Graphics2D
    Abstract class for generating graphics scripts.

    AbstractDeployableGraphics2D is extended e.g. by PDEGraphics2D which provides a concrete implementation for generating Processing script output.

    Other subclasses may be added in the future to support other scripting languages.

    Revisions:

    14.05.2013 Change class name to avoid conflicts with third-party packages.

    27.05.2013 Do not clone parentGraphics in constructor

    08.12.2013 Remove some left-over pde specific code

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method and Description
      abstract void addCode(java.lang.String code)
      Inserts user-specified code into the coded output at the current location.
      abstract void addComment(java.lang.String comment)
      Sets a string that will be added to the code output as a comment.
      void addRenderingHints(java.util.Map<?,?> hints) 
      abstract void append(java.awt.Component c) 
      abstract void append(java.awt.Component c, int elapsedTime) 
      abstract void appendCode(java.lang.String code)
      Adds user-specified code to the end of the generated code.
      void clearRect(int x, int y, int width, int height) 
      void clip(java.awt.Shape s) 
      void clipRect(int x, int y, int width, int height) 
      void copyArea(int x, int y, int width, int height, int dx, int dy) 
      abstract boolean copyImage(java.awt.Image img, int dx, int dy, int sx, int sy, int width, int height, java.awt.Color bgcolor, java.awt.image.ImageObserver observer)
      Implemented in some Graphics2D subclasses e.g.
      void dispose() 
      void draw(java.awt.Shape s) 
      void draw3DRect(int x, int y, int width, int height, boolean raised)
      AWT Graphics and Graphics2D classes generally implement draw3DRect through calls to other methods.
      void drawArc(int x, int y, int width, int height, int startAngle, int arcAngle) 
      void drawBytes(byte[] data, int offset, int length, int x, int y) 
      void drawGlyphVector(java.awt.font.GlyphVector g, float x, float y) 
      void drawImage(java.awt.image.BufferedImage img, java.awt.image.BufferedImageOp op, int x, int y) 
      boolean drawImage(java.awt.Image img, java.awt.geom.AffineTransform xform, java.awt.image.ImageObserver obs) 
      boolean drawImage(java.awt.Image img, int x, int y, java.awt.Color bgcolor, java.awt.image.ImageObserver observer) 
      boolean drawImage(java.awt.Image img, int x, int y, java.awt.image.ImageObserver observer) 
      boolean drawImage(java.awt.Image img, int x, int y, int width, int height, java.awt.Color bgcolor, java.awt.image.ImageObserver observer) 
      boolean drawImage(java.awt.Image img, int x, int y, int width, int height, java.awt.image.ImageObserver observer) 
      boolean drawImage(java.awt.Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, java.awt.Color bgcolor, java.awt.image.ImageObserver observer) 
      boolean drawImage(java.awt.Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, java.awt.image.ImageObserver observer) 
      void drawLine(int x1, int y1, int x2, int y2) 
      void drawOval(int x, int y, int width, int height) 
      void drawPolygon(int[] xPoints, int[] yPoints, int nPoints) 
      void drawPolyline(int[] xPoints, int[] yPoints, int nPoints) 
      void drawRect(int x, int y, int width, int height) 
      void drawRenderableImage(java.awt.image.renderable.RenderableImage img, java.awt.geom.AffineTransform xform) 
      void drawRenderedImage(java.awt.image.RenderedImage img, java.awt.geom.AffineTransform xform) 
      void drawRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight) 
      void drawString(java.text.AttributedCharacterIterator iterator, float x, float y) 
      void drawString(java.text.AttributedCharacterIterator iterator, int x, int y) 
      void drawString(java.lang.String str, float x, float y) 
      void drawString(java.lang.String str, int x, int y) 
      void fill(java.awt.Shape s) 
      void fill3DRect(int x, int y, int width, int height, boolean raised)
      AWT Graphics and Graphics2D classes generally implement fill3DRect through calls to other methods.
      void fillArc(int x, int y, int width, int height, int startAngle, int arcAngle) 
      void fillOval(int x, int y, int width, int height) 
      void fillPolygon(int[] xPoints, int[] yPoints, int nPoints) 
      void fillRect(int x, int y, int width, int height) 
      void fillRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight) 
      int getActionDelay() 
      java.awt.Color getBackground() 
      java.awt.Shape getClip() 
      java.awt.Rectangle getClipBounds() 
      java.lang.String getCode() 
      java.awt.Color getColor() 
      java.awt.Composite getComposite() 
      java.awt.GraphicsConfiguration getDeviceConfiguration() 
      java.awt.Font getFont() 
      java.awt.FontMetrics getFontMetrics(java.awt.Font f) 
      java.awt.font.FontRenderContext getFontRenderContext() 
      java.awt.Paint getPaint() 
      java.lang.Object getRenderingHint(java.awt.RenderingHints.Key hintKey) 
      java.awt.RenderingHints getRenderingHints() 
      java.awt.Stroke getStroke() 
      java.awt.geom.AffineTransform getTransform() 
      boolean hit(java.awt.Rectangle rect, java.awt.Shape s, boolean onStroke) 
      boolean isAlsoPaintToSource() 
      abstract void prependCode(java.lang.String code)
      Inserts user-specified code at the start of the generated code, but after any automatically generated declarations (which are therefore potentially available for use in that code).
      void rotate(double theta) 
      void rotate(double theta, double x, double y) 
      void scale(double sx, double sy) 
      void setActionDelay(int actionDelay) 
      void setAlsoPaintToSource(boolean alsoPaintToSource) 
      void setBackground(java.awt.Color color) 
      void setClip(int x, int y, int width, int height) 
      void setClip(java.awt.Shape clip) 
      void setColor(java.awt.Color c) 
      void setComposite(java.awt.Composite comp) 
      void setFont(java.awt.Font font) 
      void setPaint(java.awt.Paint paint) 
      void setPaintMode() 
      abstract void setPaintObject(java.lang.Object paintObject)
      Call this routine in the painting mechanism of an AWT/Swing hierarchy.
      void setRenderingHint(java.awt.RenderingHints.Key hintKey, java.lang.Object hintValue) 
      void setRenderingHints(java.util.Map<?,?> hints) 
      void setStroke(java.awt.Stroke s) 
      void setTransform(java.awt.geom.AffineTransform Tx) 
      void setXORMode(java.awt.Color c1) 
      void shear(double shx, double shy) 
      void transform(java.awt.geom.AffineTransform Tx) 
      void translate(double tx, double ty) 
      void translate(int x, int y) 
      void write(java.io.File f) 
      void write(java.lang.String f)
      Writes the generated code to

      • Methods inherited from class java.awt.Graphics

        create, create, drawChars, drawPolygon, fillPolygon, finalize, getClipBounds, getClipRect, getFontMetrics, hitClip, toString

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Method Detail

      • isAlsoPaintToSource

        public boolean isAlsoPaintToSource()

      • setAlsoPaintToSource

        public void setAlsoPaintToSource(boolean alsoPaintToSource)

      • getActionDelay

        public int getActionDelay()
        Returns:
        the actionDelay

      • setActionDelay

        public void setActionDelay(int actionDelay)
        Parameters:
        actionDelay - the actionDelay to set

      • append

        public abstract void append(java.awt.Component c,
                            int elapsedTime)

      • append

        public abstract void append(java.awt.Component c)

      • getCode

        public java.lang.String getCode()
        Returns:
        the code

      • write

        public void write(java.io.File f)
           throws java.io.IOException
        Throws:
        java.io.IOException

      • write

        public void write(java.lang.String f)
           throws java.io.IOException
        Writes the generated code to
        Parameters:
        f - the file name
        Throws:
        java.io.IOException

      • setPaintObject

        public abstract void setPaintObject(java.lang.Object paintObject)
        Call this routine in the painting mechanism of an AWT/Swing hierarchy. How a concrete class responds is an implementation detail for the subclass. Typically, this will simply be used to add a comment to the generated code in a custom component e.g.

        public void paintComponent(Graphics g){
        if (g instanceof AbstractDeployableGraphics2D) {
        ((AbstractDeployableGraphics2D)g).setPaintObject(this);
        }
        }

        Parameters:
        paintObject - the paintObject to set

      • addComment

        public abstract void addComment(java.lang.String comment)
        Sets a string that will be added to the code output as a comment. Do not added comment markers - these should be added by any concrete implementations automatically and will be specific to the code language being used.
        Parameters:
        comment - the comment to set as a String

      • prependCode

        public abstract void prependCode(java.lang.String code)
        Inserts user-specified code at the start of the generated code, but after any automatically generated declarations (which are therefore potentially available for use in that code).
        Parameters:
        code - fully formatted code string

      • addCode

        public abstract void addCode(java.lang.String code)
        Inserts user-specified code into the coded output at the current location.
        Parameters:
        code - fully formatted code string

      • appendCode

        public abstract void appendCode(java.lang.String code)
        Adds user-specified code to the end of the generated code.
        Parameters:
        code - the code to append

      • copyImage

        public abstract boolean copyImage(java.awt.Image img,
                                  int dx,
                                  int dy,
                                  int sx,
                                  int sy,
                                  int width,
                                  int height,
                                  java.awt.Color bgcolor,
                                  java.awt.image.ImageObserver observer)
        Implemented in some Graphics2D subclasses e.g. com.sun.java.Graphics2D. This is not part of the java.awt.Graphics2D API.
        Parameters:
        img -
        dx -
        dy -
        sx -
        sy -
        width -
        height -
        bgcolor -
        observer -
        Returns:
        true or false

      • draw3DRect

        public final void draw3DRect(int x,
                             int y,
                             int width,
                             int height,
                             boolean raised)
        AWT Graphics and Graphics2D classes generally implement draw3DRect through calls to other methods. Consequently there is no need to implement any code here explicitly as long as the concrete implementation of Graphics2D in parentGraphics works similarly, e.g. by a call to the Graphics2D methods.
        Overrides:
        draw3DRect in class java.awt.Graphics2D

      • fill3DRect

        public final void fill3DRect(int x,
                             int y,
                             int width,
                             int height,
                             boolean raised)
        AWT Graphics and Graphics2D classes generally implement fill3DRect through calls to other methods. Consequently there is no need to implement any code here explicitly as long as the concrete implementation of Graphics2D in parentGraphics works similarly, e.g. by a call to the Graphics2D methods.
        Overrides:
        fill3DRect in class java.awt.Graphics2D

      • setTransform

        public final void setTransform(java.awt.geom.AffineTransform Tx)
        Specified by:
        setTransform in class java.awt.Graphics2D

      • getTransform

        public java.awt.geom.AffineTransform getTransform()
        Specified by:
        getTransform in class java.awt.Graphics2D

      • getStroke

        public java.awt.Stroke getStroke()
        Specified by:
        getStroke in class java.awt.Graphics2D

      • clip

        public void clip(java.awt.Shape s)
        Specified by:
        clip in class java.awt.Graphics2D

      • getFontRenderContext

        public java.awt.font.FontRenderContext getFontRenderContext()
        Specified by:
        getFontRenderContext in class java.awt.Graphics2D

      • getColor

        public java.awt.Color getColor()
        Specified by:
        getColor in class java.awt.Graphics

      • setColor

        public void setColor(java.awt.Color c)
        Specified by:
        setColor in class java.awt.Graphics

      • setPaintMode

        public void setPaintMode()
        Specified by:
        setPaintMode in class java.awt.Graphics

      • getFont

        public final java.awt.Font getFont()
        Specified by:
        getFont in class java.awt.Graphics

      • setFont

        public void setFont(java.awt.Font font)
        Specified by:
        setFont in class java.awt.Graphics

      • getClipBounds

        public java.awt.Rectangle getClipBounds()
        Specified by:
        getClipBounds in class java.awt.Graphics

      • clipRect

        public void clipRect(int x,
                     int y,
                     int width,
                     int height)
        Specified by:
        clipRect in class java.awt.Graphics

      • setClip

        public void setClip(int x,
                    int y,
                    int width,
                    int height)
        Specified by:
        setClip in class java.awt.Graphics

      • getClip

        public java.awt.Shape getClip()
        Specified by:
        getClip in class java.awt.Graphics

      • setClip

        public void setClip(java.awt.Shape clip)
        Specified by:
        setClip in class java.awt.Graphics

      • hit

        public boolean hit(java.awt.Rectangle rect,
                   java.awt.Shape s,
                   boolean onStroke)
        Specified by:
        hit in class java.awt.Graphics2D

      • setComposite

        public void setComposite(java.awt.Composite comp)
        Specified by:
        setComposite in class java.awt.Graphics2D

      • setPaint

        public void setPaint(java.awt.Paint paint)
        Specified by:
        setPaint in class java.awt.Graphics2D

      • setStroke

        public void setStroke(java.awt.Stroke s)
        Specified by:
        setStroke in class java.awt.Graphics2D

      • setRenderingHint

        public void setRenderingHint(java.awt.RenderingHints.Key hintKey,
                             java.lang.Object hintValue)
        Specified by:
        setRenderingHint in class java.awt.Graphics2D

      • getRenderingHint

        public java.lang.Object getRenderingHint(java.awt.RenderingHints.Key hintKey)
        Specified by:
        getRenderingHint in class java.awt.Graphics2D

      • setRenderingHints

        public void setRenderingHints(java.util.Map<?,?> hints)
        Specified by:
        setRenderingHints in class java.awt.Graphics2D

      • addRenderingHints

        public void addRenderingHints(java.util.Map<?,?> hints)
        Specified by:
        addRenderingHints in class java.awt.Graphics2D

      • getRenderingHints

        public java.awt.RenderingHints getRenderingHints()
        Specified by:
        getRenderingHints in class java.awt.Graphics2D

      • setXORMode

        public void setXORMode(java.awt.Color c1)
        Specified by:
        setXORMode in class java.awt.Graphics

      • getFontMetrics

        public java.awt.FontMetrics getFontMetrics(java.awt.Font f)
        Specified by:
        getFontMetrics in class java.awt.Graphics

      • copyArea

        public void copyArea(int x,
                     int y,
                     int width,
                     int height,
                     int dx,
                     int dy)
        Specified by:
        copyArea in class java.awt.Graphics

      • getDeviceConfiguration

        public java.awt.GraphicsConfiguration getDeviceConfiguration()
        Specified by:
        getDeviceConfiguration in class java.awt.Graphics2D

      • translate

        public void translate(int x,
                      int y)
        Specified by:
        translate in class java.awt.Graphics2D

      • translate

        public void translate(double tx,
                      double ty)
        Specified by:
        translate in class java.awt.Graphics2D

      • rotate

        public void rotate(double theta)
        Specified by:
        rotate in class java.awt.Graphics2D

      • rotate

        public void rotate(double theta,
                   double x,
                   double y)
        Specified by:
        rotate in class java.awt.Graphics2D

      • scale

        public void scale(double sx,
                  double sy)
        Specified by:
        scale in class java.awt.Graphics2D

      • shear

        public void shear(double shx,
                  double shy)
        Specified by:
        shear in class java.awt.Graphics2D

      • transform

        public void transform(java.awt.geom.AffineTransform Tx)
        Specified by:
        transform in class java.awt.Graphics2D

      • getPaint

        public java.awt.Paint getPaint()
        Specified by:
        getPaint in class java.awt.Graphics2D

      • getComposite

        public java.awt.Composite getComposite()
        Specified by:
        getComposite in class java.awt.Graphics2D

      • setBackground

        public void setBackground(java.awt.Color color)
        Specified by:
        setBackground in class java.awt.Graphics2D

      • getBackground

        public java.awt.Color getBackground()
        Specified by:
        getBackground in class java.awt.Graphics2D

      • draw

        public void draw(java.awt.Shape s)
        Specified by:
        draw in class java.awt.Graphics2D
        Parameters:
        s -

      • drawString

        public void drawString(java.lang.String str,
                       int x,
                       int y)
        Specified by:
        drawString in class java.awt.Graphics2D

      • drawString

        public void drawString(java.lang.String str,
                       float x,
                       float y)
        Specified by:
        drawString in class java.awt.Graphics2D

      • drawString

        public void drawString(java.text.AttributedCharacterIterator iterator,
                       int x,
                       int y)
        Specified by:
        drawString in class java.awt.Graphics2D

      • drawString

        public void drawString(java.text.AttributedCharacterIterator iterator,
                       float x,
                       float y)
        Specified by:
        drawString in class java.awt.Graphics2D

      • drawGlyphVector

        public void drawGlyphVector(java.awt.font.GlyphVector g,
                            float x,
                            float y)
        Specified by:
        drawGlyphVector in class java.awt.Graphics2D

      • fill

        public void fill(java.awt.Shape s)
        Specified by:
        fill in class java.awt.Graphics2D

      • drawLine

        public void drawLine(int x1,
                     int y1,
                     int x2,
                     int y2)
        Specified by:
        drawLine in class java.awt.Graphics

      • drawRect

        public void drawRect(int x,
                     int y,
                     int width,
                     int height)
        Overrides:
        drawRect in class java.awt.Graphics

      • fillRect

        public void fillRect(int x,
                     int y,
                     int width,
                     int height)
        Specified by:
        fillRect in class java.awt.Graphics

      • clearRect

        public void clearRect(int x,
                      int y,
                      int width,
                      int height)
        Specified by:
        clearRect in class java.awt.Graphics

      • drawRoundRect

        public void drawRoundRect(int x,
                          int y,
                          int width,
                          int height,
                          int arcWidth,
                          int arcHeight)
        Specified by:
        drawRoundRect in class java.awt.Graphics

      • fillRoundRect

        public void fillRoundRect(int x,
                          int y,
                          int width,
                          int height,
                          int arcWidth,
                          int arcHeight)
        Specified by:
        fillRoundRect in class java.awt.Graphics

      • drawOval

        public void drawOval(int x,
                     int y,
                     int width,
                     int height)
        Specified by:
        drawOval in class java.awt.Graphics

      • fillOval

        public void fillOval(int x,
                     int y,
                     int width,
                     int height)
        Specified by:
        fillOval in class java.awt.Graphics

      • drawArc

        public void drawArc(int x,
                    int y,
                    int width,
                    int height,
                    int startAngle,
                    int arcAngle)
        Specified by:
        drawArc in class java.awt.Graphics

      • fillArc

        public void fillArc(int x,
                    int y,
                    int width,
                    int height,
                    int startAngle,
                    int arcAngle)
        Specified by:
        fillArc in class java.awt.Graphics

      • drawPolyline

        public void drawPolyline(int[] xPoints,
                         int[] yPoints,
                         int nPoints)
        Specified by:
        drawPolyline in class java.awt.Graphics

      • drawPolygon

        public void drawPolygon(int[] xPoints,
                        int[] yPoints,
                        int nPoints)
        Specified by:
        drawPolygon in class java.awt.Graphics

      • fillPolygon

        public void fillPolygon(int[] xPoints,
                        int[] yPoints,
                        int nPoints)
        Specified by:
        fillPolygon in class java.awt.Graphics

      • drawBytes

        public void drawBytes(byte[] data,
                      int offset,
                      int length,
                      int x,
                      int y)
        Overrides:
        drawBytes in class java.awt.Graphics

      • drawImage

        public boolean drawImage(java.awt.Image img,
                         int x,
                         int y,
                         java.awt.image.ImageObserver observer)
        Specified by:
        drawImage in class java.awt.Graphics

      • drawImage

        public boolean drawImage(java.awt.Image img,
                         int x,
                         int y,
                         int width,
                         int height,
                         java.awt.image.ImageObserver observer)
        Specified by:
        drawImage in class java.awt.Graphics

      • drawImage

        public boolean drawImage(java.awt.Image img,
                         int x,
                         int y,
                         java.awt.Color bgcolor,
                         java.awt.image.ImageObserver observer)
        Specified by:
        drawImage in class java.awt.Graphics

      • drawImage

        public boolean drawImage(java.awt.Image img,
                         int x,
                         int y,
                         int width,
                         int height,
                         java.awt.Color bgcolor,
                         java.awt.image.ImageObserver observer)
        Specified by:
        drawImage in class java.awt.Graphics

      • drawImage

        public boolean drawImage(java.awt.Image img,
                         int dx1,
                         int dy1,
                         int dx2,
                         int dy2,
                         int sx1,
                         int sy1,
                         int sx2,
                         int sy2,
                         java.awt.image.ImageObserver observer)
        Specified by:
        drawImage in class java.awt.Graphics

      • drawImage

        public boolean drawImage(java.awt.Image img,
                         int dx1,
                         int dy1,
                         int dx2,
                         int dy2,
                         int sx1,
                         int sy1,
                         int sx2,
                         int sy2,
                         java.awt.Color bgcolor,
                         java.awt.image.ImageObserver observer)
        Specified by:
        drawImage in class java.awt.Graphics

      • drawImage

        public boolean drawImage(java.awt.Image img,
                         java.awt.geom.AffineTransform xform,
                         java.awt.image.ImageObserver obs)
        Specified by:
        drawImage in class java.awt.Graphics2D

      • drawImage

        public void drawImage(java.awt.image.BufferedImage img,
                      java.awt.image.BufferedImageOp op,
                      int x,
                      int y)
        Specified by:
        drawImage in class java.awt.Graphics2D

      • drawRenderedImage

        public void drawRenderedImage(java.awt.image.RenderedImage img,
                              java.awt.geom.AffineTransform xform)
        Specified by:
        drawRenderedImage in class java.awt.Graphics2D

      • drawRenderableImage

        public void drawRenderableImage(java.awt.image.renderable.RenderableImage img,
                                java.awt.geom.AffineTransform xform)
        Specified by:
        drawRenderableImage in class java.awt.Graphics2D

      • dispose

        public void dispose()
        Specified by:
        dispose in class java.awt.Graphics
Skip navigation links
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

DMelt 3.0 © DataMelt by jWork.ORG

You see the box below because you did not login.