com.luciad.view.gxy

LuciadLightspeedClass ALcdGXYLabelPainter

java.lang.Object

com.luciad.view.gxy.ALcdGXYLabelPainter

All Implemented Interfaces:

ILcdPropertyChangeSource, ILcdGXYLabelPainter, ILcdGXYLabelPainter2, ILcdGXYMultiLabelPainter, Serializable, Cloneable

Direct Known Subclasses:

TLcdGXYCompositeLabelPainter, TLcdGXYCurvedPathLabelPainter, TLcdGXYLabelPainterAdapter, TLcdGXYOffsetIconPainter, TLcdGXYPolygonStampLabelPainter, TLcdGXYPolylineStampLabelPainter, TLcdGXYStampLabelPainter

public abstract class ALcdGXYLabelPainter
extends Object
implements ILcdGXYLabelPainter2

This class implements some of the functionality common to most ILcdGXYLabelPainter2s. It is provided to facilitate the implementation of an ILcdGXYLabelPainter2.

This default implementation assumes a single label and with a single sublabel. Override the getLabelCount and getSubLabelCount methods to provide support for multiple labels with multiple sublabels.

Since:

7.0

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.luciad.view.gxy.ILcdGXYLabelPainter2

BODY, CREATING, HANDLES, RESHAPING, SNAPS, TRANSLATING

Fields inherited from interface com.luciad.view.gxy.ILcdGXYLabelPainter

DEFAULT, SELECTED

Constructor Summary

Constructors

Constructor and Description
ALcdGXYLabelPainter()

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener aPropertyChangeListener) Registers the given PropertyChangeListener to be notified when this object's properties change.
Object	clone() Returns a new instance of this ALcdGXYLabelPainter.
protected void	firePropertyChangeEvent(PropertyChangeEvent aPropertyChangeEvent) Notifies the registered PropertyChangeListeners of the specified event.
String	getDisplayName() This default implementation returns the display name set with setDisplayName, or toString() if this was set to null.
int	getLabelCount(Graphics aGraphics, ILcdGXYContext aGXYContext) Return the number of labels for the currently set object.
Cursor	getLabelCursor(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext) Returns a Cursor to indicate the type of editing aMode and aGXYContext.
int	getLabelIndex() Returns the index of the label that is currently painted or scheduled to paint.
TLcdLabelLocation	getLabelLocation() Returns the TLcdLabelLocation that was previously set that contains the information on the whereabouts of the label.
int	getLocationIndex() Gets the index of location where to paint the label(s) of the set Object.
Object	getObject() Gets the Object this ILcdGXYLabelPainter can label.
int	getSubLabelCount(int aLabelIndex) Returns the number of sublabels for the set object and the given label index.
int	getSubLabelIndex() Returns the index of the sublabel to paint.
Object	labelSnapTarget(Graphics aGraphics, ILcdGXYContext aGXYContext) Returns an Object that can be used as snapping target when graphically editing another Object or label than the one this ILcdGXYLabelPainter2 represents.
void	removePropertyChangeListener(PropertyChangeListener aPropertyChangeListener) De-registers the given PropertyChangeListener from receiving property change events for this object.
void	setDisplayName(String aDisplayName) Sets the display name for this label painter.
void	setLabelIndex(int aLabelIndex) Sets the label.
void	setLabelLocation(TLcdLabelLocation aLabelLocation) Sets the label location of the label.
void	setLocationIndex(int aLocationIndex) Sets the index of location where to paint the label(s) of the set Object.
void	setObject(Object aObject) Sets the Object to be labeled by this ILcdGXYLabelPainter.
void	setSubLabelIndex(int aSubLabelIndex) Sets the sublabel index.
boolean	supportLabelSnap(Graphics aGraphics, ILcdGXYContext aGXYContext) Returns whether this label painter supports snapping for the label specified by setObject, setLabelIndex and setSubLabelIndex, considering the given ILcdGXYContext instance.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.luciad.view.gxy.ILcdGXYLabelPainter2

