com.luciad.format.magneticnorth.gxy

LuciadFusionClass TLcdMagneticNorthGXYLabelPainter

java.lang.Object

com.luciad.view.gxy.ALcdGXYLabelPainter

com.luciad.view.gxy.TLcdGXYPolylineStampLabelPainter

com.luciad.view.gxy.TLcdGXYPolylineLabelPainter

com.luciad.format.magneticnorth.gxy.TLcdMagneticNorthGXYLabelPainter

All Implemented Interfaces:

ILcdPropertyChangeSource, ILcdGXYLabelEditor, ILcdGXYLabelEditorProvider, ILcdGXYLabelPainter, ILcdGXYLabelPainter2, ILcdGXYLabelPainterProvider, ILcdGXYMultiLabelPainter, Serializable, Cloneable

public class TLcdMagneticNorthGXYLabelPainter
extends TLcdGXYPolylineLabelPainter

A ILcdGXYLabelPainter implementation for objects in a ILcdMagneticNorthModel. It displays the declination value using the configured format.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.luciad.view.gxy.TLcdGXYPolylineStampLabelPainter

ABOVE, BELOW, CENTER, TRACEON

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

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

CREATING, END_CREATION, RESHAPED, START_CREATION, TRANSLATED

Constructor Summary

Constructors

Constructor and Description
TLcdMagneticNorthGXYLabelPainter() Creates a new label painter displaying the declination value.

Method Summary

