Package com.luciad.view.gxy

Class TLcdGXYCurvedPathLabelLocation

java.lang.Object

com.luciad.view.TLcdLabelLocation

com.luciad.view.gxy.TLcdGXYCurvedPathLabelLocation

All Implemented Interfaces:

Cloneable

public class TLcdGXYCurvedPathLabelLocation
extends TLcdLabelLocation

This label location contains two extra fields used to identify the position of a label on an awt path. This label location extension is used by

• TLcdGXYCurvedPathLabelingAlgorithm
• TLcdGXYCurvedPathLabelPainter

The sub path index is used to identify the sub-path of an ILcdAWTPath. The path parameter is used to identify a location on that sub-path. The parameter lies in the interval [0, 1].

Since:

11.0

See Also:

• ALcdLabelLocations
• ILcdGXYEditableLabelsLayer

Field Summary

Fields inherited from class com.luciad.view.TLcdLabelLocation

ABSOLUTE_POSITION, EDITED_BY_LABEL_EDITOR, EDITED_BY_LAYER_OR_VIEW_LABEL_PAINTER, STICKY_LABEL_LOCATION, TEMPORARY_STICKY_LABEL_LOCATION

Constructor Summary

Constructors

Constructor	Description
TLcdGXYCurvedPathLabelLocation()

Method Summary

Modifier and Type	Method	Description
Object	clone()	Redefines the clone method to be public.
void	copyFrom(TLcdLabelLocation aSourceLabelLocation)	Copies the properties of aSourceLabelLocation into this object.
double	getAWTPathParameter()	Returns the parameter used to identify a location on a sub-path of an ILcdAWTPath.
int	getSubPathIndex()	Returns the index used to identify the sub-path of an ILcdAWTPath.
void	setAWTPathParameter(double aAWTPathParameter)	Set the parameter used to identify a location on a sub-path of an ILcdAWTPath.
void	setSubPathIndex(int aSubPathIndex)	Sets the index used to identify the sub-path of an ILcdAWTPath.
String	toString()

Methods inherited from class com.luciad.view.TLcdLabelLocation

getAnchorPoint, getLabelEditMode, getLocationIndex, getLocationX, getLocationY, getParentBoundsRectangle, getParentBoundsRotation, getParentLabel, getRotation, isBodyLabel, isInteractiveLabel, isSticky, setBodyLabel, setInteractiveLabel, setLabelEditMode, setLocationIndex, setLocationX, setLocationY, setParentBounds, setParentLabel, setRotation

Methods inherited from class java.lang.Object

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

Constructor Details

TLcdGXYCurvedPathLabelLocation

public TLcdGXYCurvedPathLabelLocation()

Method Details

getSubPathIndex

public int getSubPathIndex()

Returns the index used to identify the sub-path of an ILcdAWTPath.

Returns:

the index used to identify the sub-path of an ILcdAWTPath.

See Also:

• setSubPathIndex(int)

setSubPathIndex

public void setSubPathIndex(int aSubPathIndex)

Sets the index used to identify the sub-path of an ILcdAWTPath. This index determines the subpath on which this label will be placed.

Parameters:

aSubPathIndex - the index used to identify the sub-path of an ILcdAWTPath.

See Also:

• getSubPathIndex()

getAWTPathParameter

public double getAWTPathParameter()

Returns the parameter used to identify a location on a sub-path of an ILcdAWTPath.

Returns:

the parameter used to identify a location on a sub-path of an ILcdAWTPath.

See Also:

• setAWTPathParameter(double)

setAWTPathParameter

public void setAWTPathParameter(double aAWTPathParameter)

Set the parameter used to identify a location on a sub-path of an ILcdAWTPath.

The parameter should lie in the interval [0, 1]. If it lies outside the interval [0, 1], this label location should be handled as a regular TLcdLabelLocation.

Parameters:

aAWTPathParameter - the parameter used to identify a location on a sub-path of an ILcdAWTPath.

See Also:

• getAWTPathParameter()

copyFrom

public void copyFrom(TLcdLabelLocation aSourceLabelLocation)

Description copied from class: TLcdLabelLocation

Copies the properties of aSourceLabelLocation into this object. No reference to aSourceLabelLocation is kept when this method returns. In other words, this method creates a clone in an already existing instance, hence avoiding the overhead of creating a new instance.

Overrides:

copyFrom in class TLcdLabelLocation

Parameters:

aSourceLabelLocation - The TLcdLabelLocation whose properties you wish to copy.

See Also:

• TLcdLabelLocation.clone()

toString

public String toString()

Overrides:

toString in class TLcdLabelLocation

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from class: TLcdLabelLocation

Redefines the clone method to be public. Returns a clone of this instance. Since there are no references to other objects, no other objects are cloned in the default implementation.

Overrides:

clone in class TLcdLabelLocation

Returns:

A clone of this TLcdLabelLocation instance.

Throws:

CloneNotSupportedException