Module javafx.graphics
Package javafx.scene.layout

Class BorderStrokeStyle


  • public final class BorderStrokeStyle
extends Object
    Defines the style of the stroke to use on one side of a BorderStroke. There are several predefined styles, although the properties of these predefined styles may not match the settings used to ultimately draw them. Or you may create a new BorderStrokeStyle and define each of the stroke settings manually, similar to any Shape.
    Since:
    JavaFX 8.0

    • Field Detail

      • NONE

        public static final BorderStrokeStyle NONE
        Indicates that no stroke should be drawn.

      • DOTTED

        public static final BorderStrokeStyle DOTTED
        A predefined dotted pattern to be used for stroking

      • DASHED

        public static final BorderStrokeStyle DASHED
        A predefined dashed pattern to be used for stroking

      • SOLID

        public static final BorderStrokeStyle SOLID
        A predefined solid line to be used for stroking

    • Constructor Detail

      • BorderStrokeStyle

        public BorderStrokeStyle​(StrokeType type,
                         StrokeLineJoin lineJoin,
                         StrokeLineCap lineCap,
                         double miterLimit,
                         double dashOffset,
                         List<Double> dashArray)
        Creates a new BorderStrokeStyle.
        Parameters:
        type - The type of stroke, whether rendered OUTSIDE, INSIDE, or CENTERED on the border line. If null, defaults to CENTERED.
        lineJoin - The line join. If null, defaults to MITER
        lineCap - The line cap. If null, defaults to BUTT.
        miterLimit - The miter limit. 10 is a good default value.
        dashOffset - The dashOffset. 0 is a good default value.
        dashArray - The dash array. If null, defaults to an empty list.

    • Method Detail

      • getType

        public final StrokeType getType​()
        Defines the direction (inside, outside, or both) that the strokeWidth is applied to the boundary of the shape.
        Default value:
        CENTERED
        Returns:
        the the direction that the strokeWidth is applied to the boundary of the shape

      • getLineJoin

        public final StrokeLineJoin getLineJoin​()
        Defines the decoration applied where path segments meet. The value must have one of the following values: StrokeLineJoin.BEVEL, StrokeLineJoin.MITER, and StrokeLineJoin.ROUND.
        Default value:
        MITER
        Returns:
        the decoration applied where path segments meet

      • getLineCap

        public final StrokeLineCap getLineCap​()
        The end cap style of this Shape as one of the following values that define possible end cap styles: StrokeLineCap.BUTT, StrokeLineCap.ROUND, and StrokeLineCap.SQUARE.
        Default value:
        SQUARE
        Returns:
        the end cap style

      • getMiterLimit

        public final double getMiterLimit​()
        Defines the limit for the StrokeLineJoin.MITER line join style.
        Default value:
        10
        Returns:
        the limit for the StrokeLineJoin.MITER line join style

      • getDashOffset

        public final double getDashOffset​()
        Defines a distance specified in user coordinates that represents an offset into the dashing pattern. In other words, the dash phase defines the point in the dashing pattern that will correspond to the beginning of the stroke.
        Default value:
        0
        Returns:
        the offset into the dashing pattern

      • getDashArray

        public final List<Double> getDashArray​()
        Defines the array representing the lengths of the dash segments. Alternate entries in the array represent the user space lengths of the opaque and transparent segments of the dashes. As the pen moves along the outline of the Shape to be stroked, the user space distance that the pen travels is accumulated. The distance value is used to index into the dash array. The pen is opaque when its current cumulative distance maps to an even element of the dash array and transparent otherwise. An empty dashArray indicates a solid line with no spaces.
        Default value:
        empty
        Returns:
        the array representing the lengths of the dash segments

      • toString

        public String toString​()
        Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

        The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: 

         getClass().getName() + '@' + Integer.toHexString(hashCode())
        Overrides:
        toString in class Object
        Returns:
        a string representation of the object.

      • equals

        public boolean equals​(Object o)
        Indicates whether some other object is "equal to" this one.

        The equals method implements an equivalence relation on non-null object references:

        • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
        • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
        • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
        • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
        • For any non-null reference value x, x.equals(null) should return false.

        The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

        Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

        Overrides:
        equals in class Object
        Parameters:
        o - the reference object with which to compare.
        Returns:
        true if this object is the same as the obj argument; false otherwise.
        See Also:
        Object.hashCode(), HashMap

      • hashCode

        public int hashCode​()
        Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

        The general contract of hashCode is:

        • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
        • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
        • It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

        As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)

        Overrides:
        hashCode in class Object
        Returns:
        a hash code value for this object.
        See Also:
        Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)