Chart FX for Java 6.2

SoftwareFX.ChartFX.Annotation
Class AnnotationArc

java.lang.Object
  extended bySoftwareFX.ChartFX.Annotation.AnnotationObject
      extended bySoftwareFX.ChartFX.Annotation.AnnotationArc

public final class AnnotationArc
extends AnnotationObject

Provides access to the AnnotationArc object.

The AnnotationArc class allows you to create annotation objects in the shape of an arc. All the supported members of this class are inherited from the AnnotationObject class.

Below is an example of an annotation arc:

SoftwareFX.ChartFX.Annotation.AnnotationX annot = new SoftwareFX.ChartFX.Annotation.AnnotationX();
SoftwareFX.ChartFX.Annotation.AnnotationArc arc = new SoftwareFX.ChartFX.Annotation.AnnotationArc();
arc.getBorder().setColor(java.awt.Color.RED);
arc.getBorder().setWidth(4);
arc.setHeight(100);
arc.setWidth(-80);
arc.attach(2, 50);
annot.getList().add(arc);
chart1.getExtensions().add(annot);

Note: Remember you can assign negative values to both the Width and Height properties. This will allow you to set the appropriate orientation to the arcs you create in the chart area.


Constructor Summary
AnnotationArc()
           
 
Method Summary
 void attach(double dx, double dy)
          Attaches the annotation object to the chart relative to X and Y Axis values.
 void attach(double dxLeft, double dyTop, double dxRight, double dyBottom)
          Attaches the annotation object to the chart relative to X and Y Axis values.
 void attach(int horizontalAlignment, double dx, int verticalAlignment, double dy)
          Attaches the annotation object to the chart relative to X and Y Axis values.
 void detach()
          Detaches the selected annotation object from the chart.
 void flip(boolean horizontal)
          Allows you to flip an object horizontally or vertically.
 int getAnchor()
          Gets or sets the Anchor style for the AnnotationObject.
 Line getBorder()
          Allows you to apply border attributes to a selected annotation object.
 java.awt.Color getColor()
          Sets the inside fill color for annotation object.
 int getHeight()
          Gets or Sets the height in pixels for the selected annotation object.
 int getLeft()
          Allows you to specify or read the left position of a selected annotation object.
 Link getLink()
          Gets the Link object for a selected AnnotationObject item.
 java.awt.Rectangle getObjectBounds()
          Allows you to specify the bounds for a selected annotation object.
 int getPattern()
          Allows you to set a pattern for the selected annotation object.
 java.lang.Object getTag()
          Allows you to get or set a unique identifier to the objects you have created in the chart area.
 int getTop()
          Allows you to specify or read the top position of a selected annotation object.
 java.lang.String getURL()
          Deprecated. You should use AnnotationArc.getLink().getUrl instead.
 java.lang.String getURLTarget()
          Deprecated. You should use AnnotationArc.getLink().getTarget instead.
 int getWidth()
          Gets or Sets the Width in pixels for the selected annotation object.
 boolean isAllowModify()
          Used to allow or prevent the user from changing object attributes from the User Interface.
 boolean isAllowMove()
          Used to allow or prevent the user from moving an annotation object in the chart area.
 boolean isDrawingArea()
          Allows the AnnotationObject margins to go outside of the chart's drawing area.
 boolean isPaintBefore()
          Configures the selected annotation object to paint before the rest of the chart elements.
 boolean isVisible()
          Used to show or hide a selected annotation object in the chart area.
 void refresh()
          Instructs Chart FX to repaint the selected annotation object.
 void rotate(boolean clockWise)
          Allows you to rotate an object 90 degrees clockwise or counterclockwise.
 void setAllowModify(boolean value)
          Used to allow or prevent the user from changing object attributes from the User Interface.
 void setAllowMove(boolean value)
          Used to allow or prevent the user from moving an annotation object in the chart area.
 void setAnchor(int value)
          Gets or sets the Anchor style for the AnnotationObject.
 void setBorder(Line value)
          Allows you to apply border attributes to a selected annotation object.
 void setColor(java.awt.Color value)
          Sets the inside fill color for annotation object.
 void setDrawingArea(boolean value)
          Allows the AnnotationObject margins to go outside of the chart's drawing area.
 void setHeight(int value)
          Gets or Sets the height in pixels for the selected annotation object.
 void setLeft(int value)
          Allows you to specify or read the left position of a selected annotation object.
 void setObjectBounds(java.awt.Rectangle value)
          Allows you to specify the bounds for a selected annotation object.
 void setPaintBefore(boolean value)
          Configures the selected annotation object to paint before the rest of the chart elements.
 void setPattern(int value)
          Allows you to set a pattern for the selected annotation object.
 void setTag(java.lang.Object value)
          Allows you to get or set a unique identifier to the objects you have created in the chart area.
 void setTop(int value)
          Allows you to specify or read the top position of a selected annotation object.
 void setURL(java.lang.String value)
          Deprecated. You should use AnnotationArc.getLink().setUrl instead.
 void setURLTarget(java.lang.String value)
          Deprecated. You should use AnnotationArc.getLink().setTarget instead.
 void setVisible(boolean value)
          Used to show or hide a selected annotation object in the chart area.
 void setWidth(int value)
          Gets or Sets the Width in pixels for the selected annotation object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AnnotationArc

public AnnotationArc()
Method Detail

attach

public void attach(int horizontalAlignment,
                   double dx,
                   int verticalAlignment,
                   double dy)

Attaches the annotation object to the chart relative to X and Y Axis values.

