Arrow (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.graph.styles.Arrow

All Implemented Interfaces:

IArrow, ICloneable, Cloneable
```
public final class Arrow
extends Object
implements IArrow, ICloneable, Cloneable
```
A default implementation of the IArrow interface that can render ArrowTypes.

Field Summary
- Fields inherited from interface com.yworks.yfiles.graph.styles.IArrow
  CIRCLE, CROSS, DEFAULT, DIAMOND, NONE, SHORT, SIMPLE, TRIANGLE

Constructor Summary

Constructors
Constructor and Description
`Arrow()` Creates a new arrow with default values for `Pen` and brush.
`Arrow(ArrowType arrowType)` Creates a new arrow with the given arrow type and default values for the other properties.
`Arrow(ArrowType arrowType, Color color)` Creates a new arrow with the given color to use for pen and brush, the given arrow type and default values for the other properties.
`Arrow(ArrowType arrowType, Color color, double cropLength, double scale)` Creates a new arrow with the given color to use for pen and brush, the given arrow type and the given values for the crop length and scale.
`Arrow(ArrowType arrowType, Pen pen, Paint paint)` Creates a new arrow with the given pen and brush, the given arrow type and default values for the other properties.
`Arrow(ArrowType arrowType, Pen pen, Paint paint, double cropLength, double scale)` Creates a new arrow with the given color to use for pen and brush, the given arrow type and the given values for the croplength and scale.
`Arrow(Color color)` Creates a new arrow with the given color to use for `Pen` and brush.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Arrow`	`clone()` Creates a copy of this object and returns it.
`boolean`	`equals(Arrow other)` Determines whether this arrow is equal to the other arrow.
`boolean`	`equals(Object other)`
`IArrow`	`getAsFrozen()` Returns an immutable `IArrow` instance that uses the current properties.
`IBoundsProvider`	`getBoundsProvider(IEdge edge, boolean atSource, PointD anchor, PointD directionVector)` Gets an `IBoundsProvider` implementation that can yield this arrow's bounds if painted at the given location using the given direction for the given edge.
`double`	`getCropLength()` Gets the cropping length associated with this instance.
`double`	`getLength()` Returns the length of the arrow (the distance from the arrow's tip to the position where the visual representation of the edge's path should begin).
`Paint`	`getPaint()` Gets the `Paint` of the fill of this arrow.
`Pen`	`getPen()` Gets the `Pen` of the outline of this arrow.
`double`	`getScale()` Gets the scale factor of this arrow.
`ArrowType`	`getType()` Gets the type of this arrow.
`IVisualCreator`	`getVisualCreator(IEdge edge, boolean atSource, PointD anchor, PointD direction)` Gets an `IVisualCreator` implementation that will paint this arrow at the given location using the given direction for the given edge.
`int`	`hashCode()`
`void`	`setCropLength(double value)` Sets the cropping length associated with this instance.
`void`	`setPaint(Paint value)` Sets the `Paint` of the fill of this arrow.
`void`	`setPen(Pen value)` Sets the `Pen` of the outline of this arrow.
`void`	`setScale(double value)` Sets the scale factor of this arrow.
`void`	`setType(ArrowType value)` Sets the type of this arrow.
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Arrow
```
public Arrow()
```
    Creates a new arrow with default values for Pen and brush.
  - Arrow
```
public Arrow(ArrowType arrowType)
```
    Creates a new arrow with the given arrow type and default values for the other properties.
    
    Parameters:
    
    arrowType - The ArrowType of the arrow.
  - Arrow
```
public Arrow(ArrowType arrowType,
             Color color)
```
    Creates a new arrow with the given color to use for pen and brush, the given arrow type and default values for the other properties. The pen is created with thickness 1.
    
    Parameters:
    
    arrowType - The ArrowType of the arrow.
    
    color - The color to use for pen and brush.
  - Arrow
```
public Arrow(ArrowType arrowType,
             Color color,
             double cropLength,
             double scale)
```
    Creates a new arrow with the given color to use for pen and brush, the given arrow type and the given values for the crop length and scale. The pen is created with thickness 1.
    
    Parameters:
    
    arrowType - The ArrowType of the arrow.
    
    color - The color to use for pen and brush.
    
    cropLength - The cropping length associated with this instance.
    
    scale - The scale factor of this arrow.
  - Arrow
```
public Arrow(ArrowType arrowType,
             Pen pen,
             Paint paint)
```
    Creates a new arrow with the given pen and brush, the given arrow type and default values for the other properties. The pen is created with thickness 1.
    
    Parameters:
    
    arrowType - The ArrowType of the arrow.
    
    pen - The pen of the outline of this arrow.
    
    paint - The paint of the fill of this arrow.
  - Arrow
```
public Arrow(ArrowType arrowType,
             Pen pen,
             Paint paint,
             double cropLength,
             double scale)
```
    Creates a new arrow with the given color to use for pen and brush, the given arrow type and the given values for the croplength and scale. The pen is created with thickness 1.
    
    Parameters:
    
    arrowType - The ArrowType of the arrow.
    
    pen - The pen of the outline of this arrow.
    
    paint - The paint of the fill of this arrow.
    
    cropLength - The cropping length associated with this instance.
    
    scale - The scale factor of this arrow.
  - Arrow
```
public Arrow(Color color)
```
    Creates a new arrow with the given color to use for Pen and brush.
    The Pen is created with thickness 1.
    
    Parameters:
    
    color - The color to use for Pen and brush.
- Method Detail
  - clone
```
public final Arrow clone()
```
    Description copied from interface: ICloneable
    
    Creates a copy of this object and returns it.
    
    Specified by:
    
    clone in interface ICloneable
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    A copy of this object.
    
    See Also:
    
    Object.clone()
  - equals
```
public final boolean equals(Arrow other)
```
    Determines whether this arrow is equal to the other arrow.
    
    Parameters:
    
    other - The other.
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - getAsFrozen
```
public final IArrow getAsFrozen()
```
    Returns an immutable IArrow instance that uses the current properties.
    
    Returns:
    
    An immutable instance
  - getBoundsProvider
```
public final IBoundsProvider getBoundsProvider(IEdge edge,
                                               boolean atSource,
                                               PointD anchor,
                                               PointD directionVector)
```
    Description copied from interface: IArrow
    
    Gets an IBoundsProvider implementation that can yield this arrow's bounds if painted at the given location using the given direction for the given edge.
    
    Specified by:
    
    getBoundsProvider in interface IArrow
    
    Parameters:
    
    edge - the edge this arrow belongs to
    
    atSource - whether this will be the source arrow
    
    anchor - the anchor point for the tip of the arrow
    
    directionVector - the direction the arrow is pointing in
    
    Returns:
    
    an implementation of the IBoundsProvider interface that can subsequently be used to query the bounds. Clients will always call this method before using the implementation and may not cache the instance returned. This allows for applying the flyweight design pattern to implementations.
  - getCropLength
```
public final double getCropLength()
```
    Gets the cropping length associated with this instance.
    This value is used by IEdgeStyle implementations to let the edge appear to end shortly before its actual target.
    
    Specified by:
    
    getCropLength in interface IArrow
    
    Returns:
    
    The CropLength.
    
    See Also:
    
    setCropLength(double)
  - getLength
```
public final double getLength()
```
    Description copied from interface: IArrow
    
    Returns the length of the arrow (the distance from the arrow's tip to the position where the visual representation of the edge's path should begin).
    
    Specified by:
    
    getLength in interface IArrow
    
    Returns:
    
    The Length.
  - getPaint
```
public final Paint getPaint()
```
    Gets the Paint of the fill of this arrow.
    
    Returns:
    
    The brush.
    
    See Also:
    
    setPaint(Paint)
  - getPen
```
public final Pen getPen()
```
    Gets the Pen of the outline of this arrow.
    
    Returns:
    
    The Pen of this arrow.
    
    See Also:
    
    setPen(Pen)
  - getScale
```
public final double getScale()
```
    Gets the scale factor of this arrow.
    The arrow bounds are scaled with this factor.
    
    Returns:
    
    The scale factor of this arrow.
    
    See Also:
    
    setScale(double)
  - getType
```
public final ArrowType getType()
```
    Gets the type of this arrow.
    
    Returns:
    
    The type of this arrow.
    
    See Also:
    
    setType(ArrowType)
  - getVisualCreator
```
public final IVisualCreator getVisualCreator(IEdge edge,
                                             boolean atSource,
                                             PointD anchor,
                                             PointD direction)
```
    Description copied from interface: IArrow
    
    Gets an IVisualCreator implementation that will paint this arrow at the given location using the given direction for the given edge.
    
    Specified by:
    
    getVisualCreator in interface IArrow
    
    Parameters:
    
    edge - the edge this arrow belongs to
    
    atSource - whether this will be the source arrow
    
    anchor - the anchor point for the tip of the arrow
    
    direction - the direction the arrow is pointing in
    
    Returns:
    
    an implementation of the IVisualCreator interface that can subsequently be used to perform the actual painting. Clients will always call this method before using the implementation and may not cache the instance returned. This allows for applying the flyweight design pattern to implementations.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - setCropLength
```
public final void setCropLength(double value)
```
    Sets the cropping length associated with this instance.
    This value is used by IEdgeStyle implementations to let the edge appear to end shortly before its actual target.
    
    See Also:
    
    getCropLength()
  - setPaint
```
public final void setPaint(Paint value)
```
    Sets the Paint of the fill of this arrow.
    
    Parameters:
    
    value - The brush.
    
    See Also:
    
    getPaint()
  - setPen
```
public final void setPen(Pen value)
```
    Sets the Pen of the outline of this arrow.
    
    Parameters:
    
    value - The Pen of this arrow.
    
    See Also:
    
    getPen()
  - setScale
```
public final void setScale(double value)
```
    Sets the scale factor of this arrow.
    The arrow bounds are scaled with this factor.
    
    Parameters:
    
    value - The scale factor of this arrow.
    
    See Also:
    
    getScale()
  - setType
```
public final void setType(ArrowType value)
```
    Sets the type of this arrow.
    
    Parameters:
    
    value - The type of this arrow.
    
    See Also:
    
    getType()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Arrow

Field Summary

Fields inherited from interface com.yworks.yfiles.graph.styles.IArrow

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Arrow

Arrow

Arrow

Arrow

Arrow

Arrow

Arrow

Method Detail

clone

equals

equals

getAsFrozen

getBoundsProvider

getCropLength

getLength

getPaint

getPen

getScale

getType

getVisualCreator

hashCode

setCropLength

setPaint

setPen

setScale

setType

toString