isLabelTouched, labelAnchorPointSFCT, labelBoundsSFCT, paintLabel

Methods inherited from interface com.luciad.view.gxy.ILcdGXYLabelPainter

getPossibleLocationCount

Constructor Detail

ALcdGXYLabelPainter

public ALcdGXYLabelPainter()

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener aPropertyChangeListener)

Description copied from interface: ILcdPropertyChangeSource

Registers the given PropertyChangeListener to be notified when this object's properties change.

In case you need to register a listener which keeps a reference to an object with a shorter life-time than this change source, you can use a ALcdWeakPropertyChangeListener instance as property change listener.

Specified by:

addPropertyChangeListener in interface ILcdPropertyChangeSource

Parameters:

aPropertyChangeListener - The listener to be notified

See Also:

ALcdWeakPropertyChangeListener, ILcdPropertyChangeSource.removePropertyChangeListener(java.beans.PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener aPropertyChangeListener)

Description copied from interface: ILcdPropertyChangeSource

De-registers the given PropertyChangeListener from receiving property change events for this object.

If the listener was added more than once, it will be notified one less time after being removed. If the listener is null, or was never added, no exception is thrown and no action is taken.

Specified by:

removePropertyChangeListener in interface ILcdPropertyChangeSource

Parameters:

aPropertyChangeListener - the listener that should no longer be notified of changes of this object's properties

See Also:

ILcdPropertyChangeSource.addPropertyChangeListener(java.beans.PropertyChangeListener)

firePropertyChangeEvent

protected void firePropertyChangeEvent(PropertyChangeEvent aPropertyChangeEvent)

Notifies the registered PropertyChangeListeners of the specified event.

Parameters:

aPropertyChangeEvent - The event describing the property change of which the registered listeners should be notified.

See Also:

addPropertyChangeListener(java.beans.PropertyChangeListener)

getLabelLocation

public TLcdLabelLocation getLabelLocation()

Description copied from interface: ILcdGXYLabelPainter2

Returns the TLcdLabelLocation that was previously set that contains the information on the whereabouts of the label.

Specified by:

getLabelLocation in interface ILcdGXYLabelPainter2

Returns:

The label location that was previously set.

See Also:

ILcdGXYLabelPainter2.setLabelLocation(com.luciad.view.TLcdLabelLocation)

setLabelLocation

public void setLabelLocation(TLcdLabelLocation aLabelLocation)

Description copied from interface: ILcdGXYLabelPainter2

Sets the label location of the label. This label location will be used to determine what the bounds of the label are, where it must be painted, etc.

Note that aLabelLocation also contains a label location index. This is independent of the ILcdGXYLabelPainter.getLocationIndex() of the super interface. Contrary to the location index returned by getLocationIndex, the location index in aLabelLocation can be less than 0, in which case the labels are freely placed.

This method has to be called after ILcdGXYLabelPainter2.setObject(java.lang.Object) has been called, as calling setObject clears this label location.

Specified by:

setLabelLocation in interface ILcdGXYLabelPainter2

Parameters:

aLabelLocation - The TLcdLabelLocation instance containing all the information about the location of the label.

See Also:

ILcdGXYLabelPainter2.setObject(java.lang.Object)

setObject

public void setObject(Object aObject)

Description copied from interface: ILcdGXYLabelPainter2

Sets the Object to be labeled by this ILcdGXYLabelPainter.

Setting the object should set the TLcdLabelLocation to null, to ensure that older code which has not been adapted to this new interface keeps working.

Specified by:

setObject in interface ILcdGXYLabelPainter

Specified by:

setObject in interface ILcdGXYLabelPainter2

Parameters:

aObject - The object to be labeled.

See Also:

ILcdGXYLabelPainter.getObject()

getObject

public Object getObject()

Description copied from interface: ILcdGXYLabelPainter

Gets the Object this ILcdGXYLabelPainter can label.

