View Javadoc
1   /*
2    * Copyright (c) 2002-2025 Gargoyle Software Inc.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * https://www.apache.org/licenses/LICENSE-2.0
8    *
9    * Unless required by applicable law or agreed to in writing, software
10   * distributed under the License is distributed on an "AS IS" BASIS,
11   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12   * See the License for the specific language governing permissions and
13   * limitations under the License.
14   */
15  package org.htmlunit.javascript.host.canvas;
16  
17  import org.htmlunit.javascript.HtmlUnitScriptable;
18  import org.htmlunit.javascript.configuration.JsxClass;
19  import org.htmlunit.javascript.configuration.JsxConstructor;
20  import org.htmlunit.javascript.configuration.JsxFunction;
21  
22  /**
23   * A JavaScript object for {@code CanvasGradient}.
24   *
25   * @author Ahmed Ashour
26   * @author Ronald Brill
27   */
28  @JsxClass
29  public class CanvasGradient extends HtmlUnitScriptable {
30  
31      /**
32       * JavaScript constructor.
33       */
34      @JsxConstructor
35      public void jsConstructor() {
36          // nothing to do
37      }
38  
39      /**
40       * Adds a new stop, defined by an offset and a color, to the gradient.
41       * @param offset A number between 0 and 1. An INDEX_SIZE_ERR is raised,
42       *        if the number is not in that range.
43       * @param color A CSS color. A SYNTAX_ERR is raised, if the value
44       *        can not be parsed as a CSS color value.
45       */
46      @JsxFunction
47      public void addColorStop(final double offset, final String color) {
48          // empty
49      }
50  }