Class Marker

protected Marker()

Creates a new marker with default attributes.

protected Marker(Paint paint)

Constructs a new marker.

Parameters:

paint - the paint (null not permitted).

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).

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

public Object clone()
            throws CloneNotSupportedException

Creates a clone of the marker.

Returns:

A clone.

public boolean equals(Object obj)

Tests the marker for equality with an arbitrary object.

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

public float getAlpha()

Returns the alpha transparency.

Returns:

The alpha transparency.

See Also:

setAlpha(float)

public String getLabel()

Returns the label (if null no label is displayed).

Returns:

The label (possibly null).

See Also:

setLabel(String)

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(RectangleAnchor)

public Font getLabelFont()

Returns the label font.

Returns:

The label font (never null).

See Also:

setLabelFont(Font)

public RectangleInsets getLabelOffset()

Returns the label offset.

Returns:

The label offset (never null).

See Also:

setLabelOffset(RectangleInsets)

public LengthAdjustmentType getLabelOffsetType()

Returns the label offset type.

Returns:

The type (never null).

See Also:

setLabelOffsetType(LengthAdjustmentType)

public Paint getLabelPaint()

Returns the label paint.

Returns:

The label paint (never null).

See Also:

setLabelPaint(Paint)

public TextAnchor getLabelTextAnchor()

Returns the label text anchor.

Returns:

The label text anchor (never null).

See Also:

setLabelTextAnchor(TextAnchor)

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

public Paint getOutlinePaint()

Returns the outline paint.

Returns:

The outline paint (possibly null).

See Also:

setOutlinePaint(Paint)

public Stroke getOutlineStroke()

Returns the outline stroke.

Returns:

The outline stroke (possibly null).

See Also:

setOutlineStroke(Stroke)

public Paint getPaint()

Returns the paint.

Returns:

The paint (never null).

See Also:

setPaint(Paint)

public Stroke getStroke()

Returns the stroke.

Returns:

The stroke (never null).

See Also:

setStroke(Stroke)

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

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

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).

See Also:

getAlpha()

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()

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:

getLabelAnchor()

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()

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:

getLabelOffset()

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:

getLabelOffsetType()

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()

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:

getLabelTextAnchor()

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()

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()

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()

public void setStroke(Stroke stroke)

Sets the stroke and sends a MarkerChangeEvent to all registered listeners.

Parameters:

stroke - the stroke (null not permitted).

See Also:

getStroke()