TLcdICAORunwayPainter (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.ais.symbology.icao.TLcdICAORunwayPainter

All Implemented Interfaces:

ILcdCloneable, ILcdPropertyChangeSource, ILcdGXYPainter, ILcdGXYPainterProvider, Serializable, Cloneable
```
public class TLcdICAORunwayPainter
extends Object
implements ILcdGXYPainter, ILcdGXYPainterProvider
```
This painter paints ILcdRunway objects according to the ICAO guidelines for aeronautical charts. Each runway with two or more points will be painted as a rectangle. This rectangle is constructed by using the first and the last point of the runway. Runways with less than two points will not be painted; nonetheless, a valid ILcdGXYPainter will be returned for them when invoking getGXYPainter().
If a surface type property is available for the runway objects, the surface type is used to determine a paint style for the rectangle, following the ICAO guidelines:
- If the surface type is hard, the rectangle will be filled.
- If the surface type is soft, the rectangle will be dotted.
If the surface type property is not available, the rectangle will be outlined (not filled). To allow this painter to retrieve the surface type for runways, the surface type expression must be set through setSurfaceTypeExpression.
This painter evaluates its expressions using an instance of TLcdDataObjectExpressionLanguage.
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALWAYS` Use this fill mode to always paint a fill by default.
`static String`	`BY_SURFACE_TYPE` Use this fill mode to paint a fill if a surface type is available.
`static String`	`NO_FILL` Use this fill mode to disable the fill entirely.

Fields inherited from interface com.luciad.view.gxy.ILcdGXYPainter
BODY, CREATING, DEFAULT, HANDLES, RESHAPING, SELECTED, SNAPS, TRANSLATING

Constructor Summary

Constructors
Constructor and Description
`TLcdICAORunwayPainter()` Creates a new `TLcdICAORunwayPainter` object.
`TLcdICAORunwayPainter(TLcdICAORunwayPainter aICAORunwayPainter)` Copy constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener aPropertyChangeListener)` Registers the given `PropertyChangeListener` to be notified when this object's properties change.
`void`	`anchorPointSFCT(Graphics aGraphics, int aSequenceNumber, ILcdGXYContext aContext, Point aPoint)` Moves the Point passed to the location (in view coordinates, pixels) of the anchor point of the representation of the object in the given mode taking into account the given context.
`void`	`boundsSFCT(Graphics aGraphics, int aSequenceNumber, ILcdGXYContext aContext, ILcd2DEditableBounds aILcd2DEditableBounds)` Sets the supplied bounds (in view coordinates, pixels) so that it encompasses the representation of the object in the given mode taking into account the given context.
`Object`	`clone()` Makes `Object.clone()` public.
`Cursor`	`getCursor(Graphics aGraphics, int aSequenceNumber, ILcdGXYContext aContext)` Returns a cursor that clarifies the mode and context the painter is operating in.
`Color`	`getDefaultColor()` Returns the default color.
`String`	`getDisplayName()` Returns a textual representation of this painter.
`ILcdGXYPainter`	`getGXYPainter(Object aObject)` Returns a painter for `ILcdRunway` objects.
`Object`	`getObject()` Returns the Object for which the representation is currently being handled by this painter.
`Color`	`getSelectionColor()` Returns the selection color.
`ILcdIcon`	`getSnapIcon()`
`boolean`	`isTouched(Graphics aGraphics, int aSequenceNumber, ILcdGXYContext aContext)` Checks if the representation of the object in the given mode is touched at the location as defined in the supplied context.
`void`	`paint(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext)` Overrides the paint method of the `TLcdGXYPointListPainter` class.
`void`	`removePropertyChangeListener(PropertyChangeListener aPropertyChangeListener)` De-registers the given `PropertyChangeListener` from receiving property change events for this object.
`void`	`setDefaultColor(Color aDefaultColor)` Specifies the default color.
`void`	`setFillMode(String aFillMode)` Sets the fill mode of this painter that determines when a runway should be painted with a fill.
`void`	`setLineStyle(TLcdG2DLineStyle aLineStyle)` Specifies a `TLcdG2DLineStyle` object that will be used to draw the runway bounds.
`void`	`setObject(Object aObject)` Sets the Object for which the representation shall be handled by this painter.
`void`	`setPaintCache(boolean aPaintCache)` Sets whether the paint cache must be enabled.
`void`	`setSelectionColor(Color aSelectionColor)` Specifies the selection color.
`void`	`setSnapIcon(ILcdIcon aSnapIcon)`
`void`	`setSurfaceTypeExpression(String aSurfaceTypeExpression)` Sets the expression that evaluates to to surface type of the runway object.
`void`	`setSurfaceTypeIndex(int aSurfaceTypeIndex)` Deprecated. Use `setSurfaceTypeExpression(String)`
`Object`	`snapTarget(Graphics aGraphics, ILcdGXYContext aGXYContext)` Returns an object that can be used as snapping target when graphically editing an object.
`boolean`	`supportSnap(Graphics aGraphics, ILcdGXYContext aGXYContext)` Returns whether the painter can provide a snap target based on the representation of the object in the given context.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NO_FILL
```
public static final String NO_FILL
```
    Use this fill mode to disable the fill entirely.
    
    See Also:
    
    setFillMode(String), Constant Field Values
  - BY_SURFACE_TYPE
```
public static final String BY_SURFACE_TYPE
```
    Use this fill mode to paint a fill if a surface type is available. The fill that is used depends on the type of surface.
    No fill is painted if the surface type is unknown or not available.
    
    See Also:
    
    setFillMode(String), Constant Field Values
  - ALWAYS
```
public static final String ALWAYS
```
    Use this fill mode to always paint a fill by default. The fill that is used depends on the type of surface.
    
    See Also:
    
    setFillMode(String), Constant Field Values
- Constructor Detail
  - TLcdICAORunwayPainter
```
public TLcdICAORunwayPainter()
```
    Creates a new TLcdICAORunwayPainter object.
  - TLcdICAORunwayPainter
```
public TLcdICAORunwayPainter(TLcdICAORunwayPainter aICAORunwayPainter)
```
    Copy constructor.
    
    Parameters:
    
    aICAORunwayPainter - the TLcdICAORunwayPainter to be copied.
- Method Detail
  - setObject
```
public void setObject(Object aObject)
```
    Description copied from interface: ILcdGXYPainter
    
    Sets the Object for which the representation shall be handled by this painter.
    Setting the object on the painter may have an effect on the internal state of the painter, for example, the color to use.
    
    When the object is set to a painter, the context parameter in subsequent calls to methods in this class must contain a layer that contains this object and for which the painter for this object is this painter.
    
    Specified by:
    
    setObject in interface ILcdGXYPainter
    
    Parameters:
    
    aObject - the object for which the representation shall be handled by this painter.
    
    See Also:
    
    ILcdGXYPainter.getObject()
  - getObject
```
public Object getObject()
```
    Description copied from interface: ILcdGXYPainter
    
    Returns the Object for which the representation is currently being handled by this painter.
    
    Specified by:
    
    getObject in interface ILcdGXYPainter
    
    Returns:
    
    the Object for which the representation is currently being handled by this painter.
    
    See Also:
    
    ILcdGXYPainter.setObject(Object)
  - setSnapIcon
```
public void setSnapIcon(ILcdIcon aSnapIcon)
```
  - getSnapIcon
```
public ILcdIcon getSnapIcon()
```
  - boundsSFCT
```
public void boundsSFCT(Graphics aGraphics,
                       int aSequenceNumber,
                       ILcdGXYContext aContext,
                       ILcd2DEditableBounds aILcd2DEditableBounds)
                throws TLcdNoBoundsException
```
    Description copied from interface: ILcdGXYPainter
    
    Sets the supplied bounds (in view coordinates, pixels) so that it encompasses the representation of the object in the given mode taking into account the given context.
    If this method returns without exception the bounds argument must encompass the representation of the object. A point outside the bounds will not be contained within the painted object.
    
    The bounds returned in this method can be seen as the equivalent in the view space of the bounds in the model space for ILcdBounded objects.
    
    Specified by:
    
    boundsSFCT in interface ILcdGXYPainter
    
    Parameters:
    
    aGraphics - the Graphics on which the representation of the object is painted
    
    aSequenceNumber - 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.
    
    aContext - 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.
    
    aILcd2DEditableBounds - 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 - if no bounds can be determined for the representation of the object. This can happen when the object does not have a representation in the given context, for example when it is located in a part of the world which is not visible in the current view.
    
    See Also:
    
    isTouched
  - isTouched
```
public boolean isTouched(Graphics aGraphics,
                         int aSequenceNumber,
                         ILcdGXYContext aContext)
```
    Description copied from interface: ILcdGXYPainter
    Checks if the representation of the object in the given mode is touched at the location as defined in the supplied context.
    The location that must be taken into account to check whether the representation is touched can be retrieved from the context passed with the methods ILcdGXYContext.getX() and ILcdGXYContext.getY(). If the check is part of an ongoing operation of user interaction, for example, when the mouse is being dragged, the location of the start of the operation can also be taken into account using the methods ILcdGXYContext.getDeltaX() and ILcdGXYContext.getDeltaY(). The context contains the transformations required to convert this location into the equivalent location in model space. Implementations of this interface usually follow either of the following patterns:
    - transform the location of the interaction back to model space and compare the coordinates with the object in model space.
    - transform the location to world space and compare with a world representation of the object. This forces the painter into caching a world representation of the object. Caching a view representation of an object is not very practical as it would have to change whenever the view's scale changes or when it is panned. A world representation of an object only changes when the view's XYWorldReference changes, which happens less frequently.
    As the mode influences the way an object is represented, it must also be taken into account when checking whether that representation is being touched. When the mode contains CREATING, RESHAPING or TRANSLATING which indicate that the object must be represented in a state for an ongoing operation, the location of the start of the operation may be taken into account as mentioned above. The painting result can take into account multiple locations, to respond to, for example, multi-touch input. When the mode contains SELECTED, the painter should also check if the non-selected representation is touched, since these are always painted on top of each other.
    
    The boundsSFCT is often used to speed up the performance of this method as a location outside these bounds can never touch the representation of the object.
    
    Note that this method does not give an indication of what part of the object is touched. It is up to the painter implementations to provide methods to make this distinction. The method does also not indicate what sensitivity must be applied when checking if an object is touched. It is up to the implementation to decide what should be the maximum distance between the location given in the context and the closest relevant point or area of the representation of the object.
    Specified by:
    
    isTouched in interface ILcdGXYPainter
    
    Parameters:
    
    aGraphics - the Graphics on which the representation of the object is painted
    
    aSequenceNumber - the mode the object is represented in
    
    aContext - contains the location of the interaction and the transformations to convert this location into model coordinates
    
    Returns:
    
    true if the representation of the object in the given mode is touched by the location as defined in the context passed, false otherwise
    
    See Also:
    
    boundsSFCT
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener aPropertyChangeListener)
```
    Description copied from interface: ILcdPropertyChangeSource
    
    Registers the given PropertyChangeListener to be notified when this object's properties change.
    
    In case you need to register a listener which keeps a reference to an object with a shorter life-time than this change source, you can use a ALcdWeakPropertyChangeListener instance as property change listener.
    
    Specified by:
    
    addPropertyChangeListener in interface ILcdPropertyChangeSource
    
    Parameters:
    
    aPropertyChangeListener - The listener to be notified
    
    See Also:
    
    ALcdWeakPropertyChangeListener, ILcdPropertyChangeSource.removePropertyChangeListener(java.beans.PropertyChangeListener)
  - anchorPointSFCT
```
public void anchorPointSFCT(Graphics aGraphics,
                            int aSequenceNumber,
                            ILcdGXYContext aContext,
                            Point aPoint)
                     throws TLcdNoBoundsException
