Class TLcdGXYFeaturedLabelPainter
- All Implemented Interfaces:
ILcdPropertyChangeSource
,ILcdGXYLabelEditor
,ILcdGXYLabelEditorProvider
,ILcdGXYLabelPainter
,ILcdGXYLabelPainter2
,ILcdGXYLabelPainterProvider
,ILcdGXYMultiLabelPainter
,Serializable
,Cloneable
TLcdGXYLabelPainter
that retrieves the label content through
the ILcdFeatured
interface instead of using object.toString()
.
It therefore assumes that the object of the label to paint (given in TLcdGXYLabelPainter.setObject(Object)
)
implements the ILcdFeatured
interface. In order to build the label content
(see retrieveLabels
), it then retrieves
the feature values (see ILcdFeatured.getFeature(int)
) corresponding to the feature
indices specified using setFeatureIndices(int[])
.
Note that, because this painter uses the same list of indices for all objects, it cannot
be used if all the ILcdFeatured
objects have different feature counts. In that
case, it is advised to tailor retrieveLabels(int, ILcdGXYContext)
to the
specific needs.- See Also:
-
Field Summary
Fields inherited from class com.luciad.view.gxy.TLcdGXYLabelPainter
LABEL_TEXT_ALIGNMENT_CENTER, LABEL_TEXT_ALIGNMENT_DEFAULT, LABEL_TEXT_ALIGNMENT_LEFT, LABEL_TEXT_ALIGNMENT_RIGHT
Fields inherited from class com.luciad.view.gxy.TLcdGXYStampLabelPainter
CENTER, EAST, MAXIMUM_AVAILABLE_LOCATIONS, NORTH, NORTH_EAST, NORTH_WEST, SOUTH, SOUTH_EAST, SOUTH_WEST, WEST
Fields inherited from interface com.luciad.view.gxy.ILcdGXYLabelEditor
CREATING, END_CREATION, RESHAPED, START_CREATION, TRANSLATED
Fields inherited from interface com.luciad.view.gxy.ILcdGXYLabelPainter
DEFAULT, SELECTED
Fields inherited from interface com.luciad.view.gxy.ILcdGXYLabelPainter2
BODY, CREATING, HANDLES, RESHAPING, SNAPS, TRANSLATING
-
Constructor Summary
ConstructorDescriptionCreates a newTLcdGXYFeaturedLabelPainter
.TLcdGXYFeaturedLabelPainter
(ALcdGXYInteractiveLabelProvider aGXYInteractiveLabelProvider) Creates a newTLcdGXYFeaturedLabelPainter
.TLcdGXYFeaturedLabelPainter
(TLcdGXYFeaturedLabelPainter aGXYLabelPainterFeatured) Copy constructor. -
Method Summary
Modifier and TypeMethodDescriptionboolean
acceptSnapTargetForLabel
(Graphics aGraphics, ILcdGXYContext aGXYContext) Returns whether the label specified bysetObject
,setLabelIndex
andsetSubLabelIndex
accepts the snap target in the givenILcdGXYContext
.protected void
addComponentToGXYView
(ILcdGXYView aGXYView, Component aComponent) Adds the specified interactive label to the user interface.protected void
anchorPointSFCT
(Graphics aGraphics, int aMode, ILcdGXYContext aContext, Point aPointSFCT) Retrieves an anchor point that is used to determine where the pin of the label (specified bysetObject
,setLabelIndex
andsetSubLabelIndex
) attaches to the object representation.protected boolean
canAddComponentToGXYView
(ILcdGXYView aGXYView) Returns whether or not an interactive label can be added to the given view.void
Cancels the interactive label, if there is one.boolean
Returns whether or not the label interaction can be stopped.void
Clears the entire label image cache.void
clearImageCache
(Object aObject) Clears the label image cache for the given object.clone()
Returns a new instance of thisALcdGXYLabelPainter
.boolean
editLabel
(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext) Adapts the setTLcdLabelLocation
according to the information present in aGXYContext.protected void
firePropertyChangeEvent
(PropertyChangeEvent aPropertyChangeEvent) Notifies the registeredPropertyChangeListener
s of the specified event.protected Component
getComponentForGXYView
(ILcdGXYView aGXYView) Gets the component that represents the givenILcdGXYView
.This default implementation returns the display name set withsetDisplayName
, ortoString()
if this was set tonull
.Returns the domain object for the interactive label, ornull
if there is no interactive label.int[]
featureIndices
is the property that defines the indices of the features whose value (String
) objects should be added to the label of theILcdFeatured
objects.Returns the interactive label provider.getGXYLabelEditor
(Object aObject) Returns a validILcdGXYLabelEditor
for editing the labels of aObject.Returns theALcdGXYLabelStamp
that is used by this painter to paint the labels.Returns the algorithm that is used for rendering halo's.Returns the current halo color.Returns the current halo pin color.int
Returns the current halo thickness.int
Returns the number of points required to initialize the label of the setObject
.getLabelCursor
(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext) Returns aCursor
to indicate the type of editingaMode
andaGXYContext
.Returns the color in which the pin is drawn.getPositionAsString
(int aPosition) Returns the string representation of the given position of the labels relative to the anchor point.int[]
Returns the list of possible positions to place the labels.String[]
Gets theString
representations of the current position list.int
getPossibleLocationCount
(Graphics aGraphics) Returns the number of possible locations to use (starting from the default position).Returns the color in which the pin should be drawn of the label of a selected object.int
Returns how many pixels the label must be removed from the anchor point of the domain object.boolean
Returns true if the halo effect is on for the labels, false otherwise.boolean
Returns true if the halo effect also includes the pin.boolean
isLabelTouched
(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext) Tests if the label specified bysetObject
,setLabelIndex
andsetSubLabelIndex
is touched at view location(specified by aGXYContext.getX()
andaGXYContext.getY()
), considering the mode and theILcdGXYContext
instance.boolean
Returns whether the labels this editor edits are made sticky.boolean
Returnstrue
when image caching for labels with a halo is enabled,false
otherwise.boolean
Returns whether to draw an anchor point atanchorPointSFCT
.boolean
Returns whether a pin is drawn from the object to the label.void
labelAnchorPointSFCT
(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext, Point aPointSFCT) SetsaPointSFCT
to the anchor point of the label specified bysetObject
,setLabelIndex
andsetSubLabelIndex
.double
labelBoundsSFCT
(Graphics aGraphics, int aMode, ILcdGXYContext aContext, Rectangle aRectangle) Calculates the bounds of the label that can be painted.labelSnapTarget
(Graphics aGraphics, ILcdGXYContext aGXYContext) Returns anObject
that can be used as snapping target when graphically editing anotherObject
or label than the one this ILcdGXYLabelPainter2 represents.protected void
removeComponentFromGXYView
(ILcdGXYView aGXYView, Component aComponent) Removes the specifiedjava.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.static void
setClassTraceOn
(boolean aClassTraceOn) Deprecated.This method has been deprecated.void
setFeatureIndices
(int[] newFeatureIndices) featureIndices
is the property that defines the indices of the features whose value (String
) objects should be added to the label of theILcdFeatured
objects.void
setGXYInteractiveLabelProvider
(ALcdGXYInteractiveLabelProvider aGXYInteractiveLabelProvider) Deprecated.this is controller logic.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
setPinColor
(Color aPinColor) Sets the color in which the pin should be drawn.void
setPositionList
(int[] aPositionList) Sets a new position list.void
setPositionListAsString
(String[] aPositionList) The labels can occupy various positions relative to the anchor point (see description above).void
setProvideInteractiveLabelOnMouseOver
(boolean aProvideInteractiveLabelOnMouseOver) Deprecated.this is controller logic.void
setSelectedPinColor
(Color aSelectedPinColor) Sets the color in which the pin of the label of a selected label should be drawn.void
setShiftLabelPosition
(int aShift) Sets how many pixels the label must be removed from the anchor point of the domain object.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 atanchorPointSFCT
.void
setWithPin
(boolean aWithPin) The propertywithPin
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
Stops the interactive label, if there is one.Methods inherited from class com.luciad.view.gxy.TLcdGXYLabelPainter
calculateMaxLabelWidth, getBackground, getFont, getForeground, getFrameColor, getGXYLabelPainter, getLabelTextAlignmentMode, getPadding, getPinPointSFCT, getSelectionColor, getUpperLeftPointSFCT, getVerticalSpacing, isAntiAliased, isConsiderPinForBounds, isFilled, isFrame, labelPositionForLocationIndexSFCT, paintLabel, paintLabel, paintPin, pinPointSFCT, retrieveLabels, setAntiAliased, setBackground, setConsiderPinForBounds, setFilled, setFont, setForeground, setFrame, setFrameColor, setGXYLabelStamp, setLabelIndex, setLabelTextAlignmentMode, setObject, setPadding, setSelectionColor, setSubLabelIndex, setVerticalSpacing
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.ILcdGXYLabelEditor
getLabelCount, getLabelIndex, getLabelLocation, getObject, getSubLabelCount, getSubLabelIndex, setLabelLocation
Methods inherited from interface com.luciad.view.gxy.ILcdGXYLabelPainter
getLocationIndex, getObject, getPossibleLocationCount, setLocationIndex
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.util.ILcdPropertyChangeSource
addPropertyChangeListener, removePropertyChangeListener
-
Constructor Details
-
TLcdGXYFeaturedLabelPainter
public TLcdGXYFeaturedLabelPainter()Creates a newTLcdGXYFeaturedLabelPainter
. Define the desired label content usingsetFeatureIndices(int[])
. -
TLcdGXYFeaturedLabelPainter
Copy constructor.- Parameters:
aGXYLabelPainterFeatured
- TheTLcdGXYFeaturedLabelPainter
to clone.
-
TLcdGXYFeaturedLabelPainter
Creates a newTLcdGXYFeaturedLabelPainter
. Define the desired label content usingsetFeatureIndices(int[])
.- Parameters:
aGXYInteractiveLabelProvider
- The interactive label provider that should be used. SeesetGXYInteractiveLabelProvider
for more details.
-
-
Method Details
-
getFeatureIndices
public int[] getFeatureIndices()featureIndices
is the property that defines the indices of the features whose value (String
) objects should be added to the label of theILcdFeatured
objects.- Returns:
- the property featureIndices.
-
setFeatureIndices
public void setFeatureIndices(int[] newFeatureIndices) featureIndices
is the property that defines the indices of the features whose value (String
) objects should be added to the label of theILcdFeatured
objects. Sets the propertyfeatureIndices
tonewFeatureIndices
.- Parameters:
newFeatureIndices
- The feature indices to use. They are assumed to be valid indices:0 <= newFeatureIndices[i] <
for every i and for everyILcdFeatured.getFeatureCount()
ILcdFeatured
object given inTLcdGXYLabelPainter.setObject(Object)
(e.g., all objects that are painted).
-
retrieveLabels
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
andsetSubLabelIndex
. If this method returns null or a zero-length array, no label will be painted. If this method returns an array containing an empty String, a label is painted without text (decorations like pin and frame are painted).A text line can contain HTML commands if its content is surrounded by an
<html>
tag. The HTML support is limited to what is supported by Swing.By default, this method calls
TLcdGXYLabelPainter.retrieveLabels(com.luciad.view.gxy.ILcdGXYContext)
, which returns a single line of text (i.e. an array of oneString
) containinggetObject().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 may only be called for the label painter's supported label and sublabel indices. Override the
getLabelCount
and/orgetSubLabelCount
methods if you want to define multiple labels per domain object.This implementation tries to cast the object into an
ILcdFeatured
. If it succeeds, it returns, in aString
array, the values of theILcdFeatured
for the indices specified ingetFeatureIndices()
. If not, it returnssuper.retrieveLabels()
. The modeaMode
is ignored.- Overrides:
retrieveLabels
in classTLcdGXYLabelPainter
- Parameters:
aMode
- the label painting mode. SeeILcdGXYLabelPainter2.paintLabel(java.awt.Graphics, int, ILcdGXYContext)
for more information about the mode.aGXYContext
- the context in which the label is painted.- Returns:
- the return value of the method
TLcdGXYLabelPainter.retrieveLabels(ILcdGXYContext)
. - See Also:
-
clone
Description copied from class:ALcdGXYLabelPainter
Returns a new instance of thisALcdGXYLabelPainter
. 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 interfaceILcdGXYLabelEditor
- Specified by:
clone
in interfaceILcdGXYLabelEditorProvider
- Specified by:
clone
in interfaceILcdGXYLabelPainter
- Specified by:
clone
in interfaceILcdGXYLabelPainter2
- Specified by:
clone
in interfaceILcdGXYLabelPainterProvider
- Overrides:
clone
in classTLcdGXYLabelPainter
- Returns:
- A new instance of this
ALcdGXYLabelPainter
of which the label location is a deep clone.
-
getPossibleLocationCount
Returns the number of possible locations to use (starting from the default position).- Parameters:
aGraphics
- the Graphics the label will be painted on. Not used in this implementation.- Returns:
- the number of possible locations to use (starting from the default position).
- See Also:
-
setPositionList
public void setPositionList(int[] aPositionList) Sets a new position list. This list is only used when the labels are not placed freely. By default, all supported positions are offered: SOUTH_EAST, NORTH_WEST, NORTH_EAST, SOUTH_WEST, EAST, WEST, NORTH, SOUTH, and CENTER. See
setShiftLabelPosition(int)
for how these positions affect the label.- Parameters:
aPositionList
- the list of possible positions to place the labels.- See Also:
-
getPositionList
public int[] getPositionList()Returns the list of possible positions to place the labels.- Returns:
- the list of possible positions to place the labels.
- See Also:
-
setPositionListAsString
The labels can occupy various positions relative to the anchor point (see description above). The following entries for theString
objects are valid (independent of the font case):- "C" or "center".
- "N" or "north".
- "S" or "south".
- "E" or "east".
- "W" or "west".
- "SE" or "southeast"
- "NE" or "northeast"
- "SW" or "southwest"
- "NW" or "northwest"
- Parameters:
aPositionList
- the list of possible positions to place labels givens as Strings objects.- See Also:
-
getPositionListAsString
Gets theString
representations of the current position list.- Returns:
- the
String
representations of the current position list. - See Also:
-
getPositionAsString
Returns the string representation of the given position of the labels relative to the anchor point.- Parameters:
aPosition
- the integer code for a position. Can be any of SOUTH_EAST, SOUTH, SOUTH_WEST, WEST, NORTH_WEST, NORTH, NORTH_EAST, EAST or CENTER.- Returns:
- the string representation of the given position of the labels relative to the anchor point.
- See Also:
-
setShiftLabelPosition
public void setShiftLabelPosition(int aShift) Sets how many pixels the label must be removed from the anchor point of the domain object. If the position of the label is
east
orwest
, this shift is applied in horizontal direction; if the position isnorth
orsouth
, this shift is applied in vertical direction. In case ofnorth east
,south east
,south west
ornorth west
, this shift is applied in both directions. If the location of the label iscenter
, the shift is ignored.The default for this value is
8
pixels.- Parameters:
aShift
- the distance, expressed in pixels, that the label must be removed from the domain object.- See Also:
-
getShiftLabelPosition
public int getShiftLabelPosition()Returns how many pixels the label must be removed from the anchor point of the domain object.- Returns:
- the distance, expressed in pixels, that the label must be removed from the domain object.
- See Also:
-
setGXYInteractiveLabelProvider
@Deprecated public void setGXYInteractiveLabelProvider(ALcdGXYInteractiveLabelProvider aGXYInteractiveLabelProvider) Deprecated.this is controller logic. UseTLcdGXYInteractiveLabelsController
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
Note that to fully enable the functionality,IllegalStateException
.setProvideInteractiveLabelOnMouseOver
must be set totrue
.- 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 benull
.- Throws:
IllegalStateException
- When the interactive label provider was already set.IllegalArgumentException
- When the interactive label provider wasnull
.- See Also:
-
getGXYInteractiveLabelProvider
Returns the interactive label provider.- Returns:
- The interactive label provider.
- See Also:
-
getComponentForGXYView
Gets the component that represents the given
ILcdGXYView
. By default this is the view itself casted tojava.awt.Component
. This information is used for handling mouse events.Override this method if your
ILcdGXYView
implementation does not extend fromjava.awt.Component
.- Parameters:
aGXYView
- The view for which aComponent
must be retrieved.- Returns:
- The
java.awt.Component
which corresponds to the givenILcdGXYView
- Throws:
IllegalArgumentException
- By default whenaGXYView
is not ajava.awt.Component
- See Also:
-
canAddComponentToGXYView
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 givenILcdGXYView
is an instance ofjava.awt.Container
without a layout set on it.Override this method if your
ILcdGXYView
implementation is not ajava.awt.Container
or if you add components to another container than the specifiedILcdGXYView
.- Parameters:
aGXYView
- TheILcdGXYView
for which to check if a component can be added.- Returns:
true
if a component can be added,false
otherwise.- See Also:
-
addComponentToGXYView
Adds the specified interactive label to the user interface. By default this method casts the given
ILcdGXYView
tojava.awt.Container
and adds the component to the view.Override this method if your implementation of
ILcdGXYView
does not extend fromjava.awt.Container
or if you want to add the interactive label to anotherjava.awt.Container
because, for instance, you already need to add other components to the specifiedILcdGXYView
.If you override this method, you also need to override
canAddComponentToGXYView
andremoveComponentFromGXYView
as these methods are closely related to each other.This method will not be called if
canAddComponentToGXYView
returnsfalse
.- 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 ifaGXYView
is not an instance ofjava.awt.Container
or if the layout ofaGXYView
is not null.- See Also:
-
removeComponentFromGXYView
Removes the specified
java.awt.Component
from the user interface. By default this method casts the specifiedILcdGXYView
tojava.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 fromjava.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 ofILcdGXYContext
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:
-
cancelLabelInteraction
public void cancelLabelInteraction()Cancels the interactive label, if there is one. This prevents the interactive label from committing any changes. -
getDomainObjectForInteractiveLabel
Returns the domain object for the interactive label, ornull
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. UseTLcdGXYInteractiveLabelsController
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 certainILcdGXYController
is active.- Parameters:
aProvideInteractiveLabelOnMouseOver
-true
to activate theALcdGXYInteractiveLabelProvider
,false
otherwise.- See Also:
-
isLabelTouched
Description copied from interface:ILcdGXYLabelPainter2
Tests if the label specified bysetObject
,setLabelIndex
andsetSubLabelIndex
is touched at view location(specified by aGXYContext.getX()
andaGXYContext.getY()
), considering the mode and theILcdGXYContext
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 interfaceILcdGXYLabelPainter2
- Parameters:
aGraphics
- TheGraphics
instance on which the label is painted.aMode
- the mode to consider. This is a bitwise combinations of several constants. SeeILcdGXYLabelPainter2.paintLabel(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext)
for more information.aGXYContext
- theILcdGXYContext
to consider.- Returns:
- true if the representation of the Object returned by getObject() is touched, false otherwise
- See Also:
-
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 bysetObject
,setLabelIndex
andsetSubLabelIndex
.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 thelabel
and itslocation
.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 interfaceILcdGXYLabelPainter2
- Parameters:
aGraphics
- TheGraphics
instance on which the label is painted.aMode
- The mode to consider. This can be a bitwise combination of several constants. SeeILcdGXYLabelPainter2.paintLabel(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext)
for more information.aGXYContext
- TheILcdGXYContext
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:
-
editLabel
Description copied from interface:ILcdGXYLabelEditor
Adapts the set
TLcdLabelLocation
according to the information present in aGXYContext. If the method returnstrue
, theTLcdLabelLocation
was modified, iffalse
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 andaGXYContext
. These should all be set before calling this method. Note that ifaMode
is one of the creating modes, the (sub) label indices are irrelevant.- Specified by:
editLabel
in interfaceILcdGXYLabelEditor
- Parameters:
aGraphics
- TheGraphics
on which the label is painted.aMode
- the mode to consider when editing aObject: aMode shall be a combination ofILcdGXYLabelEditor.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:
-
labelSnapTarget
Description copied from class:ALcdGXYLabelPainter
Returns anObject
that can be used as snapping target when graphically editing anotherObject
or label than the one this ILcdGXYLabelPainter2 represents. The returnedObject
can be theObject
this ILcdGXYLabelPainter2 represents or any other (e.g. anILcdPoint
if getObject() is anILcdPointList
).This default implementation always returns
null
. Override this method if you want to support snapping.- Specified by:
labelSnapTarget
in interfaceILcdGXYLabelPainter2
- Overrides:
labelSnapTarget
in classALcdGXYLabelPainter
- 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 anotherObject
or label than the one this ILcdGXYLabelPainter2 represents (returned by getObject()). This object can benull
.
-
getGXYLabelEditor
Description copied from interface:ILcdGXYLabelEditorProvider
Returns a valid
ILcdGXYLabelEditor
for editing the labels of aObject. The returnedILcdGXYLabelEditor
must haveaObject
set on it. The TLcdLabelLocation must not yet be set on it.- Specified by:
getGXYLabelEditor
in interfaceILcdGXYLabelEditorProvider
- Parameters:
aObject
- the Object for which to obtain aILcdGXYLabelEditor
.- Returns:
- a valid
ILcdGXYLabelEditor
for editing the labels ofaObject
withaObject
set on it. - See Also:
-
getGXYLabelStamp
Returns theALcdGXYLabelStamp
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:
-
firePropertyChangeEvent
Description copied from class:ALcdGXYLabelPainter
Notifies the registeredPropertyChangeListener
s of the specified event.- Overrides:
firePropertyChangeEvent
in classALcdGXYLabelPainter
- Parameters:
aPropertyChangeEvent
- The event describing the property change of which the registered listeners should be notified.- See Also:
-
getDisplayName
Description copied from class:ALcdGXYLabelPainter
This default implementation returns the display name set withsetDisplayName
, ortoString()
if this was set tonull
.- Specified by:
getDisplayName
in interfaceILcdGXYLabelEditor
- Specified by:
getDisplayName
in interfaceILcdGXYLabelPainter2
- Overrides:
getDisplayName
in classALcdGXYLabelPainter
- Returns:
- the display name of this
ILcdGXYLabelPainter2
-
getLabelCursor
Description copied from class:ALcdGXYLabelPainter
Returns aCursor
to indicate the type of editingaMode
andaGXYContext
.This default implementation always returns
null
. Override this method if you want to display custom cursors.- Specified by:
getLabelCursor
in interfaceILcdGXYLabelPainter2
- Overrides:
getLabelCursor
in classALcdGXYLabelPainter
- Parameters:
aGraphics
- TheGraphics
instance on which the label is painted.aMode
- The mode to consider. SeeILcdGXYLabelPainter2.paintLabel(java.awt.Graphics, int, ILcdGXYContext)
for more information.aGXYContext
- TheILcdGXYContext
containing extra information, such as the layer, the view and the mouse position.- Returns:
- a
Cursor
to indicate the type of editingaMode
andaGXYContext
. Returnsnull
if no particularCursor
is required.
-
acceptSnapTargetForLabel
Description copied from interface:ILcdGXYLabelEditor
Returns whether the label specified by
setObject
,setLabelIndex
andsetSubLabelIndex
accepts the snap target in the givenILcdGXYContext
.The snap target is the
Object
returned byaGXYContext.getSnapTarget()
, and is on theILcdGXYLayer
returned byaGXYContext.getSnapTargetLayer()
.- Specified by:
acceptSnapTargetForLabel
in interfaceILcdGXYLabelEditor
- Parameters:
aGraphics
- TheGraphics
on which the label is painted.aGXYContext
- TheILcdGXYContext
containing the snapping information.- Returns:
true
if the label accepts the snap target,false
otherwise.- See Also:
-
labelBoundsSFCT
public double labelBoundsSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aContext, Rectangle aRectangle) throws TLcdNoBoundsException Description copied from interface:ILcdGXYLabelPainter2
Calculates the bounds of the label that can be painted. The bounds are set as a side effect in
aRectangleSFCT
, the orientation ofaRectangleSFCT
is returned as an angle.The bounds represent the upper left point of the label, and a width and a height. The rotation value represents the rotation of the label bounds around the upper left point.
The domain object, the label index, the sublabel index and the location of the label for which the bounds are retrieved should be set before calling this method using the respective methods.
Note that if this label painter is used in conjunction with a labeling algorithm, the bounds should preferably be independent of the location, as this will yield the best results.
- Specified by:
labelBoundsSFCT
in interfaceILcdGXYLabelPainter
- Specified by:
labelBoundsSFCT
in interfaceILcdGXYLabelPainter2
- Parameters:
aGraphics
- theaGraphics
to consider.aMode
- the representation mode of the label.aContext
- theILcdGXYContext
the drawing depends on.aRectangle
- theRectangle
containing the bounds of the label in view / graphics coordinates as side effect.- Returns:
- the angle orientation of the rectangle around the labels in RADIANs, clockwise, 0 at 3 o'clock.
- Throws:
TLcdNoBoundsException
- if the Object doesn't have any valid bounds, e.g. if it is always invisible in the current projection.- See Also:
-
anchorPointSFCT
protected void anchorPointSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aContext, Point aPointSFCT) throws TLcdNoBoundsException Retrieves an anchor point that is used to determine where the pin of the label (specified bysetObject
,setLabelIndex
andsetSubLabelIndex
) attaches to the object representation. Implementations of this class can also use it to determine, for example, discrete positions for a label.By default, this anchor point is the result of the
anchorPointSFCT
method of the correspondingILcdGXYPainter
for the Object to be painted (seeaGXYContext.getGXYLayer().getGXYPainter( aObject )
). When the setTLcdLabelLocation
can retrieve an anchor point, this anchor point should be returned.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.
- Parameters:
aGraphics
- the Graphics for which the labels anchor point should be calculated.aMode
- the mode for the which the label anchor point should be calculated. Can be ILcdGXYLabelPainter.SELECTED or ILcdGXYLabelPainter.DEFAULT.aContext
- the context in which this label will be painted.aPointSFCT
- the point that will be moved to the computed 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.
-
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:
-
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 isfalse
.- See Also:
-
getLabelCreationClickCount
public int getLabelCreationClickCount()Description copied from interface:ILcdGXYLabelEditor
Returns the number of points required to initialize the label of the setObject
.- Specified by:
getLabelCreationClickCount
in interfaceILcdGXYLabelEditor
- 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
Returns the color in which the pin is drawn.- Returns:
- The color in which the pin is drawn.
- See Also:
-
setPinColor
Sets the color in which the pin should be drawn.- Parameters:
aPinColor
- The color in which the pin should be drawn.- See Also:
-
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
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:
-
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
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:
-
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
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:
-
getHaloThickness
public int getHaloThickness()Returns the current halo thickness.- Returns:
- the current halo thickness
- See Also:
-
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:
-
getHaloColor
Returns the current halo color.- Returns:
- the current halo color
- See Also:
-
setHaloColor
Sets the color of the halo to be added around labels.- Parameters:
aColor
- the new halo color- See Also:
-
setHaloAlgorithm
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. SeeTLcdHaloAlgorithm
for more information on the available algorithms.- Parameters:
aHaloAlgorithm
- the algorithm to be used for rendering halo's.- See Also:
-
getHaloAlgorithm
Returns the algorithm that is used for rendering halo's.- Returns:
- the algorithm that is used for rendering halo's.
- See Also:
-
getHaloPinColor
Returns the current halo pin color.- Returns:
- the current halo pin color
- See Also:
-
setHaloPinColor
Sets the color of the halo to be added around pins.- Parameters:
aColor
- the new halo color- See Also:
-
isUseImageCache
public boolean isUseImageCache()Returnstrue
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
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:
-
clearImageCache
public void clearImageCache()Clears the entire label image cache. To remove a single label from the cache, useclearImageCache(Object)
.- See Also:
-
clearImageCache
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, useclearImageCache()
.- Parameters:
aObject
- the object for which the cache to be cleared.- See Also:
-
setWithPin
public void setWithPin(boolean aWithPin) The propertywithPin
determines whether a pin should be drawn from the object to the label. The pin is attached to the object at theanchor point
and to the label stamp at thepin point
.- Parameters:
aWithPin
- true to paint a pin connecting the label and the object.- See Also:
-
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:
-
setWithAnchorPoint
public void setWithAnchorPoint(boolean aWithAnchorPoint) Determines whether to draw an anchor point atanchorPointSFCT
.- Parameters:
aWithAnchorPoint
- true to paint an anchor point- See Also:
-
isWithAnchorPoint
public boolean isWithAnchorPoint()Returns whether to draw an anchor point atanchorPointSFCT
.- Returns:
true
if an anchor point is painted,false
otherwise- See Also:
-
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 istrue
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.
-