More JavaDoc improvements. canvas
authorAnton Epple <toni.epple@eppleton.de>
Wed, 12 Feb 2014 08:33:31 +0100
branchcanvas
changeset 14448cb57e6c7012
parent 1443 6e51eb226f44
child 1445 493cae4fd458
More JavaDoc improvements.
javaquery/canvas/src/main/java/net/java/html/canvas/GraphicsContext.java
     1.1 --- a/javaquery/canvas/src/main/java/net/java/html/canvas/GraphicsContext.java	Wed Feb 12 08:21:34 2014 +0100
     1.2 +++ b/javaquery/canvas/src/main/java/net/java/html/canvas/GraphicsContext.java	Wed Feb 12 08:33:31 2014 +0100
     1.3 @@ -33,7 +33,8 @@
     1.4  public final class GraphicsContext {
     1.5  
     1.6      public static void getAccssr() {
     1.7 -        // do nothing
     1.8 +        // do nothing we need this in order to have the class loaded and static 
     1.9 +        // block executed for CnvsAccssr.
    1.10      }
    1.11  
    1.12      GraphicsEnvironment graphicsEnvironmentImpl;
    1.13 @@ -441,43 +442,90 @@
    1.14  //        return graphicsEnvironmentImpl.getShadowOffsetY();
    1.15  //    }
    1.16      
    1.17 -    
    1.18 +    /**
    1.19 +     * Gets the current stroke line cap attribute. 
    1.20 +     * 
    1.21 +     * @return  a value of butt, round, or square.
    1.22 +     */    
    1.23      public String getLineCap() {
    1.24          return graphicsEnvironmentImpl.getLineCap();
    1.25      }
    1.26 -
    1.27 +    
    1.28 +    /**
    1.29 +     * Sets the current stroke line cap attribute.
    1.30 +     * 
    1.31 +     * @param style  a value of miter, bevel, or round.
    1.32 +     */
    1.33      public void setLineCap(String style) {
    1.34          graphicsEnvironmentImpl.setLineCap(style);
    1.35      }
    1.36  
    1.37 +    /**
    1.38 +     * Gets the current stroke line join attribute.
    1.39 +     *
    1.40 +     * @return  a value of miter, bevel, or round.
    1.41 +     */
    1.42      public String getLineJoin() {
    1.43          return graphicsEnvironmentImpl.getLineJoin();
    1.44      }
    1.45  
    1.46 +    /**
    1.47 +     * Sets the current stroke line join attribute.
    1.48 +     *
    1.49 +     * @param style  a value of miter, bevel, or
    1.50 +     * round.
    1.51 +     */
    1.52      public void setLineJoin(String style) {
    1.53          graphicsEnvironmentImpl.setLineJoin(style);
    1.54      }
    1.55  
    1.56 +    /**
    1.57 +     * Gets the current line width attribute.
    1.58 +     *
    1.59 +     * @return value between 0 and infinity, with any other value being ignored
    1.60 +     * and leaving the value unchanged.
    1.61 +     *
    1.62 +     */
    1.63      public double getLineWidth() {
    1.64          return graphicsEnvironmentImpl.getLineWidth();
    1.65      }
    1.66  
    1.67 +    /**
    1.68 +     * Sets the current line width attribute.
    1.69 +     *
    1.70 +     * @param lw value between 0 and infinity, with any other value being
    1.71 +     * ignored and leaving the value unchanged.
    1.72 +     *
    1.73 +     */
    1.74      public void setLineWidth(double width) {
    1.75          graphicsEnvironmentImpl.setLineWidth(width);
    1.76      }
    1.77  
    1.78 +    /**
    1.79 +     * Gets the current miter limit attribute.
    1.80 +     *
    1.81 +     * @return limit value between 0 and positive infinity with any other value
    1.82 +     * being ignored and leaving the value unchanged.
    1.83 +     */
    1.84      public double getMiterLimit() {
    1.85          return graphicsEnvironmentImpl.getMiterLimit();
    1.86      }
    1.87  
    1.88 +    /**
    1.89 +     * Sets the current miter limit attribute.
    1.90 +     *
    1.91 +     * @param ml miter limit value between 0 and positive infinity with any
    1.92 +     * other value being ignored and leaving the value unchanged.
    1.93 +     */
    1.94      public void setMiterLimit(double limit) {
    1.95          graphicsEnvironmentImpl.setMiterLimit(limit);
    1.96      }
    1.97  
    1.98      /**
    1.99 -     * Sets the fill style. Will be used when rendering something, e.g. calling one
   1.100 -     * of the fillText Methods.
   1.101 -     * @param style 
   1.102 +     * Sets the fill style. Will be used when rendering something, e.g. calling
   1.103 +     * one of the fillText Methods.
   1.104 +     *
   1.105 +     * @param style
   1.106       */
   1.107      public void setFillStyle(Style style) {
   1.108          Object nativeFillStyle = graphicsEnvironmentImpl.setFillStyle(style, style.getCached());
   1.109 @@ -487,16 +535,15 @@
   1.110      /**
   1.111       * get the current font
   1.112       *
   1.113 -     * @return current Font. 
   1.114 -     * of the fillText Methods.
   1.115 +     * @return current Font. of the fillText Methods.
   1.116       */
   1.117      public String getFont() {
   1.118          return graphicsEnvironmentImpl.getFont();
   1.119      }
   1.120  
   1.121      /**
   1.122 -     * Set the Font. Will be used when rendering Text, e.g. by calling one
   1.123 -     * of the fillText Methods.
   1.124 +     * Set the Font. Will be used when rendering Text, e.g. by calling one of
   1.125 +     * the fillText Methods.
   1.126       *
   1.127       * @param font
   1.128       */