```
    Description copied from interface: ILcdGXYPainter
    
    Moves the Point passed to the location (in view coordinates, pixels) of the anchor point of the representation of the object in the given mode taking into account the given context.
    The anchor point is an important point of the representation, typically the point which would be used when the object would be represented as a single point. The anchor point is mostly used to attach extra information to the representation of an object, for example, using labels. A typical implementation of this method for painters which can handle ILcdShape objects is the location of the focus point of the shape.
    
    Specified by:
    
    anchorPointSFCT in interface ILcdGXYPainter
    
    Parameters:
    
    aGraphics - the Graphics on which the representation of the object is painted
    
    aSequenceNumber - the mode the object is painted in (see class documentation)
    
    aContext - 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 - if no anchor point can be determined for the representation of the object. This can be when the object does not have a representation in the given context, for example when it is located in a part of the world which is not visible in the projection as set in the views world reference.
    
    See Also:
    
    paint
  - clone
```
public Object clone()
```
    Description copied from interface: ILcdCloneable
    Makes Object.clone() public.
    When for example extending from java.lang.Object, it can be implemented like this:
```
 public Object clone() {
   try {
     return super.clone();
   } catch ( CloneNotSupportedException e ) {
     // Cannot happen: extends from Object and implements Cloneable (see also Object.clone)
     throw new RuntimeException( e );
   }
 }
 
