More JavaDoc improvements.
2 * Back 2 Browser Bytecode Translator Copyright (C) 2012 Jaroslav Tulach
3 * <jaroslav.tulach@apidesign.org>
5 * This program is free software: you can redistribute it and/or modify it under
6 * the terms of the GNU General Public License as published by the Free Software
7 * Foundation, version 2 of the License.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
14 * You should have received a copy of the GNU General Public License along with
15 * this program. Look for COPYING file in the top folder. If not, see
16 * http://opensource.org/licenses/GPL-2.0.
18 package net.java.html.canvas;
20 import net.java.html.canvas.Style.Color;
21 import net.java.html.canvas.Style.LinearGradient;
22 import net.java.html.canvas.Style.Pattern;
23 import net.java.html.canvas.Style.RadialGradient;
24 import net.java.html.canvas.spi.GraphicsEnvironment;
25 import org.apidesign.html.canvas.impl.CnvsAccssr;
28 * A 2D Graphics Context similar to HTML5 or JavaFX GraphicsContext. Use this to
29 * paint on your Canvas
33 public final class GraphicsContext {
35 public static void getAccssr() {
36 // do nothing we need this in order to have the class loaded and static
37 // block executed for CnvsAccssr.
40 GraphicsEnvironment graphicsEnvironmentImpl;
43 CnvsAccssr cnvsAccssr = new CnvsAccssr() {
45 public GraphicsContext create(GraphicsEnvironment environment) {
46 return new GraphicsContext(environment);
51 GraphicsContext(GraphicsEnvironment graphicsEnvironment) {
52 this.graphicsEnvironmentImpl = graphicsEnvironment;
56 * Adds path elements to the current path to make an arc.
58 * @param centerX the center x position of the arc.
59 * @param centerY the center y position of the arc.
60 * @param radius the radius of the arc.
61 * @param endAngle teh endAngle of the arc
62 * @param ccw the direction of the arc (counterclockwise)
64 public void arc(double centerX,
70 graphicsEnvironmentImpl.arc(centerX, centerY, startAngle, radius, endAngle, ccw);
74 * Adds segments to the current path to make an arc.
76 * @param x1 the X coordinate of the first point of the arc.
77 * @param y1 the Y coordinate of the first point of the arc.
78 * @param x2 the X coordinate of the second point of the arc.
79 * @param y2 the Y coordinate of the second point of the arc.
80 * @param radius the radius of the arc in the range {0.0-positive infinity}.
82 public void arcTo(double x1,
87 graphicsEnvironmentImpl.arcTo(x1, y1, x2, y2, radius);
91 * Returns true if the the given x,y point is inside the path.
93 * @param x the X coordinate to use for the check.
94 * @param y the Y coordinate to use for the check.
95 * @return true if the point given is inside the path, false otherwise.
97 public boolean isPointInPath(double x, double y) {
98 return graphicsEnvironmentImpl.isPointInPath(x, y);
102 * Fills the path with the current fill paint.
105 graphicsEnvironmentImpl.fill();
109 * Strokes the path with the current stroke paint.
111 public void stroke() {
112 graphicsEnvironmentImpl.stroke();
118 public void beginPath() {
119 graphicsEnvironmentImpl.beginPath();
125 public void closePath() {
126 graphicsEnvironmentImpl.closePath();
130 * Clips using the current path
133 graphicsEnvironmentImpl.clip();
137 * Issues a move command for the current path to the given x,y coordinate.
139 * @param x0 the X position for the move to command.
140 * @param y0 the Y position for the move to command.
142 public void moveTo(double x, double y) {
143 graphicsEnvironmentImpl.moveTo(x, y);
147 * Adds segments to the current path to make a line at the given x,y
150 * @param x1 the X coordinate of the ending point of the line.
151 * @param y1 the Y coordinate of the ending point of the line.
153 public void lineTo(double x, double y) {
154 graphicsEnvironmentImpl.lineTo(x, y);
158 * Adds segments to the current path to make a quadratic curve.
160 * @param cpx the X coordinate of the control point
161 * @param cpy the Y coordinate of the control point
162 * @param x the X coordinate of the end point
163 * @param y the Y coordinate of the end point
165 public void quadraticCurveTo(double cpx, double cpy, double x, double y) {
166 graphicsEnvironmentImpl.quadraticCurveTo(cpx, cpy, x, y);
170 * Adds segments to the current path to make a cubic bezier curve.
172 * @param cp1x the X coordinate of first bezier control point.
173 * @param cp1y the Y coordinate of the first bezier control point.
174 * @param cp2x the X coordinate of the second bezier control point.
175 * @param cp2y the Y coordinate of the second bezier control point.
176 * @param x the X coordinate of the end point.
177 * @param y the Y coordinate of the end point.
179 public void bezierCurveTo(double cp1x, double cp1y, double cp2x, double cp2y, double x, double y) {
180 graphicsEnvironmentImpl.bezierCurveTo(cp1x, cp1y, cp2x, cp2y, x, y);
184 * Fills a rectangle using the current fill paint.
186 * @param x the X position of the upper left corner of the rectangle.
187 * @param y the Y position of the upper left corner of the rectangle.
188 * @param w the width of the rectangle.
189 * @param h the height of the rectangle.
191 public void fillRect(double x, double y, double width, double height) {
192 graphicsEnvironmentImpl.fillRect(x, y, width, height);
196 * Strokes a rectangle using the current stroke paint.
198 * @param x the X position of the upper left corner of the rectangle.
199 * @param y the Y position of the upper left corner of the rectangle.
200 * @param width the width of the rectangle.
201 * @param height the height of the rectangle.
203 public void strokeRect(double x, double y, double width, double height) {
204 graphicsEnvironmentImpl.strokeRect(x, y, width, height);
208 * Clears a portion of the canvas with a transparent color value.
210 * @param x X position of the upper left corner of the rectangle.
211 * @param y Y position of the upper left corner of the rectangle.
212 * @param width width of the rectangle.
213 * @param height height of the rectangle.
215 public void clearRect(double x, double y, double width, double height) {
216 graphicsEnvironmentImpl.clearRect(x, y, width, height);
220 * Clears a portion of the canvas with a transparent color value.
222 * @param x X position of the upper left corner of the rectangle.
223 * @param y Y position of the upper left corner of the rectangle.
224 * @param width width of the rectangle.
225 * @param height height of the rectangle.
227 public void rect(double x, double y, double width, double height) {
228 graphicsEnvironmentImpl.rect(x, y, width, height);
232 * Saves the following attributes onto a stack.
234 * <li>Global Alpha</li>
235 * <li>Global Blend Operation</li>
237 * <li>Fill Paint</li>
238 * <li>Stroke Paint</li>
239 * <li>Line Width</li>
242 * <li>Miter Limit</li>
243 * <li>Number of Clip Paths</li>
245 * <li>Text Align</li>
246 * <li>Text Baseline</li>
250 * This method does NOT alter the current state in any way. Also, not that
251 * the current path is not saved.
254 graphicsEnvironmentImpl.save();
258 * Pops the state off of the stack, setting the following attributes to
259 * their value at the time when that state was pushed onto the stack. If the
260 * stack is empty then nothing is changed.
263 * <li>Global Alpha</li>
264 * <li>Global Blend Operation</li>
266 * <li>Fill Paint</li>
267 * <li>Stroke Paint</li>
268 * <li>Line Width</li>
271 * <li>Miter Limit</li>
272 * <li>Number of Clip Paths</li>
274 * <li>Text Align</li>
275 * <li>Text Baseline</li>
280 public void restore() {
281 graphicsEnvironmentImpl.restore();
285 * Rotates the current transform in degrees.
287 * @param angle value in degrees to rotate the current transform.
289 public void rotate(double angle) {
290 graphicsEnvironmentImpl.rotate(angle);
294 * Concatenates the input with the current transform.
296 * @param mxx - the X coordinate scaling element of the 3x4 matrix
297 * @param myx - the Y coordinate shearing element of the 3x4 matrix
298 * @param mxy - the X coordinate shearing element of the 3x4 matrix
299 * @param myy - the Y coordinate scaling element of the 3x4 matrix
300 * @param mxt - the X coordinate translation element of the 3x4 matrix
301 * @param myt - the Y coordinate translation element of the 3x4 matrix
303 public void transform(double mxx, double myx, double mxy, double myy, double mxt, double myt) {
304 graphicsEnvironmentImpl.transform(mxx, myx, mxy, myy, mxt, myt);
308 * Concatenates the input with the current transform.
310 * @param mxx - the X coordinate scaling element of the 3x4 matrix
311 * @param myx - the Y coordinate shearing element of the 3x4 matrix
312 * @param mxy - the X coordinate shearing element of the 3x4 matrix
313 * @param myy - the Y coordinate scaling element of the 3x4 matrix
314 * @param mxt - the X coordinate translation element of the 3x4 matrix
315 * @param myt - the Y coordinate translation element of the 3x4 matrix
317 public void setTransform(double mxx, double myx, double mxy, double myy, double mxt, double myt) {
318 graphicsEnvironmentImpl.setTransform(mxx, myx, mxy, myy, mxt, myt);
322 * Translates the current transform by x, y.
324 * @param x value to translate along the x axis.
325 * @param y value to translate along the y axis.
327 public void translate(double x, double y) {
328 graphicsEnvironmentImpl.translate(x, y);
332 * Scales the current transform by x, y.
334 * @param x value to scale in the x axis.
335 * @param y value to scale in the y axis.
337 public void scale(double x, double y) {
338 graphicsEnvironmentImpl.scale(x, y);
342 * Draws an image at the given x, y position using the width and height of
345 * @param img the image to be drawn.
346 * @param x the X coordinate on the destination for the upper left of the
348 * @param y the Y coordinate on the destination for the upper left of the
351 public void drawImage(Image image, double x, double y) {
352 Object nativeImage = graphicsEnvironmentImpl.drawImage(image, x, y, image.getCached());
353 image.cache(nativeImage);
357 * Draws an image into the given destination rectangle of the canvas. The
358 * Image is scaled to fit into the destination rectagnle.
360 * @param img the image to be drawn.
361 * @param x the X coordinate on the destination for the upper left of the
363 * @param y the Y coordinate on the destination for the upper left of the
365 * @param width the width of the destination rectangle.
366 * @param height the height of the destination rectangle.
368 public void drawImage(Image image, double x, double y, double width, double height) {
369 Object nativeImage = graphicsEnvironmentImpl.drawImage(image, x, y, width, height, image.getCached());
370 image.cache(nativeImage);
374 * Draws the current source rectangle of the given image to the given
375 * destination rectangle of the Canvas.
377 * @param img the image to be drawn.
378 * @param sx the source rectangle's X coordinate position.
379 * @param sy the source rectangle's Y coordinate position.
380 * @param sw the source rectangle's width.
381 * @param sh the source rectangle's height.
382 * @param dx the destination rectangle's X coordinate position.
383 * @param dy the destination rectangle's Y coordinate position.
384 * @param dw the destination rectangle's width.
385 * @param dh the destination rectangle's height.
387 public void drawImage(Image image, double sx, double sy, double sw, double sh, double dx, double dy, double dw, double dh) {
388 Object nativeImage = graphicsEnvironmentImpl.drawImage(image, sx, sy, sw, sh, dx, dy, dw, dh, image.getCached());
389 image.cache(nativeImage);
393 * Merges two images drawing one on top of the other and returning the
396 * @param a the lower Image
397 * @param b the upper Image
400 public Image merge(Image a, Image b) {
401 if (a.getCached() == null) {
404 if (b.getCached() == null) {
407 Object nativeImage = graphicsEnvironmentImpl.mergeImages(a, b, a.getCached(), b.getCached());
408 Image merged = Image.create("should add real path here");
409 merged.cache(nativeImage);
413 // public void setShadowColor(String color) {
414 // graphicsEnvironmentImpl.setShadowColor(color);
417 // public void setShadowBlur(double blur) {
418 // graphicsEnvironmentImpl.setShadowBlur(blur);
421 // public void setShadowOffsetX(double x) {
422 // graphicsEnvironmentImpl.setShadowOffsetX(x);
425 // public void setShadowOffsetY(double y) {
426 // graphicsEnvironmentImpl.setShadowOffsetY(y);
429 // public String getShadowColor() {
430 // return graphicsEnvironmentImpl.getShadowColor();
433 // public double getShadowBlur() {
434 // return graphicsEnvironmentImpl.getShadowBlur();
437 // public double getShadowOffsetX() {
438 // return graphicsEnvironmentImpl.getShadowOffsetX();
441 // public double getShadowOffsetY() {
442 // return graphicsEnvironmentImpl.getShadowOffsetY();
446 * Gets the current stroke line cap attribute.
448 * @return a value of butt, round, or square.
450 public String getLineCap() {
451 return graphicsEnvironmentImpl.getLineCap();
455 * Sets the current stroke line cap attribute.
457 * @param style a value of miter, bevel, or round.
459 public void setLineCap(String style) {
460 graphicsEnvironmentImpl.setLineCap(style);
464 * Gets the current stroke line join attribute.
466 * @return a value of miter, bevel, or round.
468 public String getLineJoin() {
469 return graphicsEnvironmentImpl.getLineJoin();
473 * Sets the current stroke line join attribute.
475 * @param style a value of miter, bevel, or
478 public void setLineJoin(String style) {
479 graphicsEnvironmentImpl.setLineJoin(style);
483 * Gets the current line width attribute.
485 * @return value between 0 and infinity, with any other value being ignored
486 * and leaving the value unchanged.
489 public double getLineWidth() {
490 return graphicsEnvironmentImpl.getLineWidth();
494 * Sets the current line width attribute.
496 * @param lw value between 0 and infinity, with any other value being
497 * ignored and leaving the value unchanged.
500 public void setLineWidth(double width) {
501 graphicsEnvironmentImpl.setLineWidth(width);
505 * Gets the current miter limit attribute.
507 * @return limit value between 0 and positive infinity with any other value
508 * being ignored and leaving the value unchanged.
510 public double getMiterLimit() {
511 return graphicsEnvironmentImpl.getMiterLimit();
515 * Sets the current miter limit attribute.
517 * @param ml miter limit value between 0 and positive infinity with any
518 * other value being ignored and leaving the value unchanged.
520 public void setMiterLimit(double limit) {
521 graphicsEnvironmentImpl.setMiterLimit(limit);
525 * Sets the fill style. Will be used when rendering something, e.g. calling
526 * one of the fillText Methods.
530 public void setFillStyle(Style style) {
531 Object nativeFillStyle = graphicsEnvironmentImpl.setFillStyle(style, style.getCached());
532 style.cache(nativeFillStyle);
536 * get the current font
538 * @return current Font. of the fillText Methods.
540 public String getFont() {
541 return graphicsEnvironmentImpl.getFont();
545 * Set the Font. Will be used when rendering Text, e.g. by calling one of
546 * the fillText Methods.
550 public void setFont(String font) {
551 graphicsEnvironmentImpl.setFont(font);
555 * sets the Style of the Stroke.
559 public void setStrokeStyle(Style style) {
560 Object nativeStrokeStyle = graphicsEnvironmentImpl.setStrokeStyle(style, style.getCached());
561 style.cache(nativeStrokeStyle);
565 * Gets the current TextAlignment attribute
567 * @return TextAlignment with values of left, center, right, or justify.
569 public String getTextAlign() {
570 return graphicsEnvironmentImpl.getTextAlign();
574 * Defines horizontal text alignment, relative to the text {@code x} origin.
576 * Let horizontal bounds represent the logical width of a single line of
577 * text. Where each line of text has a separate horizontal bounds.
579 * Then TextAlignment is specified as:
581 * <li>left: the left edge of the horizontal bounds will be at {@code x}.
582 * <li>center: the center, halfway between left and right edge, of the
583 * horizontal bounds will be at {@code x}.
584 * <li>right: the right edge of the horizontal bounds will be at {@code x}.
588 * Note: Canvas does not support line wrapping, therefore the text alignment
589 * Justify is identical to left aligned text.
592 * @param textAlign with values of left, center, right.
594 public void setTextAlign(String textAlign) {
595 graphicsEnvironmentImpl.setTextAlign(textAlign);
599 * Gets the current Text Baseline attribute.
601 * @return baseline with values of top, center, baseline, or bottom
603 public String getTextBaseline() {
604 return graphicsEnvironmentImpl.getTextBaseline();
608 * Sets the current Text Baseline attribute.
610 * @param baseline with values of top, center, baseline, or bottom
612 public void setTextBaseline(String textbaseline) {
613 graphicsEnvironmentImpl.setTextBaseline(textbaseline);
617 * Renders the indicated String with current fill. default is black.
619 * @param text the text to stroke
620 * @param x x coordinate of start position
621 * @param y y coordinate of start position
623 public void fillText(String text, double x, double y) {
624 graphicsEnvironmentImpl.fillText(text, x, y);
628 * Renders the indicated String with current fill. default is black.
630 * @param text the text to stroke
631 * @param x x coordinate of start position
632 * @param y y coordinate of start position
633 * @param maxWidth maximum width of text
635 public void fillText(String text, double x, double y, double maxWidth) {
636 graphicsEnvironmentImpl.fillText(text, x, y, maxWidth);
640 * Check the length of a text before writing it to the Canvas. Takes into
641 * account the current Font.
643 * @param text the text to measure
644 * @return the length in pixels
646 public Dimension measureText(String text) {
647 return graphicsEnvironmentImpl.measureText(text);
651 * Renders the indicated String (with no fill)
653 * @param text the text to stroke
654 * @param x x coordinate of start position
655 * @param y y coordinate of start position
657 public void strokeText(String text, double x, double y) {
658 graphicsEnvironmentImpl.strokeText(text, x, y);
662 * Renders the indicated String (with no fill)
664 * @param text the text to stroke
665 * @param x x coordinate of start position
666 * @param y y coordinate of start position
667 * @param maxWidth maximum width of text
669 public void strokeText(String text, double x, double y, double maxWidth) {
670 graphicsEnvironmentImpl.strokeText(text, x, y, maxWidth);
673 // public ImageData createPixelMap(double x, double y) {
674 // return graphicsEnvironmentImpl.createPixelMap(x, y);
677 // public ImageData createPixelMap(ImageData pixelMap) {
678 // return graphicsEnvironmentImpl.createPixelMap(pixelMap);
681 // public ImageData getSnapshot(double x, double y, double width, double height) {
682 // return graphicsEnvironmentImpl.getPixelMap(x, y, width, height);
685 // public void drawPixelMap(ImageData pixelMap, double x, double y) {
686 // graphicsEnvironmentImpl.putPixelMap(pixelMap, x, y);
689 // public void drawPixelMap(ImageData pixelMap, double x, double y, double dirtyx, double dirtyy, double dirtywidth, double dirtyheight) {
690 // graphicsEnvironmentImpl.putPixelMap(pixelMap, x, y, dirtyx, dirtyy, dirtywidth, dirtyheight);
693 * Sets the global alpha of the current state.
695 * @param alpha value in the range {@code 0.0-1.0}. The value is clamped if
696 * it is out of range.
698 public void setGlobalAlpha(double alpha) {
699 graphicsEnvironmentImpl.setGlobalAlpha(alpha);
703 * Gets the current global alpha.
705 * @return the current global alpha.
707 public double getGlobalAlpha() {
708 return graphicsEnvironmentImpl.getGlobalAlpha();
712 * Sets the global blend mode.
714 * @param op the BlendMode that will be set.
716 public void setGlobalCompositeOperation(String operation) {
717 graphicsEnvironmentImpl.setGlobalCompositeOperation(operation);
721 * Gets the global blend mode.
723 * @return the global BlendMode of the current state.
725 public String getGlobalCompositeOperation() {
726 return graphicsEnvironmentImpl.getGlobalCompositeOperation();
730 * Create a LinearGradient to use in Canvas.
732 * @param x0 x coordinate of start point
733 * @param y0 y coordinate of start point
734 * @param x1 x coordinate of end point
735 * @param y1 y coordinate of end point
736 * @return the gradient
738 public LinearGradient createLinearGradient(double x0, double y0, double x1, double y1) {
739 return new Style.LinearGradient(x0, y0, x1, y1);
743 * Create an Image Pattern from a source Image and a repeat style. Possible
744 * Styles are repeat, repeat-x, repeat-y, or no-repeat. defaults to repeat
746 * @param image the Image
747 * @param repeat the repeat style
748 * @return the Pattern
750 public Pattern createPattern(Image image, String repeat) {
751 return new Pattern(image, repeat);
755 * Create a RadialGradient
757 * @param x0 x Coordinate of starting circle
758 * @param y0 y Coordinate of starting circle
759 * @param r0 radius of starting circle
760 * @param x1 x coordinate of ending circle
761 * @param y1 y coordinate of ending circle
762 * @param r1 radius of ending circle
763 * @return the Gradient
765 public RadialGradient createRadialGradient(double x0, double y0, double r0, double x1, double y1, double r1) {
766 return new RadialGradient(x0, y0, r0, x1, y1, r1);
770 * Convert this String Representation of a Color to a Color Object.
773 * @return The Color represented by the input
775 public Color getWebColor(String webColor) {
776 return new Style.Color(webColor);
780 * Get the height of this GraphicsContext (which should be the same as the
781 * enclosing canvas height)
783 * @return the height of this GraphicsContext
785 public int getHeight() {
786 return graphicsEnvironmentImpl.getHeight();
790 * Get the width of this GraphicsContext (which should be the same as the
791 * enclosing canvas height)
793 * @return the width of this GraphicsContext
795 public int getWidth() {
796 return graphicsEnvironmentImpl.getWidth();
799 // public void setHeight(int height) {
800 // graphicsEnvironmentImpl.setHeight(height);
803 // public void setWidth(int width) {
804 // graphicsEnvironmentImpl.setWidth(width);
807 * Fill a circle with a center position of centerX, centerY and the
814 public void fillCircle(float centerX, float centerY, float radius) {
815 graphicsEnvironmentImpl.arc(centerX, centerY, radius, 0, Math.PI * 2, false);
819 * Fills a polygon with the given points using the currently set fill paint.
821 * @param x_coord array containing the x coordinates of the polygon's
823 * @param y_coord array containing the y coordinates of the polygon's
825 * @param vertexCount the number of points that make the polygon.
827 public void fillPolygon(double[] x_coord, double[] y_coord, int vertexCount) {
828 if (vertexCount >= 1 && x_coord != null && x_coord.length >= vertexCount && y_coord != null && y_coord.length >= vertexCount) {
829 graphicsEnvironmentImpl.beginPath();
831 graphicsEnvironmentImpl.moveTo(x_coord[0], y_coord[0]);
832 for (int i = 1; i < vertexCount; i++) {
833 graphicsEnvironmentImpl.lineTo(x_coord[i], y_coord[i]);
836 graphicsEnvironmentImpl.closePath();
837 graphicsEnvironmentImpl.fill();
838 graphicsEnvironmentImpl.stroke();