com.luciad.ogc.sld.view.gxy

LuciadLightspeedClass TLcdSLDRulePainter

java.lang.Object

com.luciad.ogc.sld.view.gxy.ALcdSLDRulePainter

com.luciad.ogc.sld.view.gxy.TLcdSLDRulePainter

All Implemented Interfaces:

ILcdCloneable, ILcdPropertyChangeSource, ILcdGXYLabelPainter, ILcdGXYLabelPainter2, ILcdGXYMultiLabelPainter, ILcdGXYPainter, Serializable, Cloneable

public class TLcdSLDRulePainter
extends ALcdSLDRulePainter
implements ILcdGXYLabelPainter2

A painter that handles painting of all the objects that comply to a given rule. This implementation delegates to

• to its symbolizer painters who implement ILcdGXYPainter for all painter methods (paint, boundsSFCT, ...),
• to its symbolizer painters who implement ILcdGXYLabelPainter for all label painter methods (paintLabel, labelBoundsSFCT, ...),

for objects which are accepted by the filter evaluator.

See Also:

Serialized Form

Field Summary

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

BODY, CREATING, HANDLES, RESHAPING, SNAPS, TRANSLATING

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

DEFAULT, SELECTED

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

BODY, CREATING, DEFAULT, HANDLES, RESHAPING, SELECTED, SNAPS, TRANSLATING

Constructor Summary

Constructors

Constructor and Description
TLcdSLDRulePainter(boolean aHasElseFilter, ALcdSLDSymbolizerPainter[] aSymbolizerPainters)
TLcdSLDRulePainter(ILcdFilter aFilterEvaluator, ALcdSLDSymbolizerPainter[] aSymbolizerPainters)

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener aPropertyChangeListener) Rule painters do not support property change events.
void	anchorPointSFCT(Graphics aGraphics, int aPainterMode, ILcdGXYContext aGXYContext, Point aPoint) Delegates computation of the anchor point to the symbolizer painters if the object was accepted.
void	boundsSFCT(Graphics aGraphics, int aPainterMode, ILcdGXYContext aGXYContext, ILcd2DEditableBounds a2DEditableBounds) Delegates computation of the bounds to the symbolizer painters if the object was accepted.
Cursor	getCursor(Graphics aGraphics, int aPainterMode, ILcdGXYContext aGXYContext) Rule painters do not provide cursors.
String	getDisplayName() Returns "Rule painter".
int	getLabelCount(Graphics aGraphics, ILcdGXYContext aGXYContext) Returns the number of labels for the object set to this label painter.
Cursor	getLabelCursor(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext) Returns a Cursor to indicate the type of editing aMode and aGXYContext.
int	getLabelIndex() Returns the index of the label that is currently painted or scheduled to paint.
TLcdLabelLocation	getLabelLocation() Returns the TLcdLabelLocation that was previously set that contains the information on the whereabouts of the label.
int	getLocationIndex() Gets the index of location where to paint the label(s) of the set Object.
Object	getObject() Gets the Object this ILcdGXYLabelPainter can label.
int	getPossibleLocationCount(Graphics aGraphics) Retrieves the highest possible location count from the symbolizer painters that implement ILcdGXYLabelPainter.
int	getSubLabelCount(int aLabelIndex) Return the number of sublabels in a label.
int	getSubLabelIndex() Returns the index of the sublabel to paint.
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	isScaleValid(ILcdGXYView aView) Converts the views scale (pixels/meter) to a map scale (meter/meter) and compares it with the min and max scale denominators set.
boolean	isTouched(Graphics aGraphics, int aPainterMode, ILcdGXYContext aGXYContext) Delegates checking whether the object is touched to the symbolizer painters if the object was accepted.
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 aGXYContext, Rectangle aRectangle) Calculates the bounds of the label that can be painted.
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	paint(Graphics aGraphics, int aPainterMode, ILcdGXYContext aGXYContext) Delegates the painting to the symbolizer painters if the object was accepted, does nothing otherwise.
void	paintLabel(Graphics aGraphics, int aLabelPainterMode, ILcdGXYContext aGXYContext) Delegates paint to the symbolizer painters that implement ILcdGXYLabelPainter if the object was accepted.
void	removePropertyChangeListener(PropertyChangeListener aPropertyChangeListener) Rule painters do not support property change events.
void	setLabelIndex(int aLabelIndex) Sets the label.
void	setLabelLocation(TLcdLabelLocation aLabelLocation) Sets the label location of the label.
void	setLocationIndex(int aLocationIndex) Sets the index of location where to paint the label(s) of the set Object.
void	setObject(Object aObject) The object set to this painter is delegated to the symbolizer painters only if it is accepted.
void	setSubLabelIndex(int aSubLabelIndex) Sets the sublabel index.
Object	snapTarget(Graphics aGraphics, ILcdGXYContext aGXYContext) First snap target found in one of the symbolizer painters if the object was accepted.
boolean	supportLabelSnap(Graphics aGraphics, ILcdGXYContext aGXYContext) Returns whether this label painter supports snapping for the label specified by setObject, setLabelIndex and setSubLabelIndex, considering the given ILcdGXYContext instance.
boolean	supportSnap(Graphics aGraphics, ILcdGXYContext aGXYContext) Do any of the symbolizer painters support snapping?
String	toString() Returns the display name.