```
    Specified by:
    
    clone in interface ILcdCloneable
    
    Specified by:
    
    clone in interface ILcdGXYPainterProvider
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a clone of this painter provider.
    
    See Also:
    
    Object.clone()
  - getCursor
```
public Cursor getCursor(Graphics aGraphics,
                        int aSequenceNumber,
                        ILcdGXYContext aContext)
```
    Description copied from interface: ILcdGXYPainter
    
    Returns a cursor that clarifies the mode and context the painter is operating in. For example, when the mode is TRANSLATING, the cursor could be the MOVE cursor. When no specific cursor is required implementations must return null.
    
    Specified by:
    
    getCursor in interface ILcdGXYPainter
    
    Parameters:
    
    aGraphics - the Graphics on which the representation of the object is painted
    
    aSequenceNumber - the rendering mode to return the cursor for.
    
    aContext - the context in which the rendering occurs.
    
    Returns:
    
    a Cursor to indicate the type of operating aMode and aGXYContext. Returns null if no particular Cursor is required.
  - getDisplayName
```
public String getDisplayName()
```
    Description copied from interface: ILcdGXYPainter
    
    Returns a textual representation of this painter. This can be useful when different representations of an object are handled by different painter implementations. Having a textual representation can facilitate choosing between different painter implementations.
    
    Specified by:
    
    getDisplayName in interface ILcdGXYPainter
    
    Returns:
    
    a textual representation of this painter.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener aPropertyChangeListener)
```
    Description copied from interface: ILcdPropertyChangeSource
    
    De-registers the given PropertyChangeListener from receiving property change events for this object.
    
    If the listener was added more than once, it will be notified one less time after being removed. If the listener is null, or was never added, no exception is thrown and no action is taken.
    
    Specified by:
    
    removePropertyChangeListener in interface ILcdPropertyChangeSource
    
    Parameters:
    
    aPropertyChangeListener - the listener that should no longer be notified of changes of this object's properties
    
    See Also:
    
    ILcdPropertyChangeSource.addPropertyChangeListener(java.beans.PropertyChangeListener)
  - snapTarget
