com.luciad.ais.view.gxy

Aviation StandardsClass TLcdGXYProcedureTrajectoryLegLabelPainter

java.lang.Object

com.luciad.ais.view.gxy.TLcdGXYProcedureTrajectoryLegLabelPainter

All Implemented Interfaces:

ILcdGXYLabelPainter, ILcdGXYLabelPainterProvider, ILcdGXYMultiLabelPainter, Serializable, Cloneable

public class TLcdGXYProcedureTrajectoryLegLabelPainter
extends Object
implements ILcdGXYMultiLabelPainter, ILcdGXYLabelPainterProvider

A label painter for procedure trajectory legs. This class provides the exact same functionality as the GXYProcedureTrajectoryLegLabelPainter sample class, and is actually a wrapper around it. This construct allows to either use this label painter as-is, or to not use it at all and replace it with the identical GXYProcedureTrajectoryLegLabelPainter. As the source code of the latter is available as sample code, it can be customized. Please refer to GXYProcedureTrajectoryLegLabelPainter for an explanation of what this painter does.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALTITUDE_DESCRIPTION
static int	ALTITUDE_LOWER
static int	ALTITUDE_UPPER
static int	COURSE
static int	DISTANCE
static int	DURATION
static int	IAP_FIX_ROLE
static int	LEG_TYPE
static int	OVERFLY_TYPE
static int	RHO
static int	ROUTE_TYPE
static int	SEQUENCE_NUMBER
static int	THETA
static int	TURN_DIRECTION

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

DEFAULT, SELECTED

Constructor Summary

Constructors

Constructor and Description
TLcdGXYProcedureTrajectoryLegLabelPainter() Creates a new TLcdGXYProcedureTrajectoryLegLabelPainter.

Method Summary

Modifier and Type	Method and Description
Object	clone() Redefines Object.clone to make it public.
ILcdGXYLabelPainter	getGXYLabelPainter(Object aObject) Finds an ILcdGXYLabelPainter that can be used to label the object passed.
TLcdGXYFeaturedLabelPainter	getInternalLabelPainter()
int	getLabelCount(Graphics aGraphics, ILcdGXYContext aContext) Returns the number of labels for the object set to this label painter.
int	getLabelIndex() Returns the index of the label that is currently painted or scheduled to paint.
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) Returns the number of possible locations where this ILcdGXYLabelPainter can paint/draw the labels of the set domain Object.
int	getSubLabelCount(int aIndex) Return the number of sublabels in a label.
int	getSubLabelIndex() Returns the index of the sublabel to paint.
double	labelBoundsSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aContext, Rectangle aRectangle) Calculates the bounds of the label that can be painted.
void	paintLabel(Graphics aGraphics, int aMode, ILcdGXYContext aContext) Paints the label of the set Object on aGraphics.
void	setLabelIndex(int aIndex) Sets the label.
void	setLabelProperties(int[] aLabelProperties) Sets the procedure leg properties that need to be displayed on the labels.
void	setLocationIndex(int aIndex) Sets the index of location where to paint the label(s) of the set Object.
void	setObject(Object aObject) Sets the Object to be labeled by this ILcdGXYLabelPainter.
void	setSubLabelIndex(int aIndex) Sets the sublabel index.

Methods inherited from class java.lang.Object

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

Field Detail

SEQUENCE_NUMBER

public static final int SEQUENCE_NUMBER

See Also:

Constant Field Values

ROUTE_TYPE

public static final int ROUTE_TYPE

See Also:

Constant Field Values

LEG_TYPE

public static final int LEG_TYPE

See Also:

Constant Field Values

OVERFLY_TYPE

public static final int OVERFLY_TYPE

See Also:

Constant Field Values

TURN_DIRECTION

public static final int TURN_DIRECTION

See Also:

Constant Field Values

RHO

public static final int RHO

See Also:

Constant Field Values

THETA

public static final int THETA

See Also:

Constant Field Values

COURSE

public static final int COURSE

See Also:

Constant Field Values

DISTANCE

public static final int DISTANCE

See Also:

Constant Field Values

DURATION

public static final int DURATION

See Also:

Constant Field Values

ALTITUDE_DESCRIPTION

public static final int ALTITUDE_DESCRIPTION

See Also:

Constant Field Values

ALTITUDE_UPPER

public static final int ALTITUDE_UPPER

See Also:

Constant Field Values

ALTITUDE_LOWER

public static final int ALTITUDE_LOWER

See Also:

Constant Field Values

IAP_FIX_ROLE

