Package com.luciad.format.kml22.view.javafx

Class TLcdKML22FXBalloonContentProvider

java.lang.Object

com.luciad.format.kml22.view.javafx.TLcdKML22FXBalloonContentProvider

All Implemented Interfaces:

ILcdFXBalloonContentProvider

@LcdService(service=ILcdFXBalloonContentProvider.class,
            priority=20000)
public class TLcdKML22FXBalloonContentProvider
extends Object
implements ILcdFXBalloonContentProvider

A JavaFX compatible balloon content provider for KML objects.

An instance of this object can create balloon content for every KML feature with a description, a balloon style with a text, or a combination of both.

Since:

2020.0

Constructor Summary

Constructors

Constructor	Description
TLcdKML22FXBalloonContentProvider()	Creates a balloon content provider for KML features, using a default resource provider.

Method Summary

Modifier and Type	Method	Description
boolean	canGetContent(ALcdBalloonDescriptor aBalloonDescriptor)	Checks if it is possible to return a Node that should be used as the content.
Node	getContent(ALcdBalloonDescriptor aBalloonDescriptor)	A method that creates balloon content panels for KML features.
TLcdKML22ResourceProvider	getResourceProvider()	Gets the resource provider used by this balloon content provider
void	setResourceProvider(TLcdKML22ResourceProvider aResourceProvider)	Sets the resource provider this balloon content provider should use to retrieve its resources.

Methods inherited from class java.lang.Object

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

Constructor Details

TLcdKML22FXBalloonContentProvider

public TLcdKML22FXBalloonContentProvider()

Creates a balloon content provider for KML features, using a default resource provider.

Method Details

canGetContent

public boolean canGetContent(ALcdBalloonDescriptor aBalloonDescriptor)

Description copied from interface: ILcdFXBalloonContentProvider

Checks if it is possible to return a Node that should be used as the content. The implementation of this method should be consistent with the implementation of ILcdFXBalloonContentProvider.getContent(ALcdBalloonDescriptor), i.e. when this method returns false, ILcdFXBalloonContentProvider.getContent(ALcdBalloonDescriptor) should return null and vice versa.

Specified by:

canGetContent in interface ILcdFXBalloonContentProvider

Parameters:

aBalloonDescriptor - An object describing a balloon.

Returns:

true if a content Node can be returned for the given ALcdBalloonDescriptor and false otherwise.

getContent

public Node getContent(ALcdBalloonDescriptor aBalloonDescriptor)

A method that creates balloon content panels for KML features.

Specified by:

getContent in interface ILcdFXBalloonContentProvider

Parameters:

aBalloonDescriptor - an object that represents a balloon. It can contain one of a TLcdKML22DynamicModel, a TLcdKML22PaintableGroundOverlay or a TLcdKML22AbstractFeature.

Returns:

A Node that is capable of rendering HTML using the standard KML resource provider. null if aBalloonDescriptor does not provide access to a KML feature.

getResourceProvider

public TLcdKML22ResourceProvider getResourceProvider()

Gets the resource provider used by this balloon content provider

Returns:

a TLcdKML22ResourceProvider

setResourceProvider

public void setResourceProvider(TLcdKML22ResourceProvider aResourceProvider)

Sets the resource provider this balloon content provider should use to retrieve its resources.

Parameters:

aResourceProvider - a TLcdKML22ResourceProvider