Methods inherited from class com.luciad.ogc.sld.view.gxy.ALcdSLDRulePainter

accept, clone, getMaxScaleDenominator, getMinScaleDenominator, getSymbolizerPainter, getSymbolizerPainterCount, hasElseFilter, setMaxScaleDenominator, setMinScaleDenominator

Methods inherited from class java.lang.Object

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

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

clone

Constructor Detail

TLcdSLDRulePainter

public TLcdSLDRulePainter(ILcdFilter aFilterEvaluator,
                          ALcdSLDSymbolizerPainter[] aSymbolizerPainters)

TLcdSLDRulePainter

public TLcdSLDRulePainter(boolean aHasElseFilter,
                          ALcdSLDSymbolizerPainter[] aSymbolizerPainters)

Method Detail

setObject

public void setObject(Object aObject)

The object set to this painter is delegated to the symbolizer painters only if it is accepted.

Specified by:

setObject in interface ILcdGXYLabelPainter

Specified by:

setObject in interface ILcdGXYLabelPainter2

Specified by:

setObject in interface ILcdGXYPainter

Parameters:

aObject - the object to set to this painter.

See Also:

ALcdSLDRulePainter.accept(Object)

getObject

public Object getObject()

Description copied from interface: ILcdGXYLabelPainter

Gets the Object this ILcdGXYLabelPainter can label.

Specified by:

getObject in interface ILcdGXYLabelPainter

Specified by:

getObject in interface ILcdGXYPainter

Returns:

the Object this ILcdGXYLabelPainter can label.

See Also:

ILcdGXYLabelPainter.setObject(java.lang.Object)

paint

public void paint(Graphics aGraphics,
                  int aPainterMode,
                  ILcdGXYContext aGXYContext)

Delegates the painting to the symbolizer painters if the object was accepted, does nothing otherwise.

Specified by:

paint in interface ILcdGXYPainter

Specified by:

paint in class ALcdSLDRulePainter

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aPainterMode - the mode the object is represented in (see class documentation).

aGXYContext - the ILcdGXYContext the drawing depends on.

See Also:

setObject(Object)

boundsSFCT

public void boundsSFCT(Graphics aGraphics,
                       int aPainterMode,
                       ILcdGXYContext aGXYContext,
                       ILcd2DEditableBounds a2DEditableBounds)
                throws TLcdNoBoundsException

Delegates computation of the bounds to the symbolizer painters if the object was accepted. The result is the union of the bounds computed by the individual painters.

