com.luciad.lucy.gui.formatbar

LuciadLightspeedClass ALcyFormatBarFactory

java.lang.Object

com.luciad.lucy.gui.formatbar.ALcyFormatBarFactory

Direct Known Subclasses:

TLcyCompositeFormatBarFactory

public abstract class ALcyFormatBarFactory
extends Object

Factory to create ALcyFormatBars.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ALcyFormatBarFactory() Default constructor.

Method Summary

Modifier and Type	Method and Description
abstract boolean	canCreateFormatBar(ILcdView aView, ILcdLayer aLayer) Returns true if a ALcyFormatBar can be created for the given parameters, false otherwise.
abstract ALcyFormatBar	createFormatBar(ILcdView aView, ILcdLayer aLayer) Creates an ALcyFormatBar for the given parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

ALcyFormatBarFactory

protected ALcyFormatBarFactory()

Default constructor.

Method Detail

canCreateFormatBar

public abstract boolean canCreateFormatBar(ILcdView aView,
                                           ILcdLayer aLayer)

Returns true if a ALcyFormatBar can be created for the given parameters, false otherwise.

Parameters:

aView - The view to create the bar for. Cannot be null.

aLayer - The layer to create this bar for. Can be null. It is null if a bar needs to be created before any layer of the format is available.

Returns:

true if a ALcyFormatBar can be created for the given parameters, false otherwise.

createFormatBar

public abstract ALcyFormatBar createFormatBar(ILcdView aView,
                                              ILcdLayer aLayer)

Creates an ALcyFormatBar for the given parameters.

This method does not need to set the given layer to the created ALcyFormatBar, that is the responsibility of the user of this method.

Parameters:

aView - The view to create the bar for. Cannot be null.

aLayer - The layer to create this bar for. Can be null. It is null if a bar needs to be created before any layer of the format is available.

Returns:

the newly created ALcyFormatBar.

Throws:

IllegalArgumentException - If canCreateDrawingBar returns false for the same parameters.