Modifier and Type	Method and Description
boolean	acceptSnapTargetForLabel(Graphics aGraphics, ILcdGXYContext aGXYContext) Returns whether the label specified by setObject, setLabelIndex and setSubLabelIndex accepts the snap target in the given ILcdGXYContext.
protected void	addComponentToGXYView(ILcdGXYView aGXYView, Component aComponent) Adds the specified interactive label to the user interface.
protected boolean	canAddComponentToGXYView(ILcdGXYView aGXYView) Returns whether or not an interactive label can be added to the given view.
void	cancelLabelInteraction() Cancels the interactive label, if there is one.
boolean	canStopLabelInteraction() Returns whether or not the label interaction can be stopped.
void	clearImageCache() Clears the entire label image cache.
void	clearImageCache(Object aObject) Clears the label image cache for the given object.
boolean	editLabel(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext) Adapts the set TLcdLabelLocation according to the information present in aGXYContext.
protected void	firePropertyChangeEvent(PropertyChangeEvent aPropertyChangeEvent) Notifies the registered PropertyChangeListeners of the specified event.
protected Component	getComponentForGXYView(ILcdGXYView aGXYView) Gets the component that represents the given ILcdGXYView.
Format	getDeclinationFormat() Returns the format for the magnetic declination value.
String	getDisplayName() This default implementation returns the display name set with setDisplayName, or toString() if this was set to null.
Object	getDomainObjectForInteractiveLabel() Returns the domain object for the interactive label, or null if there is no interactive label.
ALcdGXYInteractiveLabelProvider	getGXYInteractiveLabelProvider() Returns the interactive label provider.
ILcdGXYLabelEditor	getGXYLabelEditor(Object aObject) Returns a valid ILcdGXYLabelEditor for editing the labels of aObject.
ILcdGXYLabelPainter	getGXYLabelPainter(Object aObject) Finds an ILcdGXYLabelPainter that can be used to label the object passed.
ALcdGXYLabelStamp	getGXYLabelStamp() Returns the ALcdGXYLabelStamp that is used by this painter to paint the labels.
TLcdHaloAlgorithm	getHaloAlgorithm() Returns the algorithm that is used for rendering halo's.
Color	getHaloColor() Returns the current halo color.
Color	getHaloPinColor() Returns the current halo pin color.
int	getHaloThickness() Returns the current halo thickness.
int	getLabelCreationClickCount() Returns the number of points required to initialize the label of the set Object.
Cursor	getLabelCursor(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext) Returns a Cursor to indicate the type of editing aMode and aGXYContext.
Color	getPinColor() Returns the color in which the pin is drawn.
Color	getSelectedPinColor() Returns the color in which the pin should be drawn of the label of a selected object.
boolean	isHaloEnabled() Returns true if the halo effect is on for the labels, false otherwise.
boolean	isHaloPinEnabled() Returns true if the halo effect also includes the pin.
boolean	isLabelTouched(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext) Tests if the label specified by setObject, setLabelIndex and setSubLabelIndex is touched at view location (specified by aGXYContext.getX() and aGXYContext.getY()), considering the mode and the ILcdGXYContext instance.
boolean	isMakeLabelsStickyOnEdit() Returns whether the labels this editor edits are made sticky.
boolean	isUseImageCache() Returns true when image caching for labels with a halo is enabled, false otherwise.
boolean	isWithAnchorPoint() Returns whether to draw an anchor point at anchorPointSFCT.
boolean	isWithPin() Returns whether a pin is drawn from the object to the label.
void	labelAnchorPointSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext, Point aPointSFCT) Sets aPointSFCT to the anchor point of the label specified by setObject, setLabelIndex and setSubLabelIndex.
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.
protected void	paintPin(Graphics aGraphics, int aMode, int aStartPointX, int aStartPointY, int aEndPointX, int aEndPointY) Draws a label pin on the given graphics between the given lines.
protected boolean	pinPointSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext, Point aAnchorPoint, Rectangle aLabelBounds, double aRotation, Point aPinPointSFCT) Determines where the pin attaches to the label.
protected void	removeComponentFromGXYView(ILcdGXYView aGXYView, Component aComponent) Removes the specified java.awt.Component from the user interface.
protected String[]	retrieveLabels(int aMode, ILcdGXYContext aGXYContext) Returns an array containing the lines of text for a single label.
protected ILcdPointList	retrievePointList() Retrieves the point list making up the polygon for the valued polygon set on this label painter.
static void	setClassTraceOn(boolean aClassTraceOn) Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
void	setDeclinationFormat(Format aFormat) Sets the format for the magnetic declination value.
void	setGXYInteractiveLabelProvider(ALcdGXYInteractiveLabelProvider aGXYInteractiveLabelProvider) Deprecated. this is controller logic. Use TLcdGXYInteractiveLabelsController instead.
void	setHaloAlgorithm(TLcdHaloAlgorithm aHaloAlgorithm) Sets the algorithm to be used for rendering halo's.
void	setHaloColor(Color aColor) Sets the color of the halo to be added around labels.
void	setHaloEnabled(boolean aHaloEnabled) Switches the halo effect for the labels on or off.
void	setHaloPinColor(Color aColor) Sets the color of the halo to be added around pins.
void	setHaloPinEnabled(boolean aHaloPinEnabled) Sets if the halo effect should be applied to the pin.
void	setHaloThickness(int aThickness) Sets the thickness (in pixels) of the halo to be added around labels.
void	setMakeLabelsStickyOnEdit(boolean aMakeLabelsStickyOnEdit) Sets whether or not this editor should set the label edit mode of the edited labels to include the sticky flag.
void	setObject(Object aObject) Only accepts TLcdValuedPolygon and TLcdValuedContour objects.
void	setPinColor(Color aPinColor) Sets the color in which the pin should be drawn.
void	setProvideInteractiveLabelOnMouseOver(boolean aProvideInteractiveLabelOnMouseOver) Deprecated. this is controller logic. Use TLcdGXYInteractiveLabelsController instead.
void	setSelectedPinColor(Color aSelectedPinColor) Sets the color in which the pin of the label of a selected label should be drawn.
void	setUseImageCache(boolean aUseCache) Sets whether or not labels with halos should be cached as images.
void	setWithAnchorPoint(boolean aWithAnchorPoint) Determines whether to draw an anchor point at anchorPointSFCT.
void	setWithPin(boolean aWithPin) The property withPin determines whether a pin should be drawn from the object to the label.
void	startLabelInteraction(Object aDomainObject, int aLabelIndex, int aSubLabelIndex, ILcdGXYContext aGXYContext) Configure an interactive label for the specified label and show it in the GUI.
boolean	stopLabelInteraction() Stops the interactive label, if there is one.

Methods inherited from class com.luciad.view.gxy.TLcdGXYPolylineLabelPainter

calculateMaxLabelWidth, clone, getBackground, getFont, getForeground, getFrameColor, getFrameLineWidth, getLabelTextAlignmentMode, getPadding, getSelectionColor, getVerticalSpacing, isAntiAliased, isFilled, isFrame, labelBoundsSFCT, labelBoundsSFCT, paintLabel, paintLabels, retrieveLabels, setAntiAliased, setBackground, setFilled, setFont, setForeground, setFrame, setFrameColor, setFrameLineWidth, setGXYLabelStamp, setLabelIndex, setLabelTextAlignmentMode, setPadding, setSelectionColor, setSubLabelIndex, setVerticalSpacing

Methods inherited from class com.luciad.view.gxy.TLcdGXYPolylineStampLabelPainter