Specified by:

getObject in interface ILcdGXYLabelPainter

Returns:

the Object this ILcdGXYLabelPainter can label.

See Also:

ILcdGXYLabelPainter.setObject(java.lang.Object)

getLabelCount

public int getLabelCount(Graphics aGraphics,
                         ILcdGXYContext aGXYContext)

Return the number of labels for the currently set object. The default implementation returns 1. Override this method if you need to support multiple labels.

Specified by:

getLabelCount in interface ILcdGXYMultiLabelPainter

Parameters:

aGraphics - The Graphics instance on which the labels would be painted.

aGXYContext - The context containing information about the layer and the view for which the label would be drawn.

Returns:

The number of labels for the set object. This should be greater than 0.

setLabelIndex

public void setLabelIndex(int aLabelIndex)

Description copied from interface: ILcdGXYMultiLabelPainter

Sets the label. The results of any subsequent method calls to ILcdGXYLabelPainter.paintLabel(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext) and ILcdGXYLabelPainter.labelBoundsSFCT(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext, java.awt.Rectangle) etc. will apply to the label and sublabel indicated by this label index.

Specified by:

setLabelIndex in interface ILcdGXYMultiLabelPainter

Parameters:

aLabelIndex - The label index. This should be larger than or equal to 0 and less than the result ILcdGXYMultiLabelPainter.getLabelCount(java.awt.Graphics, com.luciad.view.gxy.ILcdGXYContext).

See Also:

ILcdGXYMultiLabelPainter.setSubLabelIndex(int)

getLabelIndex

public int getLabelIndex()

Description copied from interface: ILcdGXYMultiLabelPainter

Returns the index of the label that is currently painted or scheduled to paint.

Specified by:

getLabelIndex in interface ILcdGXYMultiLabelPainter

Returns:

the index of the label that is currently painted or scheduled to paint.

See Also:

ILcdGXYMultiLabelPainter.setLabelIndex(int)

getSubLabelCount

public int getSubLabelCount(int aLabelIndex)

Returns the number of sublabels for the set object and the given label index. The default implementation returns 1. Override this method if you need to support multiple sublabels.

Specified by:

getSubLabelCount in interface ILcdGXYMultiLabelPainter

Parameters:

aLabelIndex - The label index for which you need to know the number of sublabels.

Returns:

The number of sublabels. This should be greater than 0.

See Also:

getLabelCount(java.awt.Graphics, com.luciad.view.gxy.ILcdGXYContext)

setSubLabelIndex

public void setSubLabelIndex(int aSubLabelIndex)

Description copied from interface: ILcdGXYMultiLabelPainter

Sets the sublabel index. The results of any subsequent method calls to ILcdGXYLabelPainter.paintLabel(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext) and ILcdGXYLabelPainter.labelBoundsSFCT(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext, java.awt.Rectangle) etc. will apply to the label and sublabel indicated by this sublabel index.

Specified by:

setSubLabelIndex in interface ILcdGXYMultiLabelPainter

Parameters:

aSubLabelIndex - The sub label index. This should be larger than or equal to 0 and less than the result ILcdGXYMultiLabelPainter.getSubLabelCount(int).

See Also:

ILcdGXYMultiLabelPainter.setLabelIndex(int)

getSubLabelIndex

public int getSubLabelIndex()

Description copied from interface: ILcdGXYMultiLabelPainter

Returns the index of the sublabel to paint.

Specified by:

getSubLabelIndex in interface ILcdGXYMultiLabelPainter

Returns:

the index of the sublabel to paint.

See Also:

ILcdGXYMultiLabelPainter.setSubLabelIndex(int)

setLocationIndex

public void setLocationIndex(int aLocationIndex)

Description copied from interface: ILcdGXYLabelPainter

Sets the index of location where to paint the label(s) of the set Object.

Specified by:

setLocationIndex in interface ILcdGXYLabelPainter

