com.luciad.lucy.gui.balloon

LuciadLightspeedClass TLcyCompositeBalloonContentProvider

java.lang.Object

com.luciad.lucy.util.TLcyGenericComposite<ILcdBalloonContentProvider>

com.luciad.lucy.gui.balloon.TLcyCompositeBalloonContentProvider

All Implemented Interfaces:

ILcdBalloonContentProvider, Iterable<ILcdBalloonContentProvider>

public class TLcyCompositeBalloonContentProvider
extends TLcyGenericComposite<ILcdBalloonContentProvider>
implements ILcdBalloonContentProvider

Composite implementation (see composite design pattern) of ILcdBalloonContentProvider. It keeps a list of associated ILcdBalloonContentProviders: one can add and remove other ILcdBalloonContentProviders to this ILcdBalloonContentProvider. When a HyperlinkEvent is fired, it loops over its associated ILcdBalloonContentProviders and notifies all of them. It is up to the registered ILcdBalloonContentProviders to determine whether or not the fired HyperlinkEvent is relevant.

When creating a new TLcyCompositeBalloonContentProvider using the default constructor (see TLcyCompositeBalloonContentProvider()), the created instance will only work on/with the ILcdBalloonContentProviders registered on this composite instance (see addBalloonContentProvider(com.luciad.view.swing.ILcdBalloonContentProvider) and removeBalloonContentProvider(ILcdBalloonContentProvider)).

