Package org.jfree.chart.plot
Class Marker
java.lang.Object
org.jfree.chart.plot.Marker
- All Implemented Interfaces:
Serializable,Cloneable
- Direct Known Subclasses:
IntervalMarker,ValueMarker
public abstract class Marker extends Object implements Serializable, Cloneable
The base class for markers that can be added to plots to highlight a value or
range of values.
- See Also:
- Serialized Form
-
Constructor Summary
-
Method Summary
Modifier and Type Method Description booleanequals(Object object)Tests an object for equality with this instance.floatgetAlpha()Returns the alpha transparency.StringgetLabel()Returns the label (ifnullno label is displayed).org.jfree.ui.RectangleAnchorgetLabelAnchor()Returns the label anchor.FontgetLabelFont()Returns the label font.org.jfree.ui.RectangleInsetsgetLabelOffset()Returns the label offset.PaintgetLabelPaint()Returns the label paint.org.jfree.ui.TextAnchorgetLabelTextAnchor()Returns the label text anchor.PaintgetOutlinePaint()Returns the outline paint.StrokegetOutlineStroke()Returns the outline stroke.PaintgetPaint()Returns the paint.StrokegetStroke()Returns the stroke.voidsetAlpha(float alpha)Sets the alpha transparency.voidsetLabel(String label)Sets the label (ifnullno label is displayed).voidsetLabelAnchor(org.jfree.ui.RectangleAnchor anchor)Sets the label anchor.voidsetLabelFont(Font font)Sets the label font.voidsetLabelOffset(org.jfree.ui.RectangleInsets offset)Sets the label offset.voidsetLabelPaint(Paint paint)Sets the label paint.voidsetLabelTextAnchor(org.jfree.ui.TextAnchor anchor)Sets the label text anchor.voidsetOutlinePaint(Paint paint)Sets the outline paint.voidsetOutlineStroke(Stroke stroke)Sets the outline stroke.voidsetPaint(Paint paint)Sets the paint.voidsetStroke(Stroke stroke)Sets the stroke.
-
Constructor Details
-
Marker
public Marker()Constructs a new marker. -
Marker
Constructs a new marker.- Parameters:
paint- the paint (nullnot permitted).
-
Marker
Constructs a new marker.- Parameters:
paint- the paint (nullnot permitted).stroke- the stroke (nullnot permitted).outlinePaint- the outline paint (nullpermitted).outlineStroke- the outline stroke (nullpermitted).alpha- the alpha transparency.
-
-
Method Details
-
getPaint
Returns the paint.- Returns:
- the paint (never
null).
-
setPaint
Sets the paint.- Parameters:
paint- the paint (nullnot permitted).
-
getStroke
Returns the stroke.- Returns:
- the stroke (never
null).
-
setStroke
Sets the stroke.- Parameters:
stroke- the stroke (nullnot permitted).
-
getOutlinePaint
Returns the outline paint.- Returns:
- the outline paint (possibly
null).
-
setOutlinePaint
Sets the outline paint.- Parameters:
paint- the paint (nullpermitted).
-
getOutlineStroke
Returns the outline stroke.- Returns:
- the outline stroke (possibly
null).
-
setOutlineStroke
Sets the outline stroke.- Parameters:
stroke- the stroke (nullpermitted).
-
getAlpha
public float getAlpha()Returns the alpha transparency.- Returns:
- the alpha transparency.
-
setAlpha
public void setAlpha(float alpha)Sets the alpha transparency.- Parameters:
alpha- the alpha transparency.
-
getLabel
Returns the label (ifnullno label is displayed).- Returns:
- The label (possibly
null).
-
setLabel
Sets the label (ifnullno label is displayed).- Parameters:
label- the label (nullpermitted).
-
getLabelFont
Returns the label font.- Returns:
- the label font (never
null).
-
setLabelFont
Sets the label font.- Parameters:
font- the font (nullnot permitted).
-
getLabelPaint
Returns the label paint.- Returns:
- the label paint (never null).
-
setLabelPaint
Sets the label paint.- Parameters:
paint- the paint (nullnot permitted).
-
getLabelAnchor
public org.jfree.ui.RectangleAnchor getLabelAnchor()Returns the label anchor.- Returns:
- the label anchor (never
null).
-
setLabelAnchor
public void setLabelAnchor(org.jfree.ui.RectangleAnchor anchor)Sets the label anchor.- Parameters:
anchor- the anchor (nullnot permitted).
-
getLabelOffset
public org.jfree.ui.RectangleInsets getLabelOffset()Returns the label offset.- Returns:
- the label offset (never
null).
-
setLabelOffset
public void setLabelOffset(org.jfree.ui.RectangleInsets offset)Sets the label offset.- Parameters:
offset- the label offset (nullnot permitted).
-
getLabelTextAnchor
public org.jfree.ui.TextAnchor getLabelTextAnchor()Returns the label text anchor.- Returns:
- the label text anchor (never
null).
-
setLabelTextAnchor
public void setLabelTextAnchor(org.jfree.ui.TextAnchor anchor)Sets the label text anchor.- Parameters:
anchor- the label text anchor (nullnot permitted).
-
equals
Tests an object for equality with this instance.
-