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:

Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChangeListener(MarkerChangeListener listener)` Registers an object for notification of changes to the marker.
`Object`	`clone()` Creates a clone of the marker.
`boolean`	`equals(Object obj)` Tests the marker for equality with an arbitrary object.
`float`	`getAlpha()` Returns the alpha transparency.
`String`	`getLabel()` Returns the label (if `null` no label is displayed).
`org.jfree.ui.RectangleAnchor`	`getLabelAnchor()` Returns the label anchor.
`Color`	`getLabelBackgroundColor()` Returns the label background color.
`Font`	`getLabelFont()` Returns the label font.
`org.jfree.ui.RectangleInsets`	`getLabelOffset()` Returns the label offset.
`org.jfree.ui.LengthAdjustmentType`	`getLabelOffsetType()` Returns the label offset type.
`Paint`	`getLabelPaint()` Returns the label paint.
`org.jfree.ui.TextAnchor`	`getLabelTextAnchor()` Returns the label text anchor.
`EventListener[]`	`getListeners(Class listenerType)` Returns an array containing all the listeners of the specified type.
`Paint`	`getOutlinePaint()` Returns the outline paint.
`Stroke`	`getOutlineStroke()` Returns the outline stroke.
`Paint`	`getPaint()` Returns the paint.
`Stroke`	`getStroke()` Returns the stroke.
`void`	`notifyListeners(MarkerChangeEvent event)` Notifies all registered listeners that the marker has been modified.
`void`	`removeChangeListener(MarkerChangeListener listener)` Unregisters an object for notification of changes to the marker.
`void`	`setAlpha(float alpha)` Sets the alpha transparency that should be used when drawing the marker, and sends a `MarkerChangeEvent` to all registered listeners.
`void`	`setLabel(String label)` Sets the label (if `null` no label is displayed) and sends a `MarkerChangeEvent` to all registered listeners.
`void`	`setLabelAnchor(org.jfree.ui.RectangleAnchor anchor)` Sets the label anchor and sends a `MarkerChangeEvent` to all registered listeners.
`void`	`setLabelBackgroundColor(Color color)` Sets the label background color.
`void`	`setLabelFont(Font font)` Sets the label font and sends a `MarkerChangeEvent` to all registered listeners.
`void`	`setLabelOffset(org.jfree.ui.RectangleInsets offset)` Sets the label offset and sends a `MarkerChangeEvent` to all registered listeners.
`void`	`setLabelOffsetType(org.jfree.ui.LengthAdjustmentType adj)` Sets the label offset type and sends a `MarkerChangeEvent` to all registered listeners.
`void`	`setLabelPaint(Paint paint)` Sets the label paint and sends a `MarkerChangeEvent` to all registered listeners.
`void`	`setLabelTextAnchor(org.jfree.ui.TextAnchor anchor)` Sets the label text anchor and sends a `MarkerChangeEvent` to all registered listeners.
`void`	`setOutlinePaint(Paint paint)` Sets the outline paint and sends a `MarkerChangeEvent` to all registered listeners.
`void`	`setOutlineStroke(Stroke stroke)` Sets the outline stroke and sends a `MarkerChangeEvent` to all registered listeners.
`void`	`setPaint(Paint paint)` Sets the paint and sends a `MarkerChangeEvent` to all registered listeners.
`void`	`setStroke(Stroke stroke)` Sets the stroke and sends a `MarkerChangeEvent` to all registered listeners.

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

- Method Detail
  - getPaint
```
public Paint getPaint()
```
    Returns the paint.
    
    Returns:
    
    The paint (never null).
    
    See Also:
    
    setPaint(Paint)
  - 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:
    
    getPaint()
  - getStroke
```
public Stroke getStroke()
```
    Returns the stroke.
    
    Returns:
    
    The stroke (never null).
    
    See Also:
    
    setStroke(Stroke)
  - 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:
    
    getStroke()
  - getOutlinePaint
```
public Paint getOutlinePaint()
```
    Returns the outline paint.
    
    Returns:
    
    The outline paint (possibly null).
    
    See Also:
    
    setOutlinePaint(Paint)
  - 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:
    
    getOutlinePaint()
  - getOutlineStroke
```
public Stroke getOutlineStroke()
```
    Returns the outline stroke.
    
    Returns:
    
    The outline stroke (possibly null).
    
    See Also:
    
    setOutlineStroke(Stroke)
  - 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:
    
    getOutlineStroke()
  - getAlpha
```
public float getAlpha()
```
    Returns the alpha transparency.
    
    Returns:
    
    The alpha transparency.
    
    See Also:
    
    setAlpha(float)
  - 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:
    
    getAlpha()
  - getLabel
```
public String getLabel()
```
    Returns the label (if null no label is displayed).
    
    Returns:
    
    The label (possibly null).
    
    See Also:
    
    setLabel(String)
  - 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:
    
    getLabel()
  - getLabelFont
```
public Font getLabelFont()
```
    Returns the label font.
    
    Returns:
    
    The label font (never null).
    
    See Also:
    
    setLabelFont(Font)
  - 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:
    
    getLabelFont()
  - getLabelPaint
```
public Paint getLabelPaint()
```
    Returns the label paint.
    
    Returns:
    
    The label paint (never null).
    
    See Also:
    
    setLabelPaint(Paint)
  - 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:
    
    getLabelPaint()
  - 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).
    
    Since:
    
    1.0.18
  - setLabelBackgroundColor
```
public void setLabelBackgroundColor(Color color)
```
    Sets the label background color.
    
    Parameters:
    
    color - the color (null not permitted).
    
    Since:
    
    1.0.18
  - getLabelAnchor
```
public org.jfree.ui.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(RectangleAnchor)
  - setLabelAnchor
