Package com.luciad.format.kml22.view.gxy

Class TLcdKML22GXYPainterProvider

java.lang.Object
com.luciad.format.kml22.view.gxy.TLcdKML22GXYPainterProvider
All Implemented Interfaces:
ILcdCloneable, ILcdGXYPainterProvider, Serializable, Cloneable
public class TLcdKML22GXYPainterProvider extends Object implements ILcdGXYPainterProvider

The main ILcdGXYPainterProvider for KML 2.2 abstract features

This painter provider is capable of providing painters for the following KML 2.2 domain objects:

  • TLcdKML22Placemark
  • TLcdKML22PaintableGroundOverlay
  • TLcdKML22ScreenOverlay
  • TLcdKML22PhotoOverlay

All of the painters returned by the TLcdKML22GXYPainterProvider are capable of retrieving TLcdKML22Style instances for the KML features they paint.

Since:
10.0
See Also:

  • Constructor Details

    • TLcdKML22GXYPainterProvider

      public TLcdKML22GXYPainterProvider(TLcdKML22ResourceProvider aResourceProvider)
      Creates a new KML GXY Painter Provider with the given arguments.
      Parameters:
      aResourceProvider - a TLcdKML22ResourceProvider capable of resolving images and styles for KML features that require them.

  • Method Details

    • getGXYPainter

      public ILcdGXYPainter getGXYPainter(Object aObject)
      Description copied from interface: ILcdGXYPainterProvider
      Finds an ILcdGXYPainter that can be used to paint or locate the object passed.

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

      
 public ILcdGXYPainter getGXYPainter(Object aObject) {
   ILcdGXYPainter painter = ... // find the painter for the object
   if (painter != null) {
    painter.setObject(aObject);
   }
   return painter;
 }

      Specified by:
      getGXYPainter in interface ILcdGXYPainterProvider
      Parameters:
      aObject - the object to find a painter for
      Returns:
      a painter that can be used to paint or locate the object; or null if no painter could be found for the given object, or the object could not be set on the retrieved painter.

    • clone

      public Object clone()
      Description copied from interface: ILcdGXYPainterProvider
      Redefines Object.clone to make it public.
      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:

    • getGroundOverlayPainter

      public ILcdRasterPainter getGroundOverlayPainter()
      Gets the ILcdRasterPainter that is used to paint TLcdKML22PaintableGroundOverlay instances.
      Returns:
      The raster painter that is used to paint paintable groundoverlays.

    • getDefaultLoadingIcon

      public ILcdIcon getDefaultLoadingIcon()

      Gets the default icon used while loading is in progress. By default this is null, which indicates that there is no loading icon for point-based placemarks.

      The loading icon is displayed while the icon of a point-based Placemark is being retrieved over a network.

      Returns:
      the default loading icon for point-based placemarks, or null if no icon needs to be displayed.

    • setDefaultLoadingIcon

      public void setDefaultLoadingIcon(ILcdIcon aDefaultLoadingIcon)

      Sets the default icon used while loading is in progress. If this is null, it indicates that there is no loading icon to be displayed for point-based placemarks.

      The loading icon is displayed while the icon of a point-based Placemark is being retrieved over a network.

      Parameters:
      aDefaultLoadingIcon - the default loading icon for point-based placemarks, or null if no icon needs to be displayed.