When creating a new TLcyCompositeBalloonContentProvider using the constructor specifying an ILcyLucyEnv instance (see TLcyCompositeBalloonContentProvider(com.luciad.lucy.ILcyLucyEnv), the created instance will work on the Lucy back-end services. It will use all registered ILcdBalloonContentProvider instances of the Lucy back-end, adding and/or removing an ILcdBalloonContentProvider will add/remove the ILcdBalloonContentProvider as service from Lucy, ... .

Field Summary

Fields inherited from class com.luciad.lucy.util.TLcyGenericComposite

PRIORITY_DEFAULT, PRIORITY_FALLBACK

Constructor Summary

Constructors

Constructor and Description
TLcyCompositeBalloonContentProvider() Default constructor.
TLcyCompositeBalloonContentProvider(ILcyLucyEnv aLucyEnv) Construct a TLcyCompositeBalloonContentProvider working on the Lucy back-end

Method Summary

Modifier and Type	Method and Description
void	addBalloonContentProvider(ILcdBalloonContentProvider aBalloonContentProvider) Adds the given ILcdBalloonContentProvider to this composite balloon content provider.
boolean	canGetContent(ALcdBalloonDescriptor aBalloonDescriptor) Checks if it is possible to return a JComponent that should be used as the content.
ILcdBalloonContentProvider	getBalloonContentProvider(int aIndex) Returns the ILcdBalloonContentProvider at the given index.
int	getBalloonContentProviderCount() Returns the number of currently registered balloon content providers.
JComponent	getContent(ALcdBalloonDescriptor aBalloonDescriptor) Returns the balloon contents of an object.
void	removeBalloonContentProvider(ILcdBalloonContentProvider aBalloonContentProvider) Removes the given ILcdBalloonContentProvider from this composite layer factory.

Methods inherited from class com.luciad.lucy.util.TLcyGenericComposite

add, add, getList, getPriority, iterator, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TLcyCompositeBalloonContentProvider

public TLcyCompositeBalloonContentProvider()

Default constructor. No ILcdBalloonContentProviders are associated.

The created instance will only work on the ILcdBalloonContentProvider instances registered to it. If you want to use all registered ILcdBalloonContentProvider instances of the Lucy back-end, use TLcyCompositeBalloonContentProvider(com.luciad.lucy.ILcyLucyEnv) instead.

See Also:

TLcyCompositeBalloonContentProvider(com.luciad.lucy.ILcyLucyEnv)

TLcyCompositeBalloonContentProvider

public TLcyCompositeBalloonContentProvider(ILcyLucyEnv aLucyEnv)

Construct a TLcyCompositeBalloonContentProvider working on the Lucy back-end

It will use all ILcdBalloonContentProvider instances registered to the back-end, and adding and/or removing ILcdBalloonContentProviders to/from this ILcdBalloonContentProvider will respectively add/remove it as service from the back-end.

If you want to create a TLcyCompositeBalloonContentProvider which does not use the back-end, use TLcyCompositeBalloonContentProvider() instead.

Parameters:

aLucyEnv - The Lucy back-end.

See Also:

TLcyCompositeBalloonContentProvider(), ILcyLucyEnv.addService(Object, int), ILcyLucyEnv.removeService(Object)

Method Detail

canGetContent

public boolean canGetContent(ALcdBalloonDescriptor aBalloonDescriptor)

Description copied from interface: ILcdBalloonContentProvider

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

Specified by:

canGetContent in interface ILcdBalloonContentProvider

Parameters:

aBalloonDescriptor - An object describing a balloon.

Returns:

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

getContent

public JComponent getContent(ALcdBalloonDescriptor aBalloonDescriptor)

Description copied from interface: ILcdBalloonContentProvider

Returns the balloon contents of an object. It is allowed to call this method without first calling ILcdBalloonContentProvider.canGetContent(ALcdBalloonDescriptor). Both implementations should be consistent though, i.e. when ILcdBalloonContentProvider.canGetContent(ALcdBalloonDescriptor) returns false, this method should return null and vice versa.

Specified by:

getContent in interface ILcdBalloonContentProvider

Parameters:

aBalloonDescriptor - An object describing a balloon.

Returns:

a JComponent that should be used as the content of a balloon, or null when this provider cannot provide contents for the given ALcdBalloonDescriptor.

addBalloonContentProvider

public void addBalloonContentProvider(ILcdBalloonContentProvider aBalloonContentProvider)

Adds the given ILcdBalloonContentProvider to this composite balloon content provider. The ILcdBalloonContentProvider should only create balloon contents for objects it knows about.

If the constructor specifying an ILcyLucyEnv is used, the ILcdBalloonContentProvider will be registered as a service on the Lucy back-end (see ILcyLucyEnv.addService(Object, int)). When calling ILcyLucyEnv.getServices(Class) afterwards, aBalloonContentProvider will only be included in the returned list when the requested class was ILcdBalloonContentProvider.class.
Note: if you want to remove the registered ILcdBalloonContentProvider afterwards, use removeBalloonContentProvider(com.luciad.view.swing.ILcdBalloonContentProvider) and not ILcyLucyEnv.removeService(Object).

Parameters:

aBalloonContentProvider - the balloon content provider

See Also:

removeBalloonContentProvider(ILcdBalloonContentProvider)

removeBalloonContentProvider

public void removeBalloonContentProvider(ILcdBalloonContentProvider aBalloonContentProvider)

Removes the given ILcdBalloonContentProvider from this composite layer factory. If the given ILcdBalloonContentProvider was never added before, nothing happens.

If the constructor specifying an ILcyLucyEnv is used, the ILcdBalloonContentProvider will be removed as service from the Lucy back-end (see ILcyLucyEnv.removeService(Object)).
Note: it is only possible to remove ILcdBalloonContentProvider instances which were registered using the addBalloonContentProvider(com.luciad.view.swing.ILcdBalloonContentProvider) method.

Parameters:

aBalloonContentProvider - A ILcdBalloonContentProvider to remove.

See Also:

(ILcdBalloonContentProvider)

getBalloonContentProviderCount

public int getBalloonContentProviderCount()

Returns the number of currently registered balloon content providers.

Returns:

The number of associated ILcdBalloonContentProviders.

getBalloonContentProvider

public ILcdBalloonContentProvider getBalloonContentProvider(int aIndex)

Returns the ILcdBalloonContentProvider at the given index.

Parameters:

aIndex - the index of the ILcdBalloonContentProvider to return.

Returns:

The associated ILcdBalloonContentProvider at the given index.