```
public void setLabelAnchor(org.jfree.ui.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:
    
    getLabelAnchor()
  - getLabelOffset
```
public org.jfree.ui.RectangleInsets getLabelOffset()
```
    Returns the label offset.
    
    Returns:
    
    The label offset (never null).
    
    See Also:
    
    setLabelOffset(RectangleInsets)
  - setLabelOffset
```
public void setLabelOffset(org.jfree.ui.RectangleInsets offset)
```
    Sets the label offset and sends a MarkerChangeEvent to all registered listeners.
    
    Parameters:
    
    offset - the label offset (null not permitted).
    
    See Also:
    
    getLabelOffset()
  - getLabelOffsetType
```
public org.jfree.ui.LengthAdjustmentType getLabelOffsetType()
```
    Returns the label offset type.
    
    Returns:
    
    The type (never null).
    
    See Also:
    
    setLabelOffsetType(LengthAdjustmentType)
  - setLabelOffsetType
```
public void setLabelOffsetType(org.jfree.ui.LengthAdjustmentType adj)
```
    Sets the label offset type and sends a MarkerChangeEvent to all registered listeners.
    
    Parameters:
    
    adj - the type (null not permitted).
    
    See Also:
    
    getLabelOffsetType()
  - getLabelTextAnchor
```
public org.jfree.ui.TextAnchor getLabelTextAnchor()
```
    Returns the label text anchor.
    
    Returns:
    
    The label text anchor (never null).
    
    See Also:
    
    setLabelTextAnchor(TextAnchor)
  - setLabelTextAnchor
```
public void setLabelTextAnchor(org.jfree.ui.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:
    
    getLabelTextAnchor()
  - addChangeListener
```
public void addChangeListener(MarkerChangeListener listener)
```
    Registers an object for notification of changes to the marker.
    
    Parameters:
    
    listener - the object to be registered.
    
    Since:
    
    1.0.3
    
    See Also:
    
    removeChangeListener(MarkerChangeListener)
  - removeChangeListener
```
public void removeChangeListener(MarkerChangeListener listener)
```
    Unregisters an object for notification of changes to the marker.
    
    Parameters:
    
    listener - the object to be unregistered.
    
    Since:
    
    1.0.3
    
    See Also:
    
    addChangeListener(MarkerChangeListener)
  - notifyListeners
```
public void notifyListeners(MarkerChangeEvent event)
```
    Notifies all registered listeners that the marker has been modified.
    
    Parameters:
    
    event - information about the change event.
    
    Since:
    
    1.0.3
  - 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.
    
    Since:
    
    1.0.3
  - 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.

Class Marker

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getPaint

setPaint

getStroke

setStroke

getOutlinePaint

setOutlinePaint

getOutlineStroke

setOutlineStroke

getAlpha

setAlpha

getLabel

setLabel

getLabelFont

setLabelFont

getLabelPaint

setLabelPaint

getLabelBackgroundColor

setLabelBackgroundColor

getLabelAnchor

setLabelAnchor

getLabelOffset

setLabelOffset

getLabelOffsetType

setLabelOffsetType

getLabelTextAnchor

setLabelTextAnchor

addChangeListener

removeChangeListener

notifyListeners

getListeners

equals

clone