Specified by:

boundsSFCT in interface ILcdGXYPainter

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aPainterMode - the mode the object is represented in (see class documentation). For example, an object may be represented differently in SELECTED mode compared to DEFAULT mode. The returned bounds of the representation must take this different representation into account.

aGXYContext - the context for which the representation of the object is painted. It contains amongst others the transformations from model to world and world to view.

a2DEditableBounds - the bounds that must be adapted to encompass the representation of the object in the given mode and context. These bounds must not be taken into account when the method has thrown an exception.

Throws:

TLcdNoBoundsException - when the object was not accepted or when all of the symbolizer painters threw a TLcdNoBoundsException.

See Also:

setObject(Object)

isTouched

public boolean isTouched(Graphics aGraphics,
                         int aPainterMode,
                         ILcdGXYContext aGXYContext)

Delegates checking whether the object is touched to the symbolizer painters if the object was accepted.

Specified by:

isTouched in interface ILcdGXYPainter

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aPainterMode - the mode the object is represented in

aGXYContext - contains the location of the interaction and the transformations to convert this location into model coordinates

Returns:

true if the object was accepted and is touched according to (at least) one of the symbolizer painters in the given context. False otherwise.

See Also:

setObject(Object)

anchorPointSFCT

public void anchorPointSFCT(Graphics aGraphics,
                            int aPainterMode,
                            ILcdGXYContext aGXYContext,
                            Point aPoint)
                     throws TLcdNoBoundsException

Delegates computation of the anchor point to the symbolizer painters if the object was accepted. This implementation will set the point passed at the anchor point computed by the first symbolizer painter which does not throw a TLcdNoBoundsException

Specified by:

anchorPointSFCT in interface ILcdGXYPainter

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aPainterMode - the mode the object is painted in (see class documentation)

aGXYContext - the context for which the representation of the object is painted. It contains amongst others the transformations from model to world and world to view.

aPoint - the point that has to be moved to the location of the anchor point of the representation of the object. This point must not be taken into account when the method has thrown a TLcdNoBoundsException.

Throws:

TLcdNoBoundsException - when all symbolizer painters threw a TLcdNoBoundsException or when the object was not accepted.

See Also:

setObject(Object)

supportSnap

public boolean supportSnap(Graphics aGraphics,
                           ILcdGXYContext aGXYContext)

Do any of the symbolizer painters support snapping?

Specified by:

supportSnap in interface ILcdGXYPainter

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aGXYContext - the context in which this object is represented and in which the editing of an object occurs.

Returns:

true if one of the symbolizer painters supports snapping and the object was accepted. False otherwise.

See Also:

setObject(Object)

snapTarget

public Object snapTarget(Graphics aGraphics,
                         ILcdGXYContext aGXYContext)

First snap target found in one of the symbolizer painters if the object was accepted.

Specified by:

snapTarget in interface ILcdGXYPainter

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aGXYContext - the context in which this object is represented and in which the editing of an object occurs.

Returns:

first snap target found in one of the symbolizer painters if the object was accepted. Null otherwise.

See Also:

supportSnap(java.awt.Graphics, com.luciad.view.gxy.ILcdGXYContext), setObject(Object)

getCursor

public Cursor getCursor(Graphics aGraphics,
                        int aPainterMode,
                        ILcdGXYContext aGXYContext)

Rule painters do not provide cursors.

Specified by:

getCursor in interface ILcdGXYPainter

Parameters:

aGraphics - the Graphics on which the representation of the object is painted

aPainterMode - the rendering mode to return the cursor for.

aGXYContext - the context in which the rendering occurs.

Returns:

always null.

getDisplayName

public String getDisplayName()

Returns "Rule painter".

Specified by:

getDisplayName in interface ILcdGXYLabelPainter2

Specified by:

getDisplayName in interface ILcdGXYPainter

Returns:

"Rule painter".

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener aPropertyChangeListener)