anchorPointSFCT, calculateLabelSegment, getAlignment, getMaxNumberPossibilities, getPossibleLocationCount, getPossibleLocationCount, getVGap, indexSegmentFirstPoint, isLabelOnPath, isPaintCache, isRotationAllowed, labelPositionForLocationIndexSFCT, setAlignment, setLabelOnPath, setMaxNumberPossibilities, setPaintCache, setRotationAllowed, setVGap

Methods inherited from class com.luciad.view.gxy.ALcdGXYLabelPainter

addPropertyChangeListener, getLabelCount, getLabelIndex, getLabelLocation, getLocationIndex, getObject, getSubLabelCount, getSubLabelIndex, removePropertyChangeListener, setDisplayName, setLabelLocation, setLocationIndex, supportLabelSnap

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

getLabelLocation, setLabelLocation, supportLabelSnap

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

getLabelCount, getLabelIndex, getSubLabelCount, getSubLabelIndex

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

getLocationIndex, getObject, setLocationIndex

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

getLabelCount, getLabelIndex, getLabelLocation, getObject, getSubLabelCount, getSubLabelIndex, setLabelLocation

Methods inherited from interface com.luciad.util.ILcdPropertyChangeSource

addPropertyChangeListener, removePropertyChangeListener

Constructor Detail

TLcdMagneticNorthGXYLabelPainter

public TLcdMagneticNorthGXYLabelPainter()

Creates a new label painter displaying the declination value.

Method Detail

setObject

public void setObject(Object aObject)

Only accepts TLcdValuedPolygon and TLcdValuedContour objects.

Specified by:

setObject in interface ILcdGXYLabelEditor

Specified by:

setObject in interface ILcdGXYLabelPainter

Specified by:

setObject in interface ILcdGXYLabelPainter2

Overrides:

setObject in class TLcdGXYPolylineLabelPainter

Parameters:

aObject - the object to paint a label for.

See Also:

ILcdGXYLabelPainter.getObject()

getDeclinationFormat

public Format getDeclinationFormat()

Returns the format for the magnetic declination value.

Returns:

the format for the declination value, or null if the value is displayed as is.

setDeclinationFormat

public void setDeclinationFormat(Format aFormat)

Sets the format for the magnetic declination value.

The format needs to accept Double objects in its format method. The Double instances passed to this method are declinations expressed in radians.

Parameters:

aFormat - the format to use for the declination value, or null if the value should be displayed as is.

retrieveLabels

protected String[] retrieveLabels(int aMode,
                                  ILcdGXYContext aGXYContext)

Description copied from class: TLcdGXYPolylineLabelPainter

Returns an array containing the lines of text for a single label.

This method is called to retrieve the actual label text. Each array element is treated as a line of the label defined by setObject, setLabelIndex and setSubLabelIndex. If this method returns null or a zero-length array, no label will be painted.

A text line can contain HTML commands if its content is surrounded by an <html> tag.

By default, this method calls TLcdGXYPolylineLabelPainter.retrieveLabels(com.luciad.view.gxy.ILcdGXYContext), which returns a single line of text (i.e. an array of one String) containing getObject().toString(), or null if the object has an empty toString() result. Override this method to return other text. Never modify the content of the returned array.

This method is only called for the label painter's supported label and sublabel indices. Override the getLabelCount and/or getSubLabelCount methods if you want to define multiple labels per domain object.

Overrides:

retrieveLabels in class TLcdGXYPolylineLabelPainter

Parameters:

aMode - the label painting mode

aGXYContext - the context in which the labels should be painted

Returns:

the set of String objects to be used as label for this object, depending on the mode.

retrievePointList

protected ILcdPointList retrievePointList()

Retrieves the point list making up the polygon for the valued polygon set on this label painter.

Overrides:

retrievePointList in class TLcdGXYPolylineLabelPainter

Returns:

the point list making up the valued polygon.

See Also:

setObject(java.lang.Object)

setGXYInteractiveLabelProvider

@Deprecated
public void setGXYInteractiveLabelProvider(ALcdGXYInteractiveLabelProvider aGXYInteractiveLabelProvider)

Deprecated. this is controller logic. Use TLcdGXYInteractiveLabelsController instead.

Sets the interactive label provider. This method can be called at most once. If the interactive label provider was previously set (with this method or in the constructor), calling this method will throw and IllegalStateException.

Note that to fully enable the functionality, setProvideInteractiveLabelOnMouseOver must be set to true.

Parameters:

aGXYInteractiveLabelProvider - The interactive label provider that will be used to configure and show a component that can, for instance, be used to edit the properties of the labeled domain object. This cannot be null.

Throws:

IllegalStateException - When the interactive label provider was already set.

IllegalArgumentException - When the interactive label provider was null.

See Also:

setProvideInteractiveLabelOnMouseOver(boolean)