Remarks:
  • This property supports two configurations. By specifying 2 parameters (dx, dy), the annotation object will attached to the chart at the center of the object. By specifying 4 parameters (dxLeft, dyTop, dxRight, dyBottom), the annotation object will be attached to the chart by the corners of the annotation objects. The second configuration allows for the resizing of the annotation object with the chart area.

  • You can also specify the pixel location of the annotation object using the AnnotationObject.setHeight(int) and AnnotationObject.setWidth(int) properties.

  • The AnnotationObject.attach(int, double, int, double)Attach method may NOT be used when positioning the AnnotationPolygon object. The AnnotationPolygon is the only annotation object that does not support the Attach method. Please use the AnnotationPolygon.setVertices(java.awt.Point[]) property.

  • Overrides:
    attach in class AnnotationObject
    Parameters:
    dx - X Axis coordinate value.
    dy - Y Axis coordinate value.
    horizontalAlignment - Horizontal string alignment.
    verticalAlignment - Vertical string alignment.
    See Also:
    AnnotationObject.setHeight(int), AnnotationObject.setWidth(int), AnnotationPolygon.setVertices(java.awt.Point[]), AnnotationPolygon

    attach

    public void attach(double dx,
                       double dy)

    Attaches the annotation object to the chart relative to X and Y Axis values.

    Remarks:
  • This property supports two configurations. By specifying 2 parameters (dx, dy), the annotation object will attached to the chart at the center of the object. By specifying 4 parameters (dxLeft, dyTop, dxRight, dyBottom), the annotation object will be attached to the chart by the corners of the annotation objects. The second configuration allows for the resizing of the annotation object with the chart area.

  • You can also specify the pixel location of the annotation object using the AnnotationObject.setHeight(int) and AnnotationObject.setWidth(int) properties.

  • The AnnotationObject.attach(int, double, int, double)Attach method may NOT be used when positioning the AnnotationPolygon object. The AnnotationPolygon is the only annotation object that does not support the Attach method. Please use the AnnotationPolygon.setVertices(java.awt.Point[]) property.

  • Overrides:
    attach in class AnnotationObject
    Parameters:
    dx - X Axis coordinate value.
    dy - Y Axis coordinate value.
    See Also:
    AnnotationObject.setHeight(int), AnnotationObject.setWidth(int), AnnotationPolygon.setVertices(java.awt.Point[]), AnnotationPolygon

    attach

    public void attach(double dxLeft,
                       double dyTop,
                       double dxRight,
                       double dyBottom)

    Attaches the annotation object to the chart relative to X and Y Axis values.

    Remarks:
  • This property supports two configurations. By specifying 2 parameters (dx, dy), the annotation object will attached to the chart at the center of the object. By specifying 4 parameters (dxLeft, dyTop, dxRight, dyBottom), the annotation object will be attached to the chart by the corners of the annotation objects. The second configuration allows for the resizing of the annotation object with the chart area.

  • You can also specify the pixel location of the annotation object using the AnnotationObject.setHeight(int) and AnnotationObject.setWidth(int) properties.

  • The AnnotationObject.attach(int, double, int, double)Attach method may NOT be used when positioning the AnnotationPolygon object. The AnnotationPolygon is the only annotation object that does not support the Attach method. Please use the AnnotationPolygon.setVertices(java.awt.Point[]) property.

  • Overrides:
    attach in class AnnotationObject
    Parameters:
    dxLeft - Left X Axis coordinate value.
    dyTop - Top Y Axis coordinate value.
    dxRight - Right X Axis coordinate value.
    dyBottom - Bottom Y Axis coordinate value.
    See Also:
    AnnotationObject.setHeight(int), AnnotationObject.setWidth(int), AnnotationPolygon.setVertices(java.awt.Point[]), AnnotationPolygon

    detach

    public void detach()

    Detaches the selected annotation object from the chart.

    Remarks:
  • By default, all annotation objects are detached from the chart. When you call the AnnotationObject.attach(int, double, int, double) method for a particular object, that object is attached to the chart. Once you refresh the chart, the object will appear in the configured attached location. Call this method after an object has been attached to detach the object.

  • Overrides:
    detach in class AnnotationObject
    See Also:
    AnnotationObject.attach(int, double, int, double)

    flip

    public void flip(boolean horizontal)

    Allows you to flip an object horizontally or vertically.

    Remarks:
  • True: Flips annotation object horizontally, False: Flips annotation object vertically.

  • Annotation objects can also be rotated with the AnnotationObject.rotate(boolean) method.

  • Overrides:
    flip in class AnnotationObject
    Parameters:
    horizontal - Specifies horizontal or vertical flip.
    See Also:
    AnnotationObject.rotate(boolean)

    getAnchor

    public int getAnchor()

    Gets or sets the Anchor style for the AnnotationObject.

    Values:
    AnchorStyles : Specifies how an object anchors to the edges of its container.
    ValueDescription
    BOTTOMThe object is anchored to the bottom edge of its container.
    LEFTThe object is anchored to the left edge of its container.
    NONEThe object is not anchored to any edges of its container.
    RIGHTThe object is anchored to the right edge of its container.
    TOPThe object is anchored to the top edge of its container.

    Remarks:
  • This property is used to set the AnchorStyle for selected annotation object.

  • Be sure to configure a AnnotationObject.setHeight(int) and AnnotationObject.setWidth(int) for the annotation objects in the chart, otherwise, they will not be visible.

  • Overrides:
    getAnchor in class AnnotationObject
    See Also:
    AnnotationObject.setHeight(int), AnnotationObject.setWidth(int)

    getBorder

    public Line getBorder()

    Allows you to apply border attributes to a selected annotation object.

    Remarks:
  • This property provides access to the supported members of the Line class. Using the supported members you can modify the Line.setColor(java.awt.Color), Line.setStyle(int), Line.setWidth(int), Line.setEndCap(int) and Line.setStartCap(int) of selected line annotation objects.

  • Overrides:
    getBorder in class AnnotationObject
    See Also:
    Line.setColor(java.awt.Color), Line.setStyle(int), Line.setWidth(int), Line.setEndCap(int), Line.setStartCap(int), Line

    getColor

    public java.awt.Color getColor()

    Sets the inside fill color for annotation object.

    Remarks:
  • When working with Arrow annotation objects, this property controls the color of the arrow head and tail. The Line.setColor(java.awt.Color) property of the Line class is used in conjunction with the AnnotationObject.setBorder(SoftwareFX.ChartFX.Annotation.Line) property to modify the line color of the arrow.

  • For more information regarding the Color type, please refer to the Java API Documentation.

  • Overrides:
    getColor in class AnnotationObject
    See Also:
    Line.setColor(java.awt.Color), Line

    getHeight

    public int getHeight()

    Gets or Sets the height in pixels for the selected annotation object.

    Remarks:
  • Important note: It is very important to set the Height and AnnotationObject.setWidth(int) for every annotation object created in a chart. The default height and width are zero(0), so if you do not set the these attributes the annotation object will not appear in the chart area. (The AnnotationObject.attach(int, double, int, double) method can be used instead of setting these properties, see next remark.)

  • When you call the AnnotationObject.attach(int, double, int, double) method using the left, top, right and bottom parameters, both the Height and Width for the object is calculated by Chart FX. If you only specify a dx and dy parameter, you will still need to configure the height and width.

  • With this property you can also control the orientation of certain objects (e.g. Arrows). For example assigning a positive height will cause the arrow to point down (X-axis). Similarly, assigning a negative value for the width will cause the arrow to point up (Toolbar). You must then use the Width property to point the line or arrow correctly.

  • Overrides:
    getHeight in class AnnotationObject
    See Also:
    AnnotationObject.setWidth(int), AnnotationObject.attach(int, double, int, double)

    getLeft

    public int getLeft()

    Allows you to specify or read the left position of a selected annotation object.

    Remarks:
  • This property should be used in conjunction with the AnnotationObject.setTop(int) property to position the object in the chart area. Both the AnnotationObject.setTop(int) and Left properties support pixel unit configuration.

  • The Chart Origin, coordinates (0,0), is always located at the top-left corner of the chart area.

  • The AnnotationObject.attach(int, double, int, double) method may also be used to attach an annotation object to a chart based on X and Y Axis values.

  • Overrides:
    getLeft in class AnnotationObject
    See Also:
    AnnotationObject.setTop(int), AnnotationObject.attach(int, double, int, double)

    getLink

    public Link getLink()

    Gets the Link object for a selected AnnotationObject item.

    Remarks:
  • Developers may obtain the Link object for an annotation item using this property. Using the supported Link class members, developers may configure a Link.setUrl(java.lang.String) and Link.setTarget(java.lang.String) for the object.

  • Overrides:
    getLink in class AnnotationObject
    See Also:
    Link.setUrl(java.lang.String), Link.setTarget(java.lang.String), Link

    getObjectBounds

    public java.awt.Rectangle getObjectBounds()

    Allows you to specify the bounds for a selected annotation object.

    Remarks:
  • This property accepts a rectangle type object which you may create with your custom dimensions.

  • Overrides:
    getObjectBounds in class AnnotationObject
    See Also:
    AnnotationObject.attach(int, double, int, double)

    getPattern

    public int getPattern()

    Allows you to set a pattern for the selected annotation object.

    Values:
    HatchStyle : Specifies the different hatch patterns available.
    ValueDescription
    BACKWARD_DIAGONALA pattern of lines on a diagonal from upper right to lower left.
    CROSSSpecifies horizontal and vertical lines that cross.
    DARK_DOWNWARD_DIAGONALSpecifies diagonal lines that slant to the right from top points to bottom points, are spaced 50 percent closer together than, and are twice the width of ForwardDiagonal. This hatch pattern is not antialiased.
    DARK_HORIZONTALSpecifies horizontal lines that are spaced 50 percent closer together than Horizontal and are twice the width of HatchStyleHorizontal.
    DARK_UPWARD_DIAGONALSpecifies diagonal lines that slant to the left from top points to bottom points, are spaced 50 percent closer together than BackwardDiagonal, and are twice its width, but the lines are not antialiased.
    DARK_VERTICALSpecifies vertical lines that are spaced 50 percent closer together than Vertical and are twice its width.
    DASHED_DOWNWARD_DIAGONALSpecifies dashed diagonal lines, that slant to the right from top points to bottom points.
    DASHED_HORIZONTALSpecifies dashed horizontal lines.
    DASHED_UPWARD_DIAGONALSpecifies dashed diagonal lines, that slant to the left from top points to bottom points.
    DASHED_VERTICALSpecifies dashed vertical lines.
    DIAGONAL_BRICKSpecifies a hatch that has the appearance of layered bricks that slant to the left from top points to bottom points.
    DIAGONAL_CROSSSpecifies forward diagonal and backward diagonal lines that cross. The lines are antialiased.
    DIVOTSpecifies a hatch that has the appearance of divots.
    DOTTED_DIAMONDSpecifies forward diagonal and backward diagonal lines, each of which is composed of dots, that cross.
    DOTTED_GRIDSpecifies horizontal and vertical lines, each of which is composed of dots, that cross.
    FORWARD_DIAGONALA pattern of lines on a diagonal from upper left to lower right.
    HORIZONTALA pattern of horizontal lines.
    HORIZONTAL_BRICKSpecifies a hatch that has the appearance of horizontally layered bricks.
    LARGE_CHECKER_BOARDSpecifies a hatch that has the appearance of a checkerboard with squares that are twice the size of SmallCheckerBoard.
    LARGE_CONFETTISpecifies a hatch that has the appearance of confetti, and is composed of larger pieces than SmallConfetti.
    LARGE_GRIDSpecifies the hatch style Cross.
    LIGHT_DOWNWARD_DIAGONALSpecifies diagonal lines that slant to the right from top points to bottom points and are spaced 50 percent closer together than DownwardDiagonal, but they are not antialiased.
    LIGHT_HORIZONTALSpecifies horizontal lines that are spaced 50 percent closer together than Horizontal.
    LIGHT_UPWARD_DIAGONALSpecifies diagonal lines that slant to the left from top points to bottom points and are spaced 50 percent closer together than BackwardDiagonal, but they are not antialiased.
    LIGHT_VERTICALSpecifies vertical lines that are spaced 50 percent closer together than Vertical.
    MAXSpecifies hatch style SolidDiamond.
    MINSpecifies hatch style Horizonal.
    NARROW_HORIZONTALSpecifies horizontal lines that are spaced 75 percent closer together than hatch style Horizontal (or 25 percent closer together than LightHorizontal).
    NARROW_VERTICALSpecifies vertical lines that are spaced 75 percent closer together than hatch style Vertical (or 25 percent closer together than LightVertical).
    OUTLINED_DIAMONDSpecifies forward diagonal and backward diagonal lines that cross but are not antialiased.
    PERCENT_05Specifies a 5-percent hatch. The ratio of foreground color to background color is 5:100.
    PERCENT_10Specifies a 10-percent hatch. The ratio of foreground color to background color is 10:100.
    PERCENT_20Specifies a 20-percent hatch. The ratio of foreground color to background color is 20:100.
    PERCENT_25Specifies a 25-percent hatch. The ratio of foreground color to background color is 25:100.
    PERCENT_30Specifies a 30-percent hatch. The ratio of foreground color to background color is 30:100.
    PERCENT_40Specifies a 40-percent hatch. The ratio of foreground color to background color is 40:100.
    PERCENT_50Specifies a 50-percent hatch. The ratio of foreground color to background color is 50:100.
    PERCENT_60Specifies a 60-percent hatch. The ratio of foreground color to background color is 60:100.
    PERCENT_70Specifies a 70-percent hatch. The ratio of foreground color to background color is 70:100.
    PERCENT_75Specifies a 75-percent hatch. The ratio of foreground color to background color is 75:100.
    PERCENT_80Specifies a 80-percent hatch. The ratio of foreground color to background color is 80:100.
    PERCENT_90Specifies a 90-percent hatch. The ratio of foreground color to background color is 90:100.
    PLAIDSpecifies a hatch that has the appearance of a plaid material.
    SHINGLESpecifies a hatch that has the appearance of diagonally-layered shingles that slant to the right from top points to bottom points.
    SMALL_CHECKER_BOARDSpecifies a hatch that has the appearance of a checkerboard.
    SMALL_CONFETTISpecifies a hatch that has the appearance of confetti.
    SMALL_GRIDSpecifies horizontal and vertical lines that cross and are spaced 50 percent closer together than hatch style Cross.
    SOLID_DIAMONDSpecifies a hatch that has the appearance of a checkerboard placed diagonally.
    SPHERESpecifies a hatch that has the appearance of spheres laid adjacent to one another.
    TRELLISSpecifies a hatch that has the appearance of a trellis.
    VERTICALA pattern of vertical lines.
    WAVESpecifies horizontal lines that are composed of tildes.
    WEAVESpecifies a hatch that has the appearance of a woven material.
    WIDE_DOWNWARD_DIAGONALSpecifies diagonal lines that slant to the right from top points to bottom points, have the same spacing as hatch style ForwardDiagonal, and are triple its width, but are not antialiased.
    WIDE_UPWARD_DIAGONALSpecifies diagonal lines that slant to the left from top points to bottom points, have the same spacing as hatch style BackwardDiagonal, and are triple its width, but are not antialiased.
    ZIG_ZAGSpecifies horizontal lines that are composed of zigzags.

    Remarks:
  • This property exposes the supported pattern styles included in the HatchStyle type.

  • Overrides:
    getPattern in class AnnotationObject
    See Also:
    AnnotationObject.setColor(java.awt.Color), AnnotationObject.setHeight(int), AnnotationObject.setWidth(int), AnnotationObject.attach(int, double, int, double), AnnotationX

    getTag

    public java.lang.Object getTag()

    Allows you to get or set a unique identifier to the objects you have created in the chart area.

    Remarks:
  • This property is particularly useful when you go through the list of objects and you want each object to have a unique identifier.

  • The Tag value must be an integer.

  • Overrides:
    getTag in class AnnotationObject

    getTop

    public int getTop()

    Allows you to specify or read the top position of a selected annotation object.

    Remarks:
  • This property should be used in conjunction with the AnnotationObject.setLeft(int) property to position the object in the chart area. Both the Top and AnnotationObject.setLeft(int) properties support pixel unit configuration.

  • The Chart Origin, coordinates (0,0), is always located at the top-left corner of the chart area.

  • The AnnotationObject.attach(int, double, int, double) method may also be used to attach an annotation object to a chart based on X and Y Axis values.

  • Overrides:
    getTop in class AnnotationObject
    See Also:
    AnnotationObject.setLeft(int), AnnotationObject.attach(int, double, int, double)

    getURL

    public java.lang.String getURL()
    Deprecated. You should use AnnotationArc.getLink().getUrl instead.

    Overrides:
    getURL in class AnnotationObject
    See Also:
    getLink()

    getURLTarget

    public java.lang.String getURLTarget()
    Deprecated. You should use AnnotationArc.getLink().getTarget instead.

    Overrides:
    getURLTarget in class AnnotationObject
    See Also:
    getLink()

    getWidth

    public int getWidth()

    Gets or Sets the Width in pixels for the selected annotation object.

    Remarks:
  • Important note: It is very important to set the AnnotationObject.setHeight(int) and Width for every annotation object created in a chart. The default height and width are zero(0), so if you do not set the these attributes the annotation object will not appear in the chart area. (The AnnotationObject.attach(int, double, int, double) method can be used instead of setting these properties, see next remark.)

  • When you call the AnnotationObject.attach(int, double, int, double) method using the left, top, right and bottom parameters, both the Height and Width for the object is calculated by Chart FX. If you only specify a dx and dy parameter, you will still need to configure the height and width.

  • With this property you can also control the orientation of certain objects (e.g. Arrows). For example assigning a positive height will cause the arrow to point down (X-axis). Similarly, assigning a negative value for the width will cause the arrow to point up (Toolbar). You must then use the Width property to point the line or arrow correctly.

  • Overrides:
    getWidth in class AnnotationObject
    See Also:
    AnnotationObject.setHeight(int), AnnotationObject.attach(int, double, int, double)

    isAllowModify

    public boolean isAllowModify()

    Used to allow or prevent the user from changing object attributes from the User Interface.

    Remarks:
  • Whenever you add an annotation object in the chart area with the annotation list AnnotationX.setEnabled(boolean), the user may double-click the object and change its properties. Set this property to False if you do not want the end user to have access to the object's attributes.

  • In order for end users to interact with annotation objects created programmatically, you must set the AnnotationX.setEnabled(boolean) property for the annotation list object to True.

  • This property controls only visual attributes of the object. If you do not want the user to be able to move the object, please refer to the AnnotationObject.setAllowMove(boolean) property.

  • Overrides:
    isAllowModify in class AnnotationObject
    See Also:
    AnnotationObject.setAllowMove(boolean), AnnotationX.setEnabled(boolean), AnnotationX

    isAllowMove

    public boolean isAllowMove()

    Used to allow or prevent the user from moving an annotation object in the chart area.

    Remarks:
  • When an annotation object is added to a chart and the Annotation List has been AnnotationX.setEnabled(boolean), by default the user may click the object and change its position in the chart. If you are highlighting specific markers in the chart with an annotation object, you may want to prevent the user from moving the object to another position. Setting this property to False will prevent the end user from moving the object from its original position.

  • In order for end users to interact with annotation objects created programmatically, you must set the AnnotationX.setEnabled(boolean) property for the annotation list object to True.

  • This property controls only the object's position. If you want to prevent the user from changing additional object attributes, please refer to the AnnotationObject.setAllowModify(boolean) property.

  • Overrides:
    isAllowMove in class AnnotationObject
    See Also:
    AnnotationObject.setAllowModify(boolean), AnnotationX.setEnabled(boolean), AnnotationX

    isDrawingArea

    public boolean isDrawingArea()

    Allows the AnnotationObject margins to go outside of the chart's drawing area.

    Remarks:
  • When set to true, Annotation objects will not be displayed outside the chart's plot area. This includes the margins where axis labels are printed.

  • Overrides:
    isDrawingArea in class AnnotationObject
    See Also:
    LegendBoxBase

    isPaintBefore

    public boolean isPaintBefore()

    Configures the selected annotation object to paint before the rest of the chart elements.

    Remarks:
  • Setting this property to True will instruct Chart FX to paint the selected annotation object before other chart elements.

  • Overrides:
    isPaintBefore in class AnnotationObject
    See Also:
    AnnotationObject.refresh(), AnnotationObject

    isVisible

    public boolean isVisible()

    Used to show or hide a selected annotation object in the chart area.

    Remarks:
  • The AnnotationObject class members are accessible by all supported annotation objects, therefore this property may be used to hide any annotation object in the chart.

  • Overrides:
    isVisible in class AnnotationObject
    See Also:
    AnnotationObject.refresh(), Chart

    refresh

    public void refresh()

    Instructs Chart FX to repaint the selected annotation object.

    Remarks:
  • This method should be called after any visual attribute has been modified for the selected annotation object. If this method is not invoked, the change will not be visible.

  • Overrides:
    refresh in class AnnotationObject

    rotate

    public void rotate(boolean clockWise)

    Allows you to rotate an object 90 degrees clockwise or counterclockwise.

    Remarks:
  • The boolean parameter specifies the directional rotation of the selected annotation object. Setting the parameter to True will cause the object to rotate clockwise. Setting the parameter to False will cause the object to rotate counter clockwise.

  • Objects may only be rotated 90 degrees.

  • You may use the AnnotationObject.flip(boolean) method to flip objects horizontally and vertically.

  • Overrides:
    rotate in class AnnotationObject
    Parameters:
    clockWise - Boolean specifying rotation direction.
    See Also:
    AnnotationObject.flip(boolean)

    setAllowModify

    public void setAllowModify(boolean value)

    Used to allow or prevent the user from changing object attributes from the User Interface.

    Remarks:
  • Whenever you add an annotation object in the chart area with the annotation list AnnotationX.setEnabled(boolean), the user may double-click the object and change its properties. Set this property to False if you do not want the end user to have access to the object's attributes.

  • In order for end users to interact with annotation objects created programmatically, you must set the AnnotationX.setEnabled(boolean) property for the annotation list object to True.

  • This property controls only visual attributes of the object. If you do not want the user to be able to move the object, please refer to the AnnotationObject.setAllowMove(boolean) property.

  • Overrides:
    setAllowModify in class AnnotationObject
    See Also:
    AnnotationObject.setAllowMove(boolean), AnnotationX.setEnabled(boolean), AnnotationX

    setAllowMove

    public void setAllowMove(boolean value)

    Used to allow or prevent the user from moving an annotation object in the chart area.

    Remarks:
  • When an annotation object is added to a chart and the Annotation List has been AnnotationX.setEnabled(boolean), by default the user may click the object and change its position in the chart. If you are highlighting specific markers in the chart with an annotation object, you may want to prevent the user from moving the object to another position. Setting this property to False will prevent the end user from moving the object from its original position.

  • In order for end users to interact with annotation objects created programmatically, you must set the AnnotationX.setEnabled(boolean) property for the annotation list object to True.

  • This property controls only the object's position. If you want to prevent the user from changing additional object attributes, please refer to the AnnotationObject.setAllowModify(boolean) property.

  • Overrides:
    setAllowMove in class AnnotationObject
    See Also:
    AnnotationObject.setAllowModify(boolean), AnnotationX.setEnabled(boolean), AnnotationX

    setAnchor

    public void setAnchor(int value)

    Gets or sets the Anchor style for the AnnotationObject.

    Values:
    AnchorStyles : Specifies how an object anchors to the edges of its container.
    ValueDescription
    BOTTOMThe object is anchored to the bottom edge of its container.
    LEFTThe object is anchored to the left edge of its container.
    NONEThe object is not anchored to any edges of its container.
    RIGHTThe object is anchored to the right edge of its container.
    TOPThe object is anchored to the top edge of its container.

    Remarks:
  • This property is used to set the AnchorStyle for selected annotation object.

  • Be sure to configure a AnnotationObject.setHeight(int) and AnnotationObject.setWidth(int) for the annotation objects in the chart, otherwise, they will not be visible.

  • Overrides:
    setAnchor in class AnnotationObject
    See Also:
    AnnotationObject.setHeight(int), AnnotationObject.setWidth(int)

    setBorder

    public void setBorder(Line value)

    Allows you to apply border attributes to a selected annotation object.

    Remarks:
  • This property provides access to the supported members of the Line class. Using the supported members you can modify the Line.setColor(java.awt.Color), Line.setStyle(int), Line.setWidth(int), Line.setEndCap(int) and Line.setStartCap(int) of selected line annotation objects.

  • Overrides:
    setBorder in class AnnotationObject
    See Also:
    Line.setColor(java.awt.Color), Line.setStyle(int), Line.setWidth(int), Line.setEndCap(int), Line.setStartCap(int), Line

    setColor

    public void setColor(java.awt.Color value)

    Sets the inside fill color for annotation object.

    Remarks:
  • When working with Arrow annotation objects, this property controls the color of the arrow head and tail. The Line.setColor(java.awt.Color) property of the Line class is used in conjunction with the AnnotationObject.setBorder(SoftwareFX.ChartFX.Annotation.Line) property to modify the line color of the arrow.

  • For more information regarding the Color type, please refer to the Java API Documentation.

  • Overrides:
    setColor in class AnnotationObject
    See Also:
    Line.setColor(java.awt.Color), Line

    setDrawingArea

    public void setDrawingArea(boolean value)

    Allows the AnnotationObject margins to go outside of the chart's drawing area.

    Remarks:
  • When set to true, Annotation objects will not be displayed outside the chart's plot area. This includes the margins where axis labels are printed.

  • Overrides:
    setDrawingArea in class AnnotationObject
    See Also:
    LegendBoxBase

    setHeight

    public void setHeight(int value)

    Gets or Sets the height in pixels for the selected annotation object.

    Remarks:
  • Important note: It is very important to set the Height and AnnotationObject.setWidth(int) for every annotation object created in a chart. The default height and width are zero(0), so if you do not set the these attributes the annotation object will not appear in the chart area. (The AnnotationObject.attach(int, double, int, double) method can be used instead of setting these properties, see next remark.)

  • When you call the AnnotationObject.attach(int, double, int, double) method using the left, top, right and bottom parameters, both the Height and Width for the object is calculated by Chart FX. If you only specify a dx and dy parameter, you will still need to configure the height and width.

  • With this property you can also control the orientation of certain objects (e.g. Arrows). For example assigning a positive height will cause the arrow to point down (X-axis). Similarly, assigning a negative value for the width will cause the arrow to point up (Toolbar). You must then use the Width property to point the line or arrow correctly.

  • Overrides:
    setHeight in class AnnotationObject
    See Also:
    AnnotationObject.setWidth(int), AnnotationObject.attach(int, double, int, double)

    setLeft

    public void setLeft(int value)

    Allows you to specify or read the left position of a selected annotation object.

    Remarks:
  • This property should be used in conjunction with the AnnotationObject.setTop(int) property to position the object in the chart area. Both the AnnotationObject.setTop(int) and Left properties support pixel unit configuration.

  • The Chart Origin, coordinates (0,0), is always located at the top-left corner of the chart area.

  • The AnnotationObject.attach(int, double, int, double) method may also be used to attach an annotation object to a chart based on X and Y Axis values.

  • Overrides:
    setLeft in class AnnotationObject
    See Also:
    AnnotationObject.setTop(int), AnnotationObject.attach(int, double, int, double)

    setObjectBounds

    public void setObjectBounds(java.awt.Rectangle value)

    Allows you to specify the bounds for a selected annotation object.

    Remarks:
  • This property accepts a rectangle type object which you may create with your custom dimensions.

  • Overrides:
    setObjectBounds in class AnnotationObject
    See Also:
    AnnotationObject.attach(int, double, int, double)

    setPaintBefore

    public void setPaintBefore(boolean value)

    Configures the selected annotation object to paint before the rest of the chart elements.

    Remarks:
  • Setting this property to True will instruct Chart FX to paint the selected annotation object before other chart elements.

  • Overrides:
    setPaintBefore in class AnnotationObject
    See Also:
    AnnotationObject.refresh(), AnnotationObject

    setPattern

    public void setPattern(int value)

    Allows you to set a pattern for the selected annotation object.

    Values:
    HatchStyle : Specifies the different hatch patterns available.
    ValueDescription
    BACKWARD_DIAGONALA pattern of lines on a diagonal from upper right to lower left.
    CROSSSpecifies horizontal and vertical lines that cross.
    DARK_DOWNWARD_DIAGONALSpecifies diagonal lines that slant to the right from top points to bottom points, are spaced 50 percent closer together than, and are twice the width of ForwardDiagonal. This hatch pattern is not antialiased.
    DARK_HORIZONTALSpecifies horizontal lines that are spaced 50 percent closer together than Horizontal and are twice the width of HatchStyleHorizontal.
    DARK_UPWARD_DIAGONALSpecifies diagonal lines that slant to the left from top points to bottom points, are spaced 50 percent closer together than BackwardDiagonal, and are twice its width, but the lines are not antialiased.
    DARK_VERTICALSpecifies vertical lines that are spaced 50 percent closer together than Vertical and are twice its width.
    DASHED_DOWNWARD_DIAGONALSpecifies dashed diagonal lines, that slant to the right from top points to bottom points.
    DASHED_HORIZONTALSpecifies dashed horizontal lines.
    DASHED_UPWARD_DIAGONALSpecifies dashed diagonal lines, that slant to the left from top points to bottom points.
    DASHED_VERTICALSpecifies dashed vertical lines.
    DIAGONAL_BRICKSpecifies a hatch that has the appearance of layered bricks that slant to the left from top points to bottom points.
    DIAGONAL_CROSSSpecifies forward diagonal and backward diagonal lines that cross. The lines are antialiased.
    DIVOTSpecifies a hatch that has the appearance of divots.
    DOTTED_DIAMONDSpecifies forward diagonal and backward diagonal lines, each of which is composed of dots, that cross.
    DOTTED_GRIDSpecifies horizontal and vertical lines, each of which is composed of dots, that cross.
    FORWARD_DIAGONALA pattern of lines on a diagonal from upper left to lower right.
    HORIZONTALA pattern of horizontal lines.
    HORIZONTAL_BRICKSpecifies a hatch that has the appearance of horizontally layered bricks.
    LARGE_CHECKER_BOARDSpecifies a hatch that has the appearance of a checkerboard with squares that are twice the size of SmallCheckerBoard.
    LARGE_CONFETTISpecifies a hatch that has the appearance of confetti, and is composed of larger pieces than SmallConfetti.
    LARGE_GRIDSpecifies the hatch style Cross.
    LIGHT_DOWNWARD_DIAGONALSpecifies diagonal lines that slant to the right from top points to bottom points and are spaced 50 percent closer together than DownwardDiagonal, but they are not antialiased.
    LIGHT_HORIZONTALSpecifies horizontal lines that are spaced 50 percent closer together than Horizontal.
    LIGHT_UPWARD_DIAGONALSpecifies diagonal lines that slant to the left from top points to bottom points and are spaced 50 percent closer together than BackwardDiagonal, but they are not antialiased.
    LIGHT_VERTICALSpecifies vertical lines that are spaced 50 percent closer together than Vertical.
    MAXSpecifies hatch style SolidDiamond.
    MINSpecifies hatch style Horizonal.
    NARROW_HORIZONTALSpecifies horizontal lines that are spaced 75 percent closer together than hatch style Horizontal (or 25 percent closer together than LightHorizontal).
    NARROW_VERTICALSpecifies vertical lines that are spaced 75 percent closer together than hatch style Vertical (or 25 percent closer together than LightVertical).
    OUTLINED_DIAMONDSpecifies forward diagonal and backward diagonal lines that cross but are not antialiased.
    PERCENT_05Specifies a 5-percent hatch. The ratio of foreground color to background color is 5:100.
    PERCENT_10Specifies a 10-percent hatch. The ratio of foreground color to background color is 10:100.
    PERCENT_20Specifies a 20-percent hatch. The ratio of foreground color to background color is 20:100.
    PERCENT_25Specifies a 25-percent hatch. The ratio of foreground color to background color is 25:100.
    PERCENT_30Specifies a 30-percent hatch. The ratio of foreground color to background color is 30:100.
    PERCENT_40Specifies a 40-percent hatch. The ratio of foreground color to background color is 40:100.
    PERCENT_50Specifies a 50-percent hatch. The ratio of foreground color to background color is 50:100.
    PERCENT_60Specifies a 60-percent hatch. The ratio of foreground color to background color is 60:100.
    PERCENT_70Specifies a 70-percent hatch. The ratio of foreground color to background color is 70:100.
    PERCENT_75Specifies a 75-percent hatch. The ratio of foreground color to background color is 75:100.
    PERCENT_80Specifies a 80-percent hatch. The ratio of foreground color to background color is 80:100.
    PERCENT_90Specifies a 90-percent hatch. The ratio of foreground color to background color is 90:100.
    PLAIDSpecifies a hatch that has the appearance of a plaid material.
    SHINGLESpecifies a hatch that has the appearance of diagonally-layered shingles that slant to the right from top points to bottom points.
    SMALL_CHECKER_BOARDSpecifies a hatch that has the appearance of a checkerboard.
    SMALL_CONFETTISpecifies a hatch that has the appearance of confetti.
    SMALL_GRIDSpecifies horizontal and vertical lines that cross and are spaced 50 percent closer together than hatch style Cross.
    SOLID_DIAMONDSpecifies a hatch that has the appearance of a checkerboard placed diagonally.
    SPHERESpecifies a hatch that has the appearance of spheres laid adjacent to one another.
    TRELLISSpecifies a hatch that has the appearance of a trellis.
    VERTICALA pattern of vertical lines.
    WAVESpecifies horizontal lines that are composed of tildes.
    WEAVESpecifies a hatch that has the appearance of a woven material.
    WIDE_DOWNWARD_DIAGONALSpecifies diagonal lines that slant to the right from top points to bottom points, have the same spacing as hatch style ForwardDiagonal, and are triple its width, but are not antialiased.
    WIDE_UPWARD_DIAGONALSpecifies diagonal lines that slant to the left from top points to bottom points, have the same spacing as hatch style BackwardDiagonal, and are triple its width, but are not antialiased.
    ZIG_ZAGSpecifies horizontal lines that are composed of zigzags.

    Remarks:
  • This property exposes the supported pattern styles included in the HatchStyle type.

  • Overrides:
    setPattern in class AnnotationObject
    See Also:
    AnnotationObject.setColor(java.awt.Color), AnnotationObject.setHeight(int), AnnotationObject.setWidth(int), AnnotationObject.attach(int, double, int, double), AnnotationX

    setTag

    public void setTag(java.lang.Object value)

    Allows you to get or set a unique identifier to the objects you have created in the chart area.

    Remarks:
  • This property is particularly useful when you go through the list of objects and you want each object to have a unique identifier.

  • The Tag value must be an integer.

  • Overrides:
    setTag in class AnnotationObject

    setTop

    public void setTop(int value)

    Allows you to specify or read the top position of a selected annotation object.

    Remarks:
  • This property should be used in conjunction with the AnnotationObject.setLeft(int) property to position the object in the chart area. Both the Top and AnnotationObject.setLeft(int) properties support pixel unit configuration.

  • The Chart Origin, coordinates (0,0), is always located at the top-left corner of the chart area.

  • The AnnotationObject.attach(int, double, int, double) method may also be used to attach an annotation object to a chart based on X and Y Axis values.

  • Overrides:
    setTop in class AnnotationObject
    See Also:
    AnnotationObject.setLeft(int), AnnotationObject.attach(int, double, int, double)

    setURL

    public void setURL(java.lang.String value)
    Deprecated. You should use AnnotationArc.getLink().setUrl instead.

    Overrides:
    setURL in class AnnotationObject
    See Also:
    getLink()

    setURLTarget

    public void setURLTarget(java.lang.String value)
    Deprecated. You should use AnnotationArc.getLink().setTarget instead.

    Overrides:
    setURLTarget in class AnnotationObject
    See Also:
    getLink()

    setVisible

    public void setVisible(boolean value)

    Used to show or hide a selected annotation object in the chart area.

    Remarks:
  • The AnnotationObject class members are accessible by all supported annotation objects, therefore this property may be used to hide any annotation object in the chart.

  • Overrides:
    setVisible in class AnnotationObject
    See Also:
    AnnotationObject.refresh(), Chart

    setWidth

    public void setWidth(int value)

    Gets or Sets the Width in pixels for the selected annotation object.

    Remarks:
  • Important note: It is very important to set the AnnotationObject.setHeight(int) and Width for every annotation object created in a chart. The default height and width are zero(0), so if you do not set the these attributes the annotation object will not appear in the chart area. (The AnnotationObject.attach(int, double, int, double) method can be used instead of setting these properties, see next remark.)

  • When you call the AnnotationObject.attach(int, double, int, double) method using the left, top, right and bottom parameters, both the Height and Width for the object is calculated by Chart FX. If you only specify a dx and dy parameter, you will still need to configure the height and width.

  • With this property you can also control the orientation of certain objects (e.g. Arrows). For example assigning a positive height will cause the arrow to point down (X-axis). Similarly, assigning a negative value for the width will cause the arrow to point up (Toolbar). You must then use the Width property to point the line or arrow correctly.

  • Overrides:
    setWidth in class AnnotationObject
    See Also:
    AnnotationObject.setHeight(int), AnnotationObject.attach(int, double, int, double)

    http://www.softwarefx.com

    2005 Software FX, Inc. All Rights Reserved. Chart FX is a registered trademark of Software FX, Inc
    All other names are trademarks or registered trademarks of their respective owners.