Rule painters do not support property change events.

Specified by:

addPropertyChangeListener in interface ILcdPropertyChangeSource

Parameters:

aPropertyChangeListener - is ignored.

See Also:

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

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener aPropertyChangeListener)

Rule painters do not support property change events.

Specified by:

removePropertyChangeListener in interface ILcdPropertyChangeSource

Parameters:

aPropertyChangeListener - is ignored.

See Also:

ILcdPropertyChangeSource.addPropertyChangeListener(java.beans.PropertyChangeListener)

setLocationIndex

public void setLocationIndex(int aLocationIndex)

Description copied from interface: ILcdGXYLabelPainter

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

Specified by:

setLocationIndex in interface ILcdGXYLabelPainter

Parameters:

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

See Also:

ILcdGXYLabelPainter.getLocationIndex()

getLocationIndex

public int getLocationIndex()

Description copied from interface: ILcdGXYLabelPainter

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

Specified by:

getLocationIndex in interface ILcdGXYLabelPainter

Returns:

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

See Also:

ILcdGXYLabelPainter.setLocationIndex(int)

paintLabel

public void paintLabel(Graphics aGraphics,
                       int aLabelPainterMode,
                       ILcdGXYContext aGXYContext)

Delegates paint to the symbolizer painters that implement ILcdGXYLabelPainter if the object was accepted. Does nothing otherwise.

Specified by:

paintLabel in interface ILcdGXYLabelPainter

Specified by:

paintLabel in interface ILcdGXYLabelPainter2

Specified by:

paintLabel in class ALcdSLDRulePainter

Parameters:

aGraphics - the Graphics instance on which to paint.

aLabelPainterMode - a combination of ILcdGXYLabelPainter.DEFAULT and ILcdGXYLabelPainter.SELECTED.

aGXYContext - the ILcdGXYContext in which the label painting has to be performed.

See Also:

setObject(java.lang.Object)

getPossibleLocationCount

public int getPossibleLocationCount(Graphics aGraphics)

Retrieves the highest possible location count from the symbolizer painters that implement ILcdGXYLabelPainter. This allows to use all positions of the most sophisticated label painter.

Specified by:

getPossibleLocationCount in interface ILcdGXYLabelPainter

Parameters:

aGraphics - the Graphics the label will be painted on.

Returns:

the highest possible location count from the symbolizer painters that implement ILcdGXYLabelPainter.

See Also:

ILcdGXYLabelPainter.setLocationIndex(int)

labelBoundsSFCT