getGXYInteractiveLabelProvider

public ALcdGXYInteractiveLabelProvider getGXYInteractiveLabelProvider()

Returns the interactive label provider.

Returns:

The interactive label provider.

See Also:

setGXYInteractiveLabelProvider(ALcdGXYInteractiveLabelProvider)

getComponentForGXYView

protected Component getComponentForGXYView(ILcdGXYView aGXYView)

Gets the component that represents the given ILcdGXYView. By default this is the view itself casted to java.awt.Component. This information is used for handling mouse events.

Override this method if your ILcdGXYView implementation does not extend from java.awt.Component.

Parameters:

aGXYView - The view for which a Component must be retrieved.

Returns:

The java.awt.Component which corresponds to the given ILcdGXYView

Throws:

IllegalArgumentException - By default when aGXYView is not a java.awt.Component

See Also:

ALcdGXYInteractiveLabelProvider.dispatchMouseEvent(java.awt.event.MouseEvent, java.awt.Component, java.awt.Component)

canAddComponentToGXYView

protected boolean canAddComponentToGXYView(ILcdGXYView aGXYView)

Returns whether or not an interactive label can be added to the given view. If this method returns false, addComponentToGXYView must not be called. By default this method checks if the given ILcdGXYView is an instance of java.awt.Container without a layout set on it.

Override this method if your ILcdGXYView implementation is not a java.awt.Container or if you add components to another container than the specified ILcdGXYView.

Parameters:

aGXYView - The ILcdGXYView for which to check if a component can be added.

Returns:

true if a component can be added, false otherwise.

See Also:

addComponentToGXYView(ILcdGXYView, java.awt.Component)

addComponentToGXYView

protected void addComponentToGXYView(ILcdGXYView aGXYView,
                                     Component aComponent)

Adds the specified interactive label to the user interface. By default this method casts the given ILcdGXYView to java.awt.Container and adds the component to the view.

Override this method if your implementation of ILcdGXYView does not extend from java.awt.Container or if you want to add the interactive label to another java.awt.Container because, for instance, you already need to add other components to the specified ILcdGXYView.

If you override this method, you also need to override canAddComponentToGXYView and removeComponentFromGXYView as these methods are closely related to each other.

This method will not be called if canAddComponentToGXYView returns false.

Parameters:

aGXYView - The view to which the interactive label should be added.

aComponent - The interactive label that should be added to the user interface.

Throws:

IllegalArgumentException - By default if aGXYView is not an instance of java.awt.Container or if the layout of aGXYView is not null.

See Also:

canAddComponentToGXYView(ILcdGXYView), removeComponentFromGXYView(ILcdGXYView, java.awt.Component)

removeComponentFromGXYView

protected void removeComponentFromGXYView(ILcdGXYView aGXYView,
                                          Component aComponent)

Removes the specified java.awt.Component from the user interface. By default this method casts the specified ILcdGXYView to java.awt.Container and removes the component from that container.

Override this method if you have overridden addComponentToGXYView.

Parameters:

aGXYView - The view from which the interactive label should be removed.

aComponent - The interactive label that should be removed from the user interface

Throws:

IllegalArgumentException - By default if the view does not extend from java.awt.Container

startLabelInteraction

public void startLabelInteraction(Object aDomainObject,
                                  int aLabelIndex,
                                  int aSubLabelIndex,
                                  ILcdGXYContext aGXYContext)

Configure an interactive label for the specified label and show it in the GUI.

Parameters:

aDomainObject - The domain object for which to display an interactive label.

aLabelIndex - The index of the label for which an interactive label should be displayed.

aSubLabelIndex - The index of the sublabel for which an interactive label should be displayed.

aGXYContext - An instance of ILcdGXYContext containing the layer and the view for which the label should be made interactive

canStopLabelInteraction

public boolean canStopLabelInteraction()

Returns whether or not the label interaction can be stopped. For instance, when the interactive label contains invalid text, this method should return false.

Returns:

true if the label interaction can be stopped, false otherwise.

stopLabelInteraction

public boolean stopLabelInteraction()

Stops the interactive label, if there is one. The interactive label will commit any outstanding changes.

Returns:

true if the interactive label could be stopped or if there was no interactive label, false otherwise.

See Also:

canStopLabelInteraction(), ALcdGXYInteractiveLabelProvider.stopInteraction()

cancelLabelInteraction

public void cancelLabelInteraction()

Cancels the interactive label, if there is one. This prevents the interactive label from committing any changes.

getDomainObjectForInteractiveLabel

public Object getDomainObjectForInteractiveLabel()