```
public Object snapTarget(Graphics aGraphics,
                         ILcdGXYContext aGXYContext)
```
    Description copied from interface: ILcdGXYPainter
    
    Returns an object that can be used as snapping target when graphically editing an object. For example, an object which is beneath the current mouse position (as given in the context).
    This method must only be called when supportSnap returns true for the given context.
    
    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:
    
    an object that can be used as snapping target when graphically editing an object. It must be defined in the same model reference as the object set to this painter.
    
    See Also:
    
    supportSnap
  - supportSnap
```
public boolean supportSnap(Graphics aGraphics,
                           ILcdGXYContext aGXYContext)
```
    Description copied from interface: ILcdGXYPainter
    
    Returns whether the painter can provide a snap target based on the representation of the object in the given context.
    
    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 an object can be returned that can be used to snap to in the given context, false otherwise.
  - getGXYPainter
```
public ILcdGXYPainter getGXYPainter(Object aObject)
```
    Returns a painter for ILcdRunway objects. In all other cases, null is returned.
    
    Specified by:
    
    getGXYPainter in interface ILcdGXYPainterProvider
    
    Parameters:
    
    aObject - An object to return a painter for.
    
    Returns:
    
    a painter for ILcdRunway objects, null otherwise.
  - paint
```
public void paint(Graphics aGraphics,
                  int aMode,
                  ILcdGXYContext aGXYContext)
```
    Overrides the paint method of the TLcdGXYPointListPainter class. We distinguish between three different situations:
    1. The runway has a high end and a low end. Its surface type is hard.
      This kind of runway will e represented by a filled rectangle.
    2. The runway has a high end and a low end. Its surface type is unpaved (or soft).
      This time, the runway will be painted as a dotted rectangle.
    3. The runway has a high end and a low end. Its surface type is unknown or unavailable.
      Such a runway will be painted outlined (not filled).
    Specified by:
    
    paint in interface ILcdGXYPainter
    
    Parameters:
    
    aGraphics - The Graphics to paint on.
    
    aMode - The paint mode.
    
    aGXYContext - The paint context.
  - setSurfaceTypeIndex