public double labelBoundsSFCT(Graphics aGraphics,
                              int aMode,
                              ILcdGXYContext aGXYContext,
                              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 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.

Specified by:

labelBoundsSFCT in interface ILcdGXYLabelPainter

Specified by:

labelBoundsSFCT in interface ILcdGXYLabelPainter2

Parameters:

aGraphics - the aGraphics to consider.

aMode - the representation mode of the label.

aGXYContext - the ILcdGXYContext the drawing depends on.

aRectangle - the Rectangle 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:

ILcdGXYViewLabelPainter, ILcdGXYLayerLabelPainter, ILcdGXYLabelPainter2.labelAnchorPointSFCT(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext, java.awt.Point)

isScaleValid

public boolean isScaleValid(ILcdGXYView aView)

Converts the views scale (pixels/meter) to a map scale (meter/meter) and compares it with the min and max scale denominators set.

Specified by:

isScaleValid in class ALcdSLDRulePainter

Parameters:

aView -

Returns:

true if the converted scale is inside min scale/max scale interval.

toString

public String toString()

Returns the display name.

Overrides:

toString in class Object

Returns:

the name of the rule painter.

See Also:

getDisplayName()

setLabelIndex

public void setLabelIndex(int aLabelIndex)

Description copied from interface: ILcdGXYMultiLabelPainter

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

Specified by:

setLabelIndex in interface ILcdGXYMultiLabelPainter

Parameters:

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

See Also:

ILcdGXYMultiLabelPainter.setSubLabelIndex(int)

getLabelIndex

public int getLabelIndex()

Description copied from interface: ILcdGXYMultiLabelPainter

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

Specified by:

getLabelIndex in interface ILcdGXYMultiLabelPainter

Returns:

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

See Also:

ILcdGXYMultiLabelPainter.setLabelIndex(int)

getLabelCount

public int getLabelCount(Graphics aGraphics,
                         ILcdGXYContext aGXYContext)

Description copied from interface: ILcdGXYMultiLabelPainter

Returns the number of labels for the object set to this label painter.

Note: when returning multiple (moveable) labels for the same object, it might be useful to use TLcdGXYEditControllerModel2.EDIT_WHAT_FIRST_TOUCHED_LABEL to avoid that a mouse drag moves them all together.

Specified by:

getLabelCount in interface ILcdGXYMultiLabelPainter

Parameters:

aGraphics - The Graphics currently painting on

aGXYContext - The ILcdGXYContext currently valid

Returns:

The number of label for the given object.

getSubLabelIndex

public int getSubLabelIndex()

Description copied from interface: ILcdGXYMultiLabelPainter

Returns the index of the sublabel to paint.

Specified by:

getSubLabelIndex in interface ILcdGXYMultiLabelPainter

Returns:

the index of the sublabel to paint.

See Also:

ILcdGXYMultiLabelPainter.setSubLabelIndex(int)

setSubLabelIndex

public void setSubLabelIndex(int aSubLabelIndex)

Description copied from interface: ILcdGXYMultiLabelPainter

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

Specified by:

setSubLabelIndex in interface ILcdGXYMultiLabelPainter

Parameters:

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

See Also:

ILcdGXYMultiLabelPainter.setLabelIndex(int)

getSubLabelCount

public int getSubLabelCount(int aLabelIndex)

Description copied from interface: ILcdGXYMultiLabelPainter

Return the number of sublabels in a label. The value should be 1 or higher.

Specified by:

getSubLabelCount in interface ILcdGXYMultiLabelPainter

Parameters:

aLabelIndex - the index of the label.

Returns:

The number of sublabels of the label with the given index.

setLabelLocation

public void setLabelLocation(TLcdLabelLocation aLabelLocation)

Description copied from interface: ILcdGXYLabelPainter2

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

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

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

Specified by:

setLabelLocation in interface ILcdGXYLabelPainter2

Parameters:

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

See Also:

ILcdGXYLabelPainter2.setObject(java.lang.Object)

getLabelLocation

public TLcdLabelLocation getLabelLocation()

Description copied from interface: ILcdGXYLabelPainter2

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

Specified by:

getLabelLocation in interface ILcdGXYLabelPainter2

Returns:

The label location that was previously set.

See Also:

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

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)

supportLabelSnap

public boolean supportLabelSnap(Graphics aGraphics,
                                ILcdGXYContext aGXYContext)

Description copied from interface: ILcdGXYLabelPainter2

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

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

Specified by:

supportLabelSnap in interface ILcdGXYLabelPainter2

Parameters:

aGraphics - the Graphics on which is worked.

aGXYContext - the ILcdGXYContext of the snapping.

Returns:

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

See Also:

labelSnapTarget

labelSnapTarget

public Object labelSnapTarget(Graphics aGraphics,
                              ILcdGXYContext aGXYContext)

Description copied from interface: ILcdGXYLabelPainter2

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

Specified by:

labelSnapTarget in interface ILcdGXYLabelPainter2

Parameters:

aGraphics - the Graphics on which is worked.

aGXYContext - the ILcdGXYContext of the snapping.

Returns:

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

getLabelCursor

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

Description copied from interface: ILcdGXYLabelPainter2

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

Specified by:

getLabelCursor in interface ILcdGXYLabelPainter2

Parameters:

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

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

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

Returns:

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