Returns the domain object for the interactive label, or null if there is no interactive label.

Returns:

The domain object for the interactive label, or null if there is no interactive label.

setProvideInteractiveLabelOnMouseOver

@Deprecated
public void setProvideInteractiveLabelOnMouseOver(boolean aProvideInteractiveLabelOnMouseOver)

Deprecated. this is controller logic. Use TLcdGXYInteractiveLabelsController instead.

Enables the ALcdGXYInteractiveLabelProvider functionality, so that the interactive label is present when the mouse hoovers over a label. This flag is typically enabled/disabled whenever the interactive label functionality is desired/not wanted. For example, the interactive labels could only be desired when a certain ILcdGXYController is active.

Parameters:

aProvideInteractiveLabelOnMouseOver - true to activate the ALcdGXYInteractiveLabelProvider, false otherwise.

See Also:

setGXYInteractiveLabelProvider

isLabelTouched

public boolean isLabelTouched(Graphics aGraphics,
                              int aMode,
                              ILcdGXYContext aGXYContext)

Description copied from interface: ILcdGXYLabelPainter2

Tests if the label specified by setObject, setLabelIndex and setSubLabelIndex is touched at view location (specified by aGXYContext.getX() and aGXYContext.getY()), considering the mode and the ILcdGXYContext instance.

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.

Specified by:

isLabelTouched in interface ILcdGXYLabelPainter2

Parameters:

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

aMode - the mode to consider. This is a bitwise combinations of several constants. See ILcdGXYLabelPainter2.paintLabel(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext) for more information.

aGXYContext - the ILcdGXYContext to consider.

Returns:

true if the representation of the Object returned by getObject() is touched, false otherwise

See Also:

ILcdGXYContext

labelAnchorPointSFCT

public void labelAnchorPointSFCT(Graphics aGraphics,
                                 int aMode,
                                 ILcdGXYContext aGXYContext,
                                 Point aPointSFCT)
                          throws TLcdNoBoundsException

Description copied from interface: ILcdGXYLabelPainter2

Sets aPointSFCT to the anchor point of the label specified by setObject, setLabelIndex and setSubLabelIndex.

If the location index is less than 0, the label anchor point is unambiguously determined by the label location. The actual label is to be painted somewhere around this anchor point. This method is typically called to compare the result with the label bounds, thus determining the exact relation between the label and its location.

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.

Specified by:

labelAnchorPointSFCT in interface ILcdGXYLabelPainter2

Parameters:

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

aMode - The mode to consider. This can be a bitwise combination of several constants. See ILcdGXYLabelPainter2.paintLabel(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext) for more information.

aGXYContext - The ILcdGXYContext that can be used to retrieve extra information.

aPointSFCT - The point which will be updated to reflect the location of the anchor point.

Throws:

TLcdNoBoundsException - if the Object doesn't have any valid anchor point, e.g. if it is always invisible in the current projection.

See Also:

ILcdGXYLabelPainter2.paintLabel(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext), ILcdGXYLabelPainter2.getLabelLocation(), ILcdGXYLabelPainter2.labelBoundsSFCT(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext, java.awt.Rectangle)

editLabel

public boolean editLabel(Graphics aGraphics,
                         int aMode,
                         ILcdGXYContext aGXYContext)

Description copied from interface: ILcdGXYLabelEditor

Adapts the set TLcdLabelLocation according to the information present in aGXYContext. If the method returns true, the TLcdLabelLocation was modified, if false is returned, it wasn't changed.

The implementation of this method shall define how to edit the label specified by the set domain Object , label index and sublabel index, considering the given mode and aGXYContext. These should all be set before calling this method. Note that if aMode is one of the creating modes, the (sub) label indices are irrelevant.

Specified by:

editLabel in interface ILcdGXYLabelEditor

Parameters:

aGraphics - The Graphics on which the label is painted.

aMode - the mode to consider when editing aObject: aMode shall be a combination of

• ILcdGXYLabelEditor.TRANSLATED,
• ILcdGXYLabelEditor.RESHAPED,
• ILcdGXYLabelEditor.START_CREATION,
• ILcdGXYLabelEditor.CREATING,
• ILcdGXYLabelEditor.END_CREATION.

.

aGXYContext - contains the information to consider when editing the set Object.

Returns:

true if the label of the set Object has changed, false otherwise.

See Also:

ILcdGXYContext

labelSnapTarget

public Object labelSnapTarget(Graphics aGraphics,
                              ILcdGXYContext aGXYContext)

Description copied from class: ALcdGXYLabelPainter

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

Overrides:

labelSnapTarget in class ALcdGXYLabelPainter

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.