Parameters:

aLocationIndex - the index of the location. Must be between 0 and getPossibleLocationCount() - 1.

See Also:

ILcdGXYLabelPainter.getLocationIndex()

getLocationIndex

public int getLocationIndex()

Description copied from interface: ILcdGXYLabelPainter

Gets the index of location where to paint the label(s) of the set Object.

Specified by:

getLocationIndex in interface ILcdGXYLabelPainter

Returns:

the index of the position. Must be between 0 and getPossibleLocationCount() - 1.

See Also:

ILcdGXYLabelPainter.setLocationIndex(int)

clone

public Object clone()

Returns a new instance of this ALcdGXYLabelPainter. The label location of the clone is a clone of the label location of the original. No other objects are cloned.

Specified by:

clone in interface ILcdGXYLabelPainter

Specified by:

clone in interface ILcdGXYLabelPainter2

Overrides:

clone in class Object

Returns:

A new instance of this ALcdGXYLabelPainter of which the label location is a deep clone.

getLabelCursor

public Cursor getLabelCursor(Graphics aGraphics,
                             int aMode,
                             ILcdGXYContext aGXYContext)

Returns a Cursor to indicate the type of editing aMode and aGXYContext.

This default implementation always returns null. Override this method if you want to display custom cursors.

Specified by:

getLabelCursor in interface ILcdGXYLabelPainter2

Parameters:

aGraphics - The Graphics instance on which the label is painted.

aMode - The mode to consider. See ILcdGXYLabelPainter2.paintLabel(java.awt.Graphics, int, ILcdGXYContext) for more information.

aGXYContext - The ILcdGXYContext containing extra information, such as the layer, the view and the mouse position.

Returns:

a Cursor to indicate the type of editing aMode and aGXYContext. Returns null if no particular Cursor is required.

supportLabelSnap

public boolean supportLabelSnap(Graphics aGraphics,
                                ILcdGXYContext aGXYContext)

Returns whether this label painter supports snapping for the label specified by setObject, setLabelIndex and setSubLabelIndex, considering the given ILcdGXYContext instance. When the label painter supports snap for the specified label and context, it can return a snap target for this label and context.

Before calling this method, the domain object, the label index, the sublabel index and the location of the label should be set using the respective methods.

This default implementation returns false. Override this method if you want to support snapping.

Specified by:

supportLabelSnap in interface ILcdGXYLabelPainter2

Parameters:

aGraphics - the Graphics on which is worked.

aGXYContext - the ILcdGXYContext of the snapping.

Returns:

true if this label painter supports snapping for the specified label.

See Also:

labelSnapTarget

labelSnapTarget

public Object labelSnapTarget(Graphics aGraphics,
                              ILcdGXYContext aGXYContext)

Returns an Object that can be used as snapping target when graphically editing another Object or label than the one this ILcdGXYLabelPainter2 represents. The returned Object can be the Object this ILcdGXYLabelPainter2 represents or any other (e.g. an ILcdPoint if getObject() is an ILcdPointList).

This default implementation always returns null. Override this method if you want to support snapping.

Specified by:

labelSnapTarget in interface ILcdGXYLabelPainter2

Parameters:

aGraphics - the Graphics on which is worked.

aGXYContext - the ILcdGXYContext of the snapping.

Returns:

an Object that can be used as snapping target when graphically editing another Object or label than the one this ILcdGXYLabelPainter2 represents (returned by getObject()). This object can be null.

getDisplayName

public String getDisplayName()

This default implementation returns the display name set with setDisplayName, or toString() if this was set to null.

Specified by:

getDisplayName in interface ILcdGXYLabelPainter2

Returns:

the display name of this ILcdGXYLabelPainter2

setDisplayName

public void setDisplayName(String aDisplayName)

Sets the display name for this label painter.

Parameters:

aDisplayName - The display name for this label painter. This can be null, in which case getDisplayName() will return the result of toString().

See Also:

getDisplayName