public static final int IAP_FIX_ROLE

See Also:

Constant Field Values

Constructor Detail

TLcdGXYProcedureTrajectoryLegLabelPainter

public TLcdGXYProcedureTrajectoryLegLabelPainter()

Creates a new TLcdGXYProcedureTrajectoryLegLabelPainter.

Method Detail

getInternalLabelPainter

public TLcdGXYFeaturedLabelPainter getInternalLabelPainter()

setLabelProperties

public void setLabelProperties(int[] aLabelProperties)

Sets the procedure leg properties that need to be displayed on the labels. Call this method with a null argument to revert to the default behavior of the internal label painter (i.e. retrieve the labels based on feature indices).

Parameters:

aLabelProperties - An array containing any of the SEQUENCE_NUMBER, ROUTE_TYPE, etc. constants.

getObject

public Object getObject()

Description copied from interface: ILcdGXYLabelPainter

Gets the Object this ILcdGXYLabelPainter can label.

Specified by:

getObject in interface ILcdGXYLabelPainter

Returns:

the Object this ILcdGXYLabelPainter can label.

See Also:

ILcdGXYLabelPainter.setObject(java.lang.Object)

setObject

public void setObject(Object aObject)

Description copied from interface: ILcdGXYLabelPainter

Sets the Object to be labeled by this ILcdGXYLabelPainter.

Specified by:

setObject in interface ILcdGXYLabelPainter

Parameters:

aObject - The object to be labeled.

See Also:

ILcdGXYLabelPainter.getObject()

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)

setLocationIndex

public void setLocationIndex(int aIndex)

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:

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

See Also:

ILcdGXYLabelPainter.getLocationIndex()

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)

setLabelIndex

public void setLabelIndex(int aIndex)

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:

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

getLabelCount

public int getLabelCount(Graphics aGraphics,
                         ILcdGXYContext aContext)

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

aContext - 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 aIndex)

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:

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

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:

aIndex - the index of the label.

Returns:

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

paintLabel

public void paintLabel(Graphics aGraphics,
                       int aMode,
                       ILcdGXYContext aContext)

Description copied from interface: ILcdGXYLabelPainter

Paints the label of the set Object 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 label of the set Object in the given mode, considering aGXYContext and the possible locations aLocationIndex (of multiple alternatives).

The domain Object of the label to be painted and the location index should be set before calling this method using the setObject and setLocationIndex methods respectively.

Specified by:

paintLabel in interface ILcdGXYLabelPainter

Parameters:

aGraphics - the Graphics instance on which to paint.

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

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

See Also:

ILcdGXYLabelPainter.DEFAULT, ILcdGXYLabelPainter.SELECTED

getPossibleLocationCount

public int getPossibleLocationCount(Graphics aGraphics)

Description copied from interface: ILcdGXYLabelPainter

Returns the number of possible locations where this 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.

Specified by:

getPossibleLocationCount in interface ILcdGXYLabelPainter

Parameters:

aGraphics - the Graphics the label will be painted on.

Returns:

the number of possible locations where this ILcdGXYLabelPainter can paint/draw the labels of the set Object.

See Also:

ILcdGXYLabelPainter.setLocationIndex(int)

labelBoundsSFCT

public double labelBoundsSFCT(Graphics aGraphics,
                              int aMode,
                              ILcdGXYContext aContext,
                              Rectangle aRectangle)
                       throws TLcdNoBoundsException

Description copied from interface: ILcdGXYLabelPainter

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 object for which the bounds are retrieved and the location index of the label should be set before calling this method using the ILcdGXYLabelPainter.setObject(java.lang.Object) and ILcdGXYLabelPainter.setLocationIndex(int) methods respectively.

Specified by:

labelBoundsSFCT in interface ILcdGXYLabelPainter

Parameters:

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.

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:

ILcdGXYLabelPainter.DEFAULT, ILcdGXYLabelPainter.SELECTED

clone

public Object clone()

Description copied from interface: ILcdGXYLabelPainter

Redefines Object.clone to make it public.

Specified by:

clone in interface ILcdGXYLabelPainter

Specified by:

clone in interface ILcdGXYLabelPainterProvider

Overrides:

clone in class Object

getGXYLabelPainter

public ILcdGXYLabelPainter getGXYLabelPainter(Object aObject)

Description copied from interface: ILcdGXYLabelPainterProvider

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

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

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

Specified by:

getGXYLabelPainter in interface ILcdGXYLabelPainterProvider

Parameters:

aObject - the object to find a label painter for

Returns:

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