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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    GStroke.Cap
    Specifies the shape to be used at the end of open subpaths when they are stroked.
    static enum 
    GStroke.Join
    Specifies the shape to be used at the corners of paths or basic shapes when they are stroked.
    static enum 
    GStroke.Style
    Line style.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final GStroke.Cap
    cap
    The cap.
    final GColor
    color
    The color.
    static final GStroke
    DEFAULT
    The default stroke: "butt" with "miter" join, black color, solid and width of 1, with a miter limit of 4.
    final GStroke.Join
    join
    The join.
    final float
    miterLimit
    The miter limit (1 or larger), only applies for "miter" joins.
    final GStroke.Style
    style
    The style.
    final float
    width
    The width.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GStroke(GStroke.Cap cap, GStroke.Join join, float miterLimit, float width, GStroke.Style style, GColor color)
    Creates an new stroke.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(GStroke stroke)
    Checks if two strokes objects are equal.
    boolean
    equals(Object o)
    Checks if two strokes objects are equal.
    String
    getString()
    Gets the stroke as a String in the form described below.
    BasicStroke
    getStroke()
    Gets the AWT stroke of dash phase zero.
    int
    hashCode()
    Gets the hash code of this instance, consistent with equals: cap, join, style, width, the miter limit only when the join is GStroke.Join.MITER, and the color.
    String
    toString()
    Returns a string representation of this class instance and its values.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • 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 miterLimit is NaN or below 1 when join is "miter", or if width is NaN, 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.

    • hashCode

      public int hashCode()
      Gets the hash code of this instance, consistent with equals: cap, join, style, width, the miter limit only when the join is GStroke.Join.MITER, and the color.
      Overrides:
      hashCode in class Object
      Returns:
      The hash code.

    • 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.