getGXYLabelPainter

public ILcdGXYLabelPainter getGXYLabelPainter(Object aObject)

Description copied from interface: ILcdGXYLabelPainterProvider

Finds an ILcdGXYLabelPainter that can be used to label the object passed.

The label painter provider is responsible for setting the object to the label painter before returning the label painter. An implementation should therefore have the following structure:

 public ILcdGXYLabelPainter getGXYLabelPainter(Object aObject) {
   ILcdGXYLabelPainter labelPainter = ... // find the label painter for the object
   if (labelPainter != null) {
    labelPainter.setObject(aObject);
   }
   return labelPainter;
 }
 

Specified by:

getGXYLabelPainter in interface ILcdGXYLabelPainterProvider

Parameters:

aObject - the object to find a label painter for

Returns:

a label painter that can be used to label the object; or null if no label painter could be found for the given object, or the object could not be set on the retrieved label painter.

getGXYLabelEditor

public ILcdGXYLabelEditor getGXYLabelEditor(Object aObject)

Description copied from interface: ILcdGXYLabelEditorProvider

Returns a valid ILcdGXYLabelEditor for editing the labels of aObject. The returned ILcdGXYLabelEditor must have aObject set on it. The TLcdLabelLocation must not yet be set on it.

Specified by:

getGXYLabelEditor in interface ILcdGXYLabelEditorProvider

Parameters:

aObject - the Object for which to obtain a ILcdGXYLabelEditor.

Returns:

a valid ILcdGXYLabelEditor for editing the labels of aObject with aObject set on it.

See Also:

ILcdGXYLabelEditor.setObject(java.lang.Object)

getGXYLabelStamp

public ALcdGXYLabelStamp getGXYLabelStamp()

Returns the ALcdGXYLabelStamp that is used by this painter to paint the labels.

Returns:

The ALcdGXYLabelStamp that is used by this painter to paint the labels.

See Also:

setGXYLabelStamp(ALcdGXYLabelStamp)

firePropertyChangeEvent

protected void firePropertyChangeEvent(PropertyChangeEvent aPropertyChangeEvent)

Description copied from class: ALcdGXYLabelPainter

Notifies the registered PropertyChangeListeners of the specified event.

Overrides:

firePropertyChangeEvent in class ALcdGXYLabelPainter

Parameters:

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

See Also:

ALcdGXYLabelPainter.addPropertyChangeListener(java.beans.PropertyChangeListener)

getDisplayName

public String getDisplayName()

Description copied from class: ALcdGXYLabelPainter

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

Specified by:

getDisplayName in interface ILcdGXYLabelEditor

Specified by:

getDisplayName in interface ILcdGXYLabelPainter2

Overrides:

getDisplayName in class ALcdGXYLabelPainter

Returns:

the display name of this ILcdGXYLabelPainter2

getLabelCursor

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

Description copied from class: ALcdGXYLabelPainter

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

Overrides:

getLabelCursor in class ALcdGXYLabelPainter

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.

acceptSnapTargetForLabel

public boolean acceptSnapTargetForLabel(Graphics aGraphics,
                                        ILcdGXYContext aGXYContext)

Description copied from interface: ILcdGXYLabelEditor

Returns whether the label specified by setObject, setLabelIndex and setSubLabelIndex accepts the snap target in the given ILcdGXYContext.

The snap target is the Object returned by aGXYContext.getSnapTarget(), and is on the ILcdGXYLayer returned by aGXYContext.getSnapTargetLayer().

Specified by:

acceptSnapTargetForLabel in interface ILcdGXYLabelEditor

Parameters:

aGraphics - The Graphics on which the label is painted.

aGXYContext - The ILcdGXYContext containing the snapping information.

Returns:

true if the label accepts the snap target, false otherwise.

See Also:

ILcdGXYContext.getSnapTarget(), ILcdGXYContext.getSnapTargetLayer()

setMakeLabelsStickyOnEdit

public void setMakeLabelsStickyOnEdit(boolean aMakeLabelsStickyOnEdit)

Sets whether or not this editor should set the label edit mode of the edited labels to include the sticky flag. This means the labels will no longer be automatically moved by the decluttering algorithm.

Parameters:

aMakeLabelsStickyOnEdit - true if you want the labels to be sticky after they are edited, false otherwise.

See Also:

TLcdLabelLocation.getLabelEditMode(), ILcdGXYViewLabelPainter, ILcdGXYLayerLabelPainter

isMakeLabelsStickyOnEdit

public boolean isMakeLabelsStickyOnEdit()

Returns whether the labels this editor edits are made sticky.

Returns:

