Package com.iizix.prop

Class GStroke

java.lang.Object
com.iizix.prop.GStroke
All Implemented Interfaces:
Cloneable
public class GStroke extends Object implements Cloneable
A stroke defines stylistic properties that are used when drawing a path.
Author:
Christopher Mindus

  • Field Details

    • DEFAULT

      public static final GStroke DEFAULT
      The default stroke: "butt" with "miter" join, black color, solid and width of 1, with a miter limit of 4.

    • cap

      public final GStroke.Cap cap
      The cap.

    • join

      public final GStroke.Join join
      The join.

    • miterLimit

      public final float miterLimit
      The miter limit (1 or larger), only applies for "miter" joins.

    • style

      public final GStroke.Style style
      The style.

    • color

      public final GColor color
      The color.

    • width

      public final float width
      The width.

  • Constructor Details

    • GStroke

      public GStroke(GStroke.Cap cap, GStroke.Join join, float miterLimit, float width, GStroke.Style style, GColor color)
      Creates an new stroke.
      Parameters:
      cap - The cap.
      join - The join.
      miterLimit - The miter limit, only used when join is "miter".
      width - The width.
      style - The style.
      color - The color.
      Throws:
      NullPointerException - If cap, join, style or color is null.
      IllegalArgumentException - If the width is zero or smaller.

  • Method Details

    • getStroke

      public BasicStroke getStroke()
      Gets the AWT stroke of dash phase zero.
      Returns:
      A new BasicStroke initialized from this GStroke.

    • equals

      public boolean equals(Object o)
      Checks if two strokes objects are equal.
      Overrides:
      equals in class Object

    • equals

      public boolean equals(GStroke stroke)
      Checks if two strokes objects are equal.
      Parameters:
      stroke - another strokes object. If null, the strokes are not equal.
      Returns:
      true if equal, false otherwise.

    • getString

      public String getString()
      Gets the stroke as a String in the form described below.
      Returns:
      the String as described above.

    • toString

      public String toString()
      Returns a string representation of this class instance and its values.
      Overrides:
      toString in class Object
      Returns:
      a string representation of this class instance.