```
@Deprecated
public void setSurfaceTypeIndex(int aSurfaceTypeIndex)
```
    Deprecated. Use setSurfaceTypeExpression(String)
    Sets the index of the surface type feature ILcdRunwayFeature.SURFACE_TYPE. If set, it is used to determine a paint style for each runway, following the ICAO guidelines:
    - If the surface type is hard, the runway will be filled.
    - If the surface type is soft, the runway will be dotted.
    If the surface type feature is not available, the runway will be outlined (not filled).
    Parameters:
    
    aSurfaceTypeIndex - The index of the surface type feature.
  - setSurfaceTypeExpression
```
public void setSurfaceTypeExpression(String aSurfaceTypeExpression)
```
    Sets the expression that evaluates to to surface type of the runway object. If set, it is used to determine a paint style for each runway, following the ICAO guidelines:
    - If the surface type is hard, the runway will be filled.
    - If the surface type is soft, the runway will be dotted.
    If the surface type expression is not available, the runway will be outlined (not filled).
    Expressions are evaluated using an instance of TLcdDataObjectExpressionLanguage.
    Parameters:
    
    aSurfaceTypeExpression - the surface type property.
  - getDefaultColor
```
public Color getDefaultColor()
```
    Returns the default color.
    
    Returns:
    
    the default color.
  - setDefaultColor
```
public void setDefaultColor(Color aDefaultColor)
```
    Specifies the default color.
    
    Parameters:
    
    aDefaultColor - the default color.
  - setFillMode
```
public void setFillMode(String aFillMode)
```
    Sets the fill mode of this painter that determines when a runway should be painted with a fill.
    By default this is set to FillMode.BY_SURFACE_TYPE.
    
    Parameters:
    
    aFillMode - A valid FillMode, must not be null
  - getSelectionColor
```
public Color getSelectionColor()
```
    Returns the selection color.
    
    Returns:
    
    the selection color.
  - setSelectionColor
```
public void setSelectionColor(Color aSelectionColor)
```
    Specifies the selection color.
    
    Parameters:
    
    aSelectionColor - the selection color.
  - setLineStyle
```
public void setLineStyle(TLcdG2DLineStyle aLineStyle)
```
    Specifies a TLcdG2DLineStyle object that will be used to draw the runway bounds.
    
    Parameters:
    
    aLineStyle - a TLcdG2DLineStyle object.
  - setPaintCache
```
public void setPaintCache(boolean aPaintCache)
```
    Sets whether the paint cache must be enabled.
    
    Parameters:
    
    aPaintCache - whether the paint cache must be enabled.

Aviation StandardsClass TLcdICAORunwayPainter

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_FILL

BY_SURFACE_TYPE

ALWAYS

Constructor Detail

TLcdICAORunwayPainter

TLcdICAORunwayPainter

Method Detail

setObject

getObject

setSnapIcon

getSnapIcon

boundsSFCT

isTouched

addPropertyChangeListener

anchorPointSFCT

clone

getCursor

getDisplayName

removePropertyChangeListener

snapTarget

supportSnap

getGXYPainter

paint

setSurfaceTypeIndex

setSurfaceTypeExpression

getDefaultColor

setDefaultColor

setFillMode

getSelectionColor

setSelectionColor

setLineStyle

setPaintCache