public class TLcdGXYPolylineStampLabelPainter extends ALcdGXYLabelPainter
It is recommended to instead use
TLcdGXYOnPathLabelingAlgorithm
in combination with a general label painter (e.g. TLcdGXYStampLabelPainter
),
because labeling algorithms offer better placement behavior and more customization options.
ILcdModel
. Two subsequent points
of the retrieved ILcdPointList
make up the line segment.
For one object whose labels are to be painted different
potential positions (line segments) can be defined.
It also supports free placement of labels.
For more general positioning of labels on paths, see
TLcdGXYOnPathLabelingAlgorithm
The method retrievePointList()
defines how to obtain an ILcdPointList
object from
the painter's object. The default implementation simply casts the object to an ILcdPointList
.
Optionally, this painter can add a halo effect to the labels it draws.
For a more detailed explanation of halos, please refer to TLcdGXYHaloLabelPainter
.
The methods that control the appearance of the halos are equivalent to those
in TLcdGXYHaloLabelPainter
.
Apart from being able to edit the position of the label, this class also provides the option
of showing a java.awt.Component
when the mouse moves over a label to enable more
extensive manipulation of the labeled object. To enable this functionality, you must set
an ALcdGXYInteractiveLabelProvider
on this painter.
You can customize how the interactive label is inserted by overriding addComponentToGXYView(ILcdGXYView, java.awt.Component)
and associated methods.
Warning: If this ALcdGXYInteractiveLabelProvider
functionality
is used, this label painter is bound to a single layer, and the interactive labels will only
be shown on the first view on which this painter paints. Trying to use this painter on another
layer will cause exceptions to be thrown.
Note that this label painter does not paint the polyline itself: please look at
see TLcdGXYPointListPainter
for such a painter.
Modifier and Type | Field and Description |
---|---|
static int |
ABOVE
Alignment mode, indicating that the label is positioned above the chosen line segment.
|
static int |
BELOW
Alignment mode, indicating that the label is positioned below the chosen line segment.
|
static int |
CENTER
Alignment mode, indicating that the label center is positioned on the chosen line segment.
|
static boolean |
TRACEON |
BODY, CREATING, HANDLES, RESHAPING, SNAPS, TRANSLATING
DEFAULT, SELECTED
CREATING, END_CREATION, RESHAPED, START_CREATION, TRANSLATED
Constructor and Description |
---|
TLcdGXYPolylineStampLabelPainter()
Equivalent to calling
new TLcdGXYPolylineStampLabelPainter( null, null ) . |
TLcdGXYPolylineStampLabelPainter(ALcdGXYLabelStamp aGXYLabelStamp)
Equivalent to calling
new TLcdGXYPolylineStampLabelPainter( aGXYLabelStamp, null ) . |
TLcdGXYPolylineStampLabelPainter(ALcdGXYLabelStamp aGXYLabelStamp,
ALcdGXYInteractiveLabelProvider aGXYInteractiveLabelProvider)
Creates a new label painter with the specified label stamp and interactive label provider.
|
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 void |
anchorPointSFCT(Graphics aGraphics,
int aMode,
ILcdGXYContext aContext,
Point aPointSFCT)
Calculates a point on the polyline.
|
protected int[] |
calculateLabelSegment(ILcdPointList aPointList,
int aLabelWidth,
int aLabelHeight,
Graphics aGraphics,
int aMode,
ILcdGXYContext aGXYContext)
Finds a line segment based on two points of the given pointlist on which to base the position
and the slope of the label.
|
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.
|
Object |
clone()
Returns a new instance of this
ALcdGXYLabelPainter . |
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
PropertyChangeListener s of the specified event. |
int |
getAlignment()
Returns how the label is aligned with respect to the polyline.
|
protected Component |
getComponentForGXYView(ILcdGXYView aGXYView)
Gets the component that represents the given
ILcdGXYView . |
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 . |
int |
getMaxNumberPossibilities()
Returns the maximum number of label locations in
getPossibleLocationCount(java.awt.Graphics) . |
Color |
getPinColor()
Returns the color in which the pin is drawn.
|
int |
getPossibleLocationCount(Graphics aGraphics)
Returns the number of possible locations where this
ILcdGXYLabelPainter can
paint/draw the labels of the set domain Object . |
int |
getPossibleLocationCount(ILcdPointList aPointList,
Graphics aGraphics)
Returns the number of locations where one can draw a label.
|
Color |
getSelectedPinColor()
Returns the color in which the pin should be drawn of the label of a selected object.
|
int |
getVGap()
Returns the orthogonal distance (in pixels) between the label and
the line segment.
|
protected int |
indexSegmentFirstPoint(int aLocationIndex,
ILcdPointList aPointList)
Given a desired possibility aLocationIndex and all the
possible locations defined through aPointList, this method will calculate
alongside which of the line segments the label should be drawn.
|
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 |
isLabelOnPath()
Returns whether the label will be placed along the world path the polyline follows or in the middle between two
points of the polyline.
|
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 |
isPaintCache()
Returns whether the label location and angle should be cached if the object set to this label painter
supports caching.
|
boolean |
isRotationAllowed() |
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 . |
double |
labelBoundsSFCT(Graphics aGraphics,
int aMode,
ILcdGXYContext aContext,
Rectangle aRectangle)
Calculates the bounds of the label that can be painted.
|
protected double |
labelPositionForLocationIndexSFCT(int aLocationIndex,
int aWidth,
int aHeight,
Point aAnchorPoint,
int aMode,
ILcdGXYContext aGXYContext,
Graphics aGraphics,
Point aPointSFCT)
Calculates the upper left label corner and rotation, based on the given (non-negative) location index, as retrieved
from the painter or the label location.
|
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 |
paintLabel(Graphics aGraphics,
int aMode,
ILcdGXYContext aContext)
Paints the label specified by
setObject , setLabelIndex and
setSubLabelIndex on aGraphics . |
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 ILcdPointList |
retrievePointList()
Retrieves a list of points between which it is possible to draw a
label for the Object of this
TLcdGXYPolylineLabelPainter . |
void |
setAlignment(int aAlignment)
Sets how the text is aligned with respect to the polyline.
|
static void |
setClassTraceOn(boolean aClassTraceOn)
Deprecated.
This method has been deprecated. It is recommended to use the
standard Java logging framework directly.
|
void |
setGXYInteractiveLabelProvider(ALcdGXYInteractiveLabelProvider aGXYInteractiveLabelProvider)
Deprecated.
this is controller logic. Use
TLcdGXYInteractiveLabelsController instead. |
void |
setGXYLabelStamp(ALcdGXYLabelStamp aGXYLabelStamp)
Sets the
ALcdGXYLabelStamp that this painter should use to paint the labels. |
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 |
setLabelOnPath(boolean aLabelOnPath)
Sets whether the world path should be used to find the location of the label on a given segment, or whether
the center location between the 2 points of the segment suffices.
|
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 |
setMaxNumberPossibilities(int aMaxNumberPossibilities)
Sets the maximum number of label locations to return in
getPossibleLocationCount(java.awt.Graphics) . |
void |
setPaintCache(boolean aPaintCache)
Sets whether the label location and angle should be cached if the object set to this label painter
supports caching.
|
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 |
setRotationAllowed(boolean aRotationAllowed)
Returns whether labels are rotated so that they have the same angle as the polyline.
|
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 |
setVGap(int aVerticalGap)
Sets the orthogonal distance (in pixels) between the label and
the line segment.
|
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.
|
addPropertyChangeListener, getLabelCount, getLabelIndex, getLabelLocation, getLocationIndex, getObject, getSubLabelCount, getSubLabelIndex, removePropertyChangeListener, setDisplayName, setLabelIndex, setLabelLocation, setLocationIndex, setObject, setSubLabelIndex, supportLabelSnap
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getLabelLocation, setLabelLocation, setObject, supportLabelSnap
getLabelCount, getLabelIndex, getSubLabelCount, getSubLabelIndex, setLabelIndex, setSubLabelIndex
getLocationIndex, getObject, setLocationIndex
getLabelCount, getLabelIndex, getLabelLocation, getObject, getSubLabelCount, getSubLabelIndex, setLabelIndex, setLabelLocation, setObject, setSubLabelIndex
addPropertyChangeListener, removePropertyChangeListener
public static boolean TRACEON
public static final int ABOVE
public static final int CENTER
public static final int BELOW
public TLcdGXYPolylineStampLabelPainter()
new TLcdGXYPolylineStampLabelPainter( null, null )
.public TLcdGXYPolylineStampLabelPainter(ALcdGXYLabelStamp aGXYLabelStamp)
new TLcdGXYPolylineStampLabelPainter( aGXYLabelStamp, null )
.aGXYLabelStamp
- The stamp which will be used to paint the label and
calculate the bounds. This can be null
, but
the stamp must be set before this label
painter is actually used.TLcdGXYPolylineStampLabelPainter(ALcdGXYLabelStamp, ALcdGXYInteractiveLabelProvider)
public TLcdGXYPolylineStampLabelPainter(ALcdGXYLabelStamp aGXYLabelStamp, ALcdGXYInteractiveLabelProvider aGXYInteractiveLabelProvider)
aGXYLabelStamp
- The stamp which will be used to paint the label and
calculate the bounds. This can be null
, but
the stamp must be set before this label
painter is actually used.aGXYInteractiveLabelProvider
- The interactive label provider which will be used to
configure a java.awt.Component
that can be
used, for instance, to edit the properties of the labeled
object. This can be null
, in which case no
Component
will be shown. If it was
null
, you can set it later with the setGXYInteractiveLabelProvider
public Object clone()
ALcdGXYLabelPainter
ALcdGXYLabelPainter
. The label location
of the clone is a clone of the label location of the original. No other objects
are cloned.clone
in interface ILcdGXYLabelEditor
clone
in interface ILcdGXYLabelEditorProvider
clone
in interface ILcdGXYLabelPainter
clone
in interface ILcdGXYLabelPainter2
clone
in interface ILcdGXYLabelPainterProvider
ALcdGXYLabelPainter
of which the label location
is a deep clone.protected final double labelPositionForLocationIndexSFCT(int aLocationIndex, int aWidth, int aHeight, Point aAnchorPoint, int aMode, ILcdGXYContext aGXYContext, Graphics aGraphics, Point aPointSFCT)
The upper left corner is chosen somewhere along the polyline, on the segment defined by
calculateLabelSegment(com.luciad.shape.ILcdPointList, int, int, java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext)
. The value of aAnchorPoint
is ignored.
aLocationIndex
- the location index. This index is non-negative, thus representing a fixed label location.aWidth
- the width of the label.aHeight
- the height of the label.aAnchorPoint
- The anchor point, retrieved using #anchorPointSFCT.aMode
- the mode to consider.aGXYContext
- the context.aGraphics
- the Graphics.aPointSFCT
- This point should be moved to the upper left label corner.aPointSFCT
parameter as a side
effect.protected ILcdPointList retrievePointList()
TLcdGXYPolylineLabelPainter
. This method is
called within the paintLabel
method.
This implementation checks for the following interfaces:
ILcdShape
geometry is retrievedILcdPointList
.
Re-define this method for getting a ILcdPointList
by other means.ILcdPointList
public int getPossibleLocationCount(Graphics aGraphics)
ILcdGXYLabelPainter
can
paint/draw the labels of the set domain Object
.
The domain Object
for which the location count is retrieved should be set
before calling this method using the ILcdGXYLabelPainter.setObject(java.lang.Object)
method.
getPossibleLocationCount(com.luciad.shape.ILcdPointList, java.awt.Graphics)
for the painter's point list.aGraphics
- the Graphics the label will be painted on.ILcdGXYLabelPainter
can
paint/draw the labels of the set Object.ILcdGXYLabelPainter.setLocationIndex(int)
public int getPossibleLocationCount(ILcdPointList aPointList, Graphics aGraphics)
getMaxNumberPossibilities()
>= 0, this is the minimum
of the number of points in aPointList and the value of the
maxNumberPossibilities property.
Else the number of points in aPointList is returned.aPointList
- the point list to render the labels foraGraphics
- the graphics the label will be painted ongetMaxNumberPossibilities()
public void setMaxNumberPossibilities(int aMaxNumberPossibilities)
getPossibleLocationCount(java.awt.Graphics)
.aMaxNumberPossibilities
- the maximum number of label locations, or -1 to allow all possibilities.public int getMaxNumberPossibilities()
getPossibleLocationCount(java.awt.Graphics)
.public void setLabelOnPath(boolean aLabelOnPath)
Setting this property to true will result in a better label placement along long lines which are not rendered as straight lines, but calculating the location is more expensive.
aLabelOnPath
- true to have the label place along the world path the polyline follows.isLabelOnPath()
public boolean isLabelOnPath()
setLabelOnPath(boolean)
public void setRotationAllowed(boolean aRotationAllowed)
aRotationAllowed
- if true, the labels are rotated so as to follow the polylineisRotationAllowed()
public boolean isRotationAllowed()
true
if and only if rotationAllowed holds true
setRotationAllowed(boolean)
public void setAlignment(int aAlignment)
aAlignment
- one of ABOVE
, CENTER
, or BELOW
getAlignment()
public int getAlignment()
ABOVE
, CENTER
, or BELOW
setAlignment(int)
public void setVGap(int aVerticalGap)
aVerticalGap
- the distance between the label and line segment, in pixelsgetVGap()
public int getVGap()
setVGap(int)
public boolean isPaintCache()
setPaintCache(boolean)
. Default value is false.setPaintCache(boolean)
,
setLabelOnPath(boolean)
public void setPaintCache(boolean aPaintCache)
aPaintCache
- false not to cache the label position and angle in the object, true to cache the label
position and angle when these are calculated based on the path followed by the pen.isPaintCache()
,
setLabelOnPath(boolean)
protected int indexSegmentFirstPoint(int aLocationIndex, ILcdPointList aPointList)
aLocationIndex
- The index of the desired location, starting from the middle. If aLocationIndex equals zero or -1, the line segment is chosen
in the middle of the aPointList. For greater values of aLocationIndex, this method will select line
segments alternatively at the right and left of the the middle segment of
aPointList.aPointList
- the point list to find a segment forpublic void paintLabel(Graphics aGraphics, int aMode, ILcdGXYContext aContext)
ILcdGXYLabelPainter2
Paints the label specified by setObject
, setLabelIndex
and
setSubLabelIndex
on aGraphics
. aGXYContext
should
contain the ILcdGXYView
for which the label is painted and
ILcdGXYLayer
to which the object belongs
The implementation of this method shall define how to paint the specified label in the given
mode, considering aGXYContext
and the set TLcdLabelLocation
.
The domain object, label index, sublabel index and the label location should be set before calling this method using the respective methods.
This interface extends the original contract of the paintLabel method to allow for more
modes. Where in the super interface the mode could only be one of ILcdGXYLabelPainter.DEFAULT
or ILcdGXYLabelPainter.SELECTED
, the mode now can be a
bitwise combination of several constants
paintLabel
in interface ILcdGXYLabelPainter
paintLabel
in interface ILcdGXYLabelPainter2
aGraphics
- The graphics object to paint the label onaMode
- A bitwise combination of aContext
- the drawing context for the labelILcdGXYLabelPainter.DEFAULT
,
ILcdGXYLabelPainter.SELECTED
protected void anchorPointSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aContext, Point aPointSFCT) throws TLcdNoBoundsException
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 anchor point computed.TLcdNoBoundsException
protected int[] calculateLabelSegment(ILcdPointList aPointList, int aLabelWidth, int aLabelHeight, Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext)
aPointList
- the point list to find the label position foraLabelWidth
- the label widthaLabelHeight
- the label heightaGraphics
- the Graphics on which the label will be paintedaMode
- the mode for which the label should be paintedaGXYContext
- the context to find the position for@Deprecated public void setGXYInteractiveLabelProvider(ALcdGXYInteractiveLabelProvider aGXYInteractiveLabelProvider)
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
.
setProvideInteractiveLabelOnMouseOver
must be set to true
.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
.IllegalStateException
- When the interactive label provider was already set.IllegalArgumentException
- When the interactive label provider was null
.setProvideInteractiveLabelOnMouseOver(boolean)
public ALcdGXYInteractiveLabelProvider getGXYInteractiveLabelProvider()
setGXYInteractiveLabelProvider(ALcdGXYInteractiveLabelProvider)
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
.
aGXYView
- The view for which a Component
must be retrieved.java.awt.Component
which corresponds to the given
ILcdGXYView
IllegalArgumentException
- By default when aGXYView
is not a
java.awt.Component
ALcdGXYInteractiveLabelProvider.dispatchMouseEvent(java.awt.event.MouseEvent,
java.awt.Component, java.awt.Component)
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
.
aGXYView
- The ILcdGXYView
for which to check if a component can be added.true
if a component can be added, false
otherwise.addComponentToGXYView(ILcdGXYView, java.awt.Component)
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
.
aGXYView
- The view to which the interactive label should be added.aComponent
- The interactive label that should be added to the user interface.IllegalArgumentException
- By default if aGXYView
is not an instance of
java.awt.Container
or if the layout of
aGXYView
is not null.canAddComponentToGXYView(ILcdGXYView)
,
removeComponentFromGXYView(ILcdGXYView, java.awt.Component)
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
.
aGXYView
- The view from which the interactive label should be removed.aComponent
- The interactive label that should be removed from the user interfaceIllegalArgumentException
- By default if the view does not extend from
java.awt.Container
public void startLabelInteraction(Object aDomainObject, int aLabelIndex, int aSubLabelIndex, ILcdGXYContext aGXYContext)
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 interactivepublic 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
.
true
if the label interaction can be stopped, false
otherwise.public boolean stopLabelInteraction()
Stops the interactive label, if there is one. The interactive label will commit any outstanding changes.
true
if the interactive label could be stopped or if there was no
interactive label, false
otherwise.canStopLabelInteraction()
,
ALcdGXYInteractiveLabelProvider.stopInteraction()
public void cancelLabelInteraction()
public Object getDomainObjectForInteractiveLabel()
null
if there is no
interactive label.null
if there is no
interactive label.@Deprecated public void setProvideInteractiveLabelOnMouseOver(boolean aProvideInteractiveLabelOnMouseOver)
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.
aProvideInteractiveLabelOnMouseOver
- true
to activate the
ALcdGXYInteractiveLabelProvider
, false
otherwise.setGXYInteractiveLabelProvider
public boolean isLabelTouched(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext)
ILcdGXYLabelPainter2
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.
isLabelTouched
in interface ILcdGXYLabelPainter2
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.ILcdGXYContext
public void labelAnchorPointSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext, Point aPointSFCT) throws TLcdNoBoundsException
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.
labelAnchorPointSFCT
in interface ILcdGXYLabelPainter2
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.TLcdNoBoundsException
- if the Object doesn't have any valid anchor point, e.g. if it is
always invisible in the current projection.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)
public boolean editLabel(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext)
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.
editLabel
in interface ILcdGXYLabelEditor
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.ILcdGXYContext
public Object labelSnapTarget(Graphics aGraphics, ILcdGXYContext aGXYContext)
ALcdGXYLabelPainter
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.
labelSnapTarget
in interface ILcdGXYLabelPainter2
labelSnapTarget
in class ALcdGXYLabelPainter
aGraphics
- the Graphics on which is worked.aGXYContext
- the ILcdGXYContext of the snapping.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
.public ILcdGXYLabelPainter getGXYLabelPainter(Object aObject)
ILcdGXYLabelPainterProvider
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;
}
getGXYLabelPainter
in interface ILcdGXYLabelPainterProvider
aObject
- the object to find a label painter forpublic ILcdGXYLabelEditor getGXYLabelEditor(Object aObject)
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.
getGXYLabelEditor
in interface ILcdGXYLabelEditorProvider
aObject
- the Object for which to obtain a ILcdGXYLabelEditor
.ILcdGXYLabelEditor
for editing the labels of aObject
with aObject
set on it.ILcdGXYLabelEditor.setObject(java.lang.Object)
public void setGXYLabelStamp(ALcdGXYLabelStamp aGXYLabelStamp)
Sets the ALcdGXYLabelStamp
that this painter should use to paint the labels. This stamp must be set to
a non-null
value before this label painter can be used on a layer.
aGXYLabelStamp
- The ALcdGXYLabelStamp
that this painter should use to paint the labels.public ALcdGXYLabelStamp getGXYLabelStamp()
ALcdGXYLabelStamp
that is used by this painter to paint the labels.ALcdGXYLabelStamp
that is used by this painter to paint the labels.setGXYLabelStamp(ALcdGXYLabelStamp)
protected void firePropertyChangeEvent(PropertyChangeEvent aPropertyChangeEvent)
ALcdGXYLabelPainter
PropertyChangeListener
s of the specified event.firePropertyChangeEvent
in class ALcdGXYLabelPainter
aPropertyChangeEvent
- The event describing the property change of which the registered
listeners should be notified.ALcdGXYLabelPainter.addPropertyChangeListener(java.beans.PropertyChangeListener)
public String getDisplayName()
ALcdGXYLabelPainter
setDisplayName
, or toString()
if this was set to null
.getDisplayName
in interface ILcdGXYLabelEditor
getDisplayName
in interface ILcdGXYLabelPainter2
getDisplayName
in class ALcdGXYLabelPainter
ILcdGXYLabelPainter2
public Cursor getLabelCursor(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext)
ALcdGXYLabelPainter
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.
getLabelCursor
in interface ILcdGXYLabelPainter2
getLabelCursor
in class ALcdGXYLabelPainter
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.Cursor
to indicate the type of editing aMode
and
aGXYContext
. Returns null
if no particular
Cursor
is required.public boolean acceptSnapTargetForLabel(Graphics aGraphics, ILcdGXYContext aGXYContext)
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()
.
acceptSnapTargetForLabel
in interface ILcdGXYLabelEditor
aGraphics
- The Graphics
on which the label is painted.aGXYContext
- The ILcdGXYContext
containing the snapping information.true
if the label accepts the snap target, false
otherwise.ILcdGXYContext.getSnapTarget()
,
ILcdGXYContext.getSnapTargetLayer()
public double labelBoundsSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aContext, Rectangle aRectangle) throws TLcdNoBoundsException
ILcdGXYLabelPainter2
Calculates the bounds of the label that can be painted. The bounds are set as a side effect
in aRectangleSFCT
, the orientation of aRectangleSFCT
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.
labelBoundsSFCT
in interface ILcdGXYLabelPainter
labelBoundsSFCT
in interface ILcdGXYLabelPainter2
aGraphics
- the aGraphics
to consider.aMode
- the representation mode of the label.aContext
- the ILcdGXYContext
the drawing depends on.aRectangle
- the Rectangle
containing the bounds of the label in view /
graphics coordinates as side effect.TLcdNoBoundsException
- if the Object doesn't have any valid bounds, e.g. if it is always
invisible in the current projection.ILcdGXYViewLabelPainter
,
ILcdGXYLayerLabelPainter
,
ILcdGXYLabelPainter2.labelAnchorPointSFCT(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext, java.awt.Point)
public void setMakeLabelsStickyOnEdit(boolean aMakeLabelsStickyOnEdit)
aMakeLabelsStickyOnEdit
- true
if you want the labels to be sticky after they are edited,
false
otherwise.TLcdLabelLocation.getLabelEditMode()
,
ILcdGXYViewLabelPainter
,
ILcdGXYLayerLabelPainter
public boolean isMakeLabelsStickyOnEdit()
true
if this editor sets the labels it edits to be sticky, false
otherwise. The
default value is false
.setMakeLabelsStickyOnEdit(boolean)
public int getLabelCreationClickCount()
ILcdGXYLabelEditor
Object
.getLabelCreationClickCount
in interface ILcdGXYLabelEditor
Object
or
-1 if this is undefined like for a polyline or a polygon. 0 means graphical creation
of labels is not supported.public Color getPinColor()
setPinColor(java.awt.Color)
public void setPinColor(Color aPinColor)
aPinColor
- The color in which the pin should be drawn.getPinColor()
,
setWithPin(boolean)
public Color getSelectedPinColor()
public void setSelectedPinColor(Color aSelectedPinColor)
aSelectedPinColor
- The color in which the pin of the label of a selected label should be drawn.setWithPin(boolean)
public boolean isHaloEnabled()
setHaloEnabled(boolean)
public void setHaloEnabled(boolean aHaloEnabled)
aHaloEnabled
- true if halos should be added, false otherwiseisHaloEnabled()
,
setHaloPinEnabled(boolean)
public boolean isHaloPinEnabled()
setHaloPinEnabled(boolean)
,
setHaloEnabled(boolean)
public void setHaloPinEnabled(boolean aHaloPinEnabled)
aHaloPinEnabled
- true if the halo effect includes the pin, false otherwiseisHaloPinEnabled()
,
setHaloEnabled(boolean)
,
setWithPin(boolean)
public int getHaloThickness()
setHaloThickness(int)
public void setHaloThickness(int aThickness)
aThickness
- the new halo thicknessTLcdGXYHaloLabelPainter.setHaloThickness(int)
,
setHaloEnabled(boolean)
public Color getHaloColor()
setHaloColor(java.awt.Color)
public void setHaloColor(Color aColor)
aColor
- the new halo colorTLcdGXYHaloLabelPainter.setHaloColor(java.awt.Color)
,
setHaloEnabled(boolean)
public void setHaloAlgorithm(TLcdHaloAlgorithm aHaloAlgorithm)
TLcdHaloAlgorithm
for more information on the available algorithms.aHaloAlgorithm
- the algorithm to be used for rendering halo's.TLcdHaloAlgorithm
,
getHaloAlgorithm()
,
setHaloEnabled(boolean)
public TLcdHaloAlgorithm getHaloAlgorithm()
TLcdHaloAlgorithm
,
setHaloAlgorithm(com.luciad.util.TLcdHaloAlgorithm)
public Color getHaloPinColor()
setHaloColor(java.awt.Color)
public void setHaloPinColor(Color aColor)
aColor
- the new halo colorgetHaloPinColor()
,
setHaloPinEnabled(boolean)
public boolean isUseImageCache()
true
when image caching for labels with a halo is enabled,
false
otherwise.true
when label image caching is enabled, false
otherwisesetUseImageCache(boolean)
public void setUseImageCache(boolean aUseCache)
aUseCache
- specifies whether image caching should be enabledTLcdGXYHaloLabelPainter.setUseImageCache(boolean)
,
setHaloEnabled(boolean)
,
setHaloPinEnabled(boolean)
,
isUseImageCache()
public void clearImageCache()
clearImageCache(Object)
.setUseImageCache(boolean)
public void clearImageCache(Object aObject)
clearImageCache()
.aObject
- the object for which the cache to be cleared.setUseImageCache(boolean)
protected boolean pinPointSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext, Point aAnchorPoint, Rectangle aLabelBounds, double aRotation, Point aPinPointSFCT)
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 axisaPinPointSFCT
- The point in AWT coordinates where the pin attaches to the labelanchorPointSFCT(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext, java.awt.Point)
,
setWithPin(boolean)
protected void paintPin(Graphics aGraphics, int aMode, int aStartPointX, int aStartPointY, int aEndPointX, int aEndPointY)
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.setWithPin(boolean)
public void setWithPin(boolean aWithPin)
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
.aWithPin
- true to paint a pin connecting the label and the object.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)
public boolean isWithPin()
true
if a pin is drawn from the object to the labelsetWithPin(boolean)
public void setWithAnchorPoint(boolean aWithAnchorPoint)
anchorPointSFCT
.aWithAnchorPoint
- true to paint an anchor pointisWithAnchorPoint()
,
anchorPointSFCT(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext, java.awt.Point)
,
paintAnchorPoint(java.awt.Graphics, int, int, int)
public boolean isWithAnchorPoint()
anchorPointSFCT
.true
if an anchor point is painted, false
otherwisesetWithAnchorPoint(boolean)
public static void setClassTraceOn(boolean aClassTraceOn)
true
then all log messages are recorded, otherwise only
the informative, warning and error messages are recorded.aClassTraceOn
- if true then all log messages are recorded,
otherwise only the informative, warning and error messages are recorded.