Module platform
Package org.jfree.chart.plot

Class Marker

java.lang.Object
org.jfree.chart.plot.Marker
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
CategoryMarker, IntervalMarker, ValueMarker
public abstract class Marker extends Object implements Cloneable, Serializable
The base class for markers that can be added to plots to highlight a value or range of values.

An event notification mechanism was added to this class in JFreeChart version 1.0.3.
See Also:

  • Constructor Details

    • Marker

      protected Marker()
      Creates a new marker with default attributes.

    • Marker

      protected Marker(Paint paint)
      Constructs a new marker.
      Parameters:
      paint - the paint (null not permitted).

    • Marker

      protected Marker(Paint paint, Stroke stroke, Paint outlinePaint, Stroke outlineStroke, float alpha)
      Constructs a new marker.
      Parameters:
      paint - the paint (null not permitted).
      stroke - the stroke (null not permitted).
      outlinePaint - the outline paint (null permitted).
      outlineStroke - the outline stroke (null permitted).
      alpha - the alpha transparency (must be in the range 0.0f to 1.0f).
      Throws:
      IllegalArgumentException - if paint or stroke is null, or alpha is not in the specified range.

  • Method Details

    • getPaint

      public Paint getPaint()
      Returns the paint.
      Returns:
      The paint (never null).
      See Also:

    • setPaint

      public void setPaint(Paint paint)
      Sets the paint and sends a MarkerChangeEvent to all registered listeners.
      Parameters:
      paint - the paint (null not permitted).
      See Also:

    • getStroke

      public Stroke getStroke()
      Returns the stroke.
      Returns:
      The stroke (never null).
      See Also:

    • setStroke

      public void setStroke(Stroke stroke)
      Sets the stroke and sends a MarkerChangeEvent to all registered listeners.
      Parameters:
      stroke - the stroke (nullnot permitted).
      See Also:

    • getOutlinePaint

      public Paint getOutlinePaint()
      Returns the outline paint.
      Returns:
      The outline paint (possibly null).
      See Also:

    • setOutlinePaint

      public void setOutlinePaint(Paint paint)
      Sets the outline paint and sends a MarkerChangeEvent to all registered listeners.
      Parameters:
      paint - the paint (null permitted).
      See Also:

    • getOutlineStroke

      public Stroke getOutlineStroke()
      Returns the outline stroke.
      Returns:
      The outline stroke (possibly null).
      See Also:

    • setOutlineStroke

      public void setOutlineStroke(Stroke stroke)
      Sets the outline stroke and sends a MarkerChangeEvent to all registered listeners.
      Parameters:
      stroke - the stroke (null permitted).
      See Also:

    • getAlpha

      public float getAlpha()
      Returns the alpha transparency.
      Returns:
      The alpha transparency.
      See Also:

    • setAlpha

      public void setAlpha(float alpha)
      Sets the alpha transparency that should be used when drawing the marker, and sends a MarkerChangeEvent to all registered listeners. The alpha transparency is a value in the range 0.0f (completely transparent) to 1.0f (completely opaque).
      Parameters:
      alpha - the alpha transparency (must be in the range 0.0f to 1.0f).
      Throws:
      IllegalArgumentException - if alpha is not in the specified range.
      See Also:

    • getLabel

      public String getLabel()
      Returns the label (if null no label is displayed).
      Returns:
      The label (possibly null).
      See Also:

    • setLabel

      public void setLabel(String label)
      Sets the label (if null no label is displayed) and sends a MarkerChangeEvent to all registered listeners.
      Parameters:
      label - the label (null permitted).
      See Also:

    • getLabelFont

      public Font getLabelFont()
      Returns the label font.
      Returns:
      The label font (never null).
      See Also:

    • setLabelFont

      public void setLabelFont(Font font)
      Sets the label font and sends a MarkerChangeEvent to all registered listeners.
      Parameters:
      font - the font (null not permitted).
      See Also:

    • getLabelPaint

      public Paint getLabelPaint()
      Returns the label paint.
      Returns:
      The label paint (never null).
      See Also:

    • setLabelPaint

      public void setLabelPaint(Paint paint)
      Sets the label paint and sends a MarkerChangeEvent to all registered listeners.
      Parameters:
      paint - the paint (null not permitted).
      See Also:

    • getLabelBackgroundColor

      public Color getLabelBackgroundColor()
      Returns the label background color. The default value is Color(100, 100, 100, 100)..
      Returns:
      The label background color (never null).

    • setLabelBackgroundColor

      public void setLabelBackgroundColor(Color color)
      Sets the label background color.
      Parameters:
      color - the color (null not permitted).

    • getLabelAnchor

      public RectangleAnchor getLabelAnchor()
      Returns the label anchor. This defines the position of the label anchor, relative to the bounds of the marker.
      Returns:
      The label anchor (never null).
      See Also:

    • setLabelAnchor

      public void setLabelAnchor(RectangleAnchor anchor)
      Sets the label anchor and sends a MarkerChangeEvent to all registered listeners. The anchor defines the position of the label anchor, relative to the bounds of the marker.
      Parameters:
      anchor - the anchor (null not permitted).
      See Also:

    • getLabelOffset

      public RectangleInsets getLabelOffset()
      Returns the label offset.
      Returns:
      The label offset (never null).
      See Also:

    • setLabelOffset

      public void setLabelOffset(RectangleInsets offset)
      Sets the label offset and sends a MarkerChangeEvent to all registered listeners.
      Parameters:
      offset - the label offset (null not permitted).
      See Also:

    • getLabelOffsetType

      public LengthAdjustmentType getLabelOffsetType()
      Returns the label offset type.
      Returns:
      The type (never null).
      See Also:

    • setLabelOffsetType

      public void setLabelOffsetType(LengthAdjustmentType adj)
      Sets the label offset type and sends a MarkerChangeEvent to all registered listeners.
      Parameters:
      adj - the type (null not permitted).
      See Also:

    • getLabelTextAnchor

      public TextAnchor getLabelTextAnchor()
      Returns the label text anchor.
      Returns:
      The label text anchor (never null).
      See Also:

    • setLabelTextAnchor

      public void setLabelTextAnchor(TextAnchor anchor)
      Sets the label text anchor and sends a MarkerChangeEvent to all registered listeners.
      Parameters:
      anchor - the label text anchor (null not permitted).
      See Also:

    • addChangeListener

      public void addChangeListener(MarkerChangeListener listener)
      Registers an object for notification of changes to the marker.
      Parameters:
      listener - the object to be registered.
      See Also:

    • removeChangeListener

      public void removeChangeListener(MarkerChangeListener listener)
      Unregisters an object for notification of changes to the marker.
      Parameters:
      listener - the object to be unregistered.
      See Also:

    • notifyListeners

      public void notifyListeners(MarkerChangeEvent event)
      Notifies all registered listeners that the marker has been modified.
      Parameters:
      event - information about the change event.

    • getListeners

      public EventListener[] getListeners(Class listenerType)
      Returns an array containing all the listeners of the specified type.
      Parameters:
      listenerType - the listener type.
      Returns:
      The array of listeners.

    • equals

      public boolean equals(Object obj)
      Tests the marker for equality with an arbitrary object.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object (null permitted).
      Returns:
      A boolean.

    • clone

      public Object clone() throws CloneNotSupportedException
      Creates a clone of the marker.
      Overrides:
      clone in class Object
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - never.