true if this editor sets the labels it edits to be sticky, false otherwise. The default value is false.

See Also:

setMakeLabelsStickyOnEdit(boolean)

getLabelCreationClickCount

public int getLabelCreationClickCount()

Description copied from interface: ILcdGXYLabelEditor

Returns the number of points required to initialize the label of the set Object.

Specified by:

getLabelCreationClickCount in interface ILcdGXYLabelEditor

Returns:

the number of points required to initialize the label of the set Object or -1 if this is undefined like for a polyline or a polygon. 0 means graphical creation of labels is not supported.

getPinColor

public Color getPinColor()

Returns the color in which the pin is drawn.

Returns:

The color in which the pin is drawn.

See Also:

setPinColor(java.awt.Color)

setPinColor

public void setPinColor(Color aPinColor)

Sets the color in which the pin should be drawn.

Parameters:

aPinColor - The color in which the pin should be drawn.

See Also:

getPinColor(), setWithPin(boolean)

getSelectedPinColor

public Color getSelectedPinColor()

Returns the color in which the pin should be drawn of the label of a selected object.

Returns:

The color in which the pin should be drawn of the label of a selected object.

setSelectedPinColor

public void setSelectedPinColor(Color aSelectedPinColor)

Sets the color in which the pin of the label of a selected label should be drawn.

Parameters:

aSelectedPinColor - The color in which the pin of the label of a selected label should be drawn.

See Also:

setWithPin(boolean)

isHaloEnabled

public boolean isHaloEnabled()

Returns true if the halo effect is on for the labels, false otherwise.

Returns:

true if the halo effect is on, false otherwise

See Also:

setHaloEnabled(boolean)

setHaloEnabled

public void setHaloEnabled(boolean aHaloEnabled)

Switches the halo effect for the labels on or off.

Parameters:

aHaloEnabled - true if halos should be added, false otherwise

See Also:

isHaloEnabled(), setHaloPinEnabled(boolean)

isHaloPinEnabled

public boolean isHaloPinEnabled()

Returns true if the halo effect also includes the pin.

Returns:

true if the halo effect includes the pin, false otherwise

See Also:

setHaloPinEnabled(boolean), setHaloEnabled(boolean)

setHaloPinEnabled

public void setHaloPinEnabled(boolean aHaloPinEnabled)

Sets if the halo effect should be applied to the pin. This only has effect when the pin is enabled.

Parameters:

aHaloPinEnabled - true if the halo effect includes the pin, false otherwise

See Also:

isHaloPinEnabled(), setHaloEnabled(boolean), setWithPin(boolean)

getHaloThickness

public int getHaloThickness()

Returns the current halo thickness.

Returns:

the current halo thickness

See Also:

setHaloThickness(int)

setHaloThickness

public void setHaloThickness(int aThickness)

Sets the thickness (in pixels) of the halo to be added around labels.

Parameters:

aThickness - the new halo thickness

See Also:

TLcdGXYHaloLabelPainter.setHaloThickness(int), setHaloEnabled(boolean)

getHaloColor

public Color getHaloColor()

Returns the current halo color.

Returns:

the current halo color

See Also:

setHaloColor(java.awt.Color)

setHaloColor

public void setHaloColor(Color aColor)

Sets the color of the halo to be added around labels.

Parameters:

aColor - the new halo color

See Also:

TLcdGXYHaloLabelPainter.setHaloColor(java.awt.Color), setHaloEnabled(boolean)

setHaloAlgorithm

public void setHaloAlgorithm(TLcdHaloAlgorithm aHaloAlgorithm)

Sets the algorithm to be used for rendering halo's. The choice of the halo algorithm may have a major impact on the overall performance of this painter. See TLcdHaloAlgorithm for more information on the available algorithms.

Parameters:

aHaloAlgorithm - the algorithm to be used for rendering halo's.

See Also:

TLcdHaloAlgorithm, getHaloAlgorithm(), setHaloEnabled(boolean)

getHaloAlgorithm

public TLcdHaloAlgorithm getHaloAlgorithm()

Returns the algorithm that is used for rendering halo's.

Returns:

the algorithm that is used for rendering halo's.

See Also:

TLcdHaloAlgorithm, setHaloAlgorithm(com.luciad.util.TLcdHaloAlgorithm)

getHaloPinColor

public Color getHaloPinColor()

Returns the current halo pin color.

Returns:

the current halo pin color

See Also:

setHaloColor(java.awt.Color)

setHaloPinColor

public void setHaloPinColor(Color aColor)

Sets the color of the halo to be added around pins.

Parameters:

aColor - the new halo color

See Also:

getHaloPinColor(), setHaloPinEnabled(boolean)

isUseImageCache

public boolean isUseImageCache()

Returns true when image caching for labels with a halo is enabled, false otherwise.

Returns:

true when label image caching is enabled, false otherwise

See Also:

setUseImageCache(boolean)

setUseImageCache

public void setUseImageCache(boolean aUseCache)

Sets whether or not labels with halos should be cached as images. Creating a halo for a label is an expensive operation, so enabling image caching can considerably improve performance.

Parameters:

aUseCache - specifies whether image caching should be enabled

See Also:

TLcdGXYHaloLabelPainter.setUseImageCache(boolean), setHaloEnabled(boolean), setHaloPinEnabled(boolean), isUseImageCache()

clearImageCache

public void clearImageCache()

Clears the entire label image cache. To remove a single label from the cache, use clearImageCache(Object).

See Also:

setUseImageCache(boolean)

clearImageCache

public void clearImageCache(Object aObject)

Clears the label image cache for the given object. The next time this object is painted, a new image will be created and cached for it. To remove all cached images in one go, use clearImageCache().

Parameters:

aObject - the object for which the cache to be cleared.

See Also:

setUseImageCache(boolean)

pinPointSFCT

protected boolean pinPointSFCT(Graphics aGraphics,
                               int aMode,
                               ILcdGXYContext aGXYContext,
                               Point aAnchorPoint,
                               Rectangle aLabelBounds,
                               double aRotation,
                               Point aPinPointSFCT)

Determines where the pin attaches to the label. This implementation attaches the pin on the label bounds, with the pin going towards the center of the label bounds.

Parameters:

aGraphics - The Graphics instance on which the pin will be painted.

aMode - The mode in which the pin will be painted. See paintLabel(java.awt.Graphics, int, ILcdGXYContext) for more information.

aGXYContext - The instance containing the context in which the pin will be painted.

aAnchorPoint - The point in AWT coordinates where the pin attaches to the object representation (see #anchorPointSFCT)

aLabelBounds - The bounds of the label in AWT coordinates.

aRotation - The rotation of the label in radians, positive going from the x to the y axis

aPinPointSFCT - The point in AWT coordinates where the pin attaches to the label

Returns:

Whether or not the pin needs to be drawn.

See Also:

anchorPointSFCT(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext, java.awt.Point), setWithPin(boolean)

paintPin

protected void paintPin(Graphics aGraphics,
                        int aMode,
                        int aStartPointX,
                        int aStartPointY,
                        int aEndPointX,
                        int aEndPointY)

Draws a label pin on the given graphics between the given lines. Overwrite this method if you want to change the look of the pin, for example by manipulating the graphics passed.

Parameters:

aGraphics - the graphics to paint the pin on.

aMode - the mode this objects label is painted in (e.g. ILcdGXYLabelPainter.SELECTED).

aStartPointX - the x coordinate of the start point of the pin.

aStartPointY - the y coordinate of the start point of the pin.

aEndPointX - the x coordinate of the end point of the pin.

aEndPointY - the y coordinate of the end point of the pin.

See Also:

setWithPin(boolean)

setWithPin

public void setWithPin(boolean aWithPin)

The property withPin determines whether a pin should be drawn from the object to the label. The pin is attached to the object at the anchor point and to the label stamp at the pin point.

Parameters:

aWithPin - true to paint a pin connecting the label and the object.

See Also:

isWithPin(), anchorPointSFCT(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext, java.awt.Point), pinPointSFCT(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext, java.awt.Point, java.awt.Rectangle, double, java.awt.Point), paintPin(java.awt.Graphics, int, int, int, int, int)

isWithPin

public boolean isWithPin()

Returns whether a pin is drawn from the object to the label.

Returns:

true if a pin is drawn from the object to the label

See Also:

setWithPin(boolean)

setWithAnchorPoint

public void setWithAnchorPoint(boolean aWithAnchorPoint)

Determines whether to draw an anchor point at anchorPointSFCT.

Parameters:

aWithAnchorPoint - true to paint an anchor point

See Also:

isWithAnchorPoint(), anchorPointSFCT(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext, java.awt.Point), paintAnchorPoint(java.awt.Graphics, int, int, int)

isWithAnchorPoint

public boolean isWithAnchorPoint()

Returns whether to draw an anchor point at anchorPointSFCT.

Returns:

true if an anchor point is painted, false otherwise

See Also:

setWithAnchorPoint(boolean)

setClassTraceOn

public static void setClassTraceOn(boolean aClassTraceOn)

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Enables tracing for all instances of this class. If the argument is true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

Parameters:

aClassTraceOn - if true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.