com.luciad.lucy

LuciadLightspeedClass TLcyLucyEnvFactory

java.lang.Object

com.luciad.lucy.TLcyLucyEnvFactory

public class TLcyLucyEnvFactory
extends Object

Factory class to create a ILcyLucyEnv implementation.

You will have to pass a ILcyApplicationPaneFactory implementation that will be responsible to create the application panes, the panels in which all addons make themselves visible.

You will also have to pass in a menu bar, either a ILcyMenuBar implementation or a common JMenuBar. Note that TLcyTabbedPaneLucyEnvFactory can also be used.

See Also:

TLcyTabbedPaneLucyEnvFactory

Constructor Summary

Constructors

Constructor and Description
TLcyLucyEnvFactory()

Method Summary

Modifier and Type	Method and Description
protected ALcyFileTypeDescriptor	createAllKnownFileTypeDescriptor(ILcyLucyEnv aLucyEnv) Creates the ALcyFileTypeDescriptor that represents all known files.
protected TLcyDataFormatManager.ALcyHandlerChooser	createHandlerChooser(ILcyLucyEnv aLucyEnv) Creates the TLcyDataFormatManager.ALcyHandlerChooser that is responsible to choose the correct handler for a particular data source.
static ILcyLucyEnv	createLucyEnv(ILcyApplicationPaneFactory aApplicationPaneFactory, ILcyMenuBar aMainMenuBar) Equivalent to createLucyEnv( aApplicationPaneFactory, aMainMenuBar, true ).
ILcyLucyEnv	createLucyEnv(ILcyApplicationPaneFactory aApplicationPaneFactory, ILcyMenuBar aMainMenuBar, boolean aMergeMenuBars) Creates a new lucy environment where the given ILcyApplicationPaneFactory and the given ILcyMenuBar are used.
static ILcyLucyEnv	createLucyEnv(ILcyApplicationPaneFactory aApplicationPaneFactory, JMenuBar aMainMenuBar) Equivalent to createLucyEnv( aApplicationPaneFactory, aMainMenuBar, true ).
ILcyLucyEnv	createLucyEnv(ILcyApplicationPaneFactory aApplicationPaneFactory, JMenuBar aMainMenuBar, boolean aMergeMenuBars) Equivalent to createLucyEnv( aApplicationPaneFactory, new TLcyMenuBar( aMainMenuBar ), true ).
protected TLcyDataFormatManager.ALcyMapComponentChooser	createMapComponentChooser(ILcyLucyEnv aLucyEnv) Creates the TLcyDataFormatManager.ALcyMapComponentChooser that is responsible to choose the correct map component for opening a particular data source.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcyLucyEnvFactory

public TLcyLucyEnvFactory()

Method Detail

createLucyEnv

public static ILcyLucyEnv createLucyEnv(ILcyApplicationPaneFactory aApplicationPaneFactory,
                                        JMenuBar aMainMenuBar)

Equivalent to createLucyEnv( aApplicationPaneFactory, aMainMenuBar, true ).

Returns:

Equivalent to createLucyEnv( aApplicationPaneFactory, aMainMenuBar, true ).

See Also:

createLucyEnv(ILcyApplicationPaneFactory, JMenuBar, boolean)

createLucyEnv

public ILcyLucyEnv createLucyEnv(ILcyApplicationPaneFactory aApplicationPaneFactory,
                                 JMenuBar aMainMenuBar,
                                 boolean aMergeMenuBars)

Equivalent to createLucyEnv( aApplicationPaneFactory, new TLcyMenuBar( aMainMenuBar ), true ).

Also makes sure the correct help manager is set to the created TLcyMenuBar.

Returns:

Equivalent to createLucyEnv( aApplicationPaneFactory, new TLcyMenuBar( aMainMenuBar ), true ).

See Also:

createLucyEnv(com.luciad.lucy.gui.ILcyApplicationPaneFactory, com.luciad.lucy.gui.ILcyMenuBar, boolean)

createLucyEnv

public static ILcyLucyEnv createLucyEnv(ILcyApplicationPaneFactory aApplicationPaneFactory,
                                        ILcyMenuBar aMainMenuBar)

Equivalent to createLucyEnv( aApplicationPaneFactory, aMainMenuBar, true ).

Returns:

Equivalent to createLucyEnv( aApplicationPaneFactory, aMainMenuBar, true ).

See Also:

createLucyEnv(com.luciad.lucy.gui.ILcyApplicationPaneFactory, com.luciad.lucy.gui.ILcyMenuBar, boolean)

createLucyEnv

public ILcyLucyEnv createLucyEnv(ILcyApplicationPaneFactory aApplicationPaneFactory,
                                 ILcyMenuBar aMainMenuBar,
                                 boolean aMergeMenuBars)

Creates a new lucy environment where the given ILcyApplicationPaneFactory and the given ILcyMenuBar are used.

Parameters:

aApplicationPaneFactory - The application pane factory to be used by the lucy env.

aMainMenuBar - The main menu bar of the lucy environment.

aMergeMenuBars - If true, the menu items of the menu bar of the active map component (ILcyMapComponent.getMenuBar()) are automatically added to the main menu bar. When the active map component changes (ILcyMapManager.setActiveMapComponent()), the menu items corresponding to the previous active map component will be removed and the menu items corresponding to the new active map component will be added. Default is true.

Returns:

A newly created lucy environment.

createAllKnownFileTypeDescriptor

protected ALcyFileTypeDescriptor createAllKnownFileTypeDescriptor(ILcyLucyEnv aLucyEnv)

Creates the ALcyFileTypeDescriptor that represents all known files. This is typically used in a file chooser, to only show the files that can probably be read.

This method does not add the ALcyFileTypeDescriptor to the given ILcyLucyEnv. The ILcyLucyEnv is only passed as contextual information.

Parameters:

aLucyEnv - The ILcyLucyEnv. Can be used as contextual information.

Returns:

Null, or the ALcyFileTypeDescriptor that represents all known files.

createHandlerChooser

protected TLcyDataFormatManager.ALcyHandlerChooser createHandlerChooser(ILcyLucyEnv aLucyEnv)

Creates the TLcyDataFormatManager.ALcyHandlerChooser that is responsible to choose the correct handler for a particular data source. It is used in TLcyDataFormatManager.

Parameters:

aLucyEnv - The ILcyLucyEnv. Can be used as contextual information.

Returns:

The TLcyDataFormatManager.ALcyHandlerChooser.

createMapComponentChooser

protected TLcyDataFormatManager.ALcyMapComponentChooser createMapComponentChooser(ILcyLucyEnv aLucyEnv)

Creates the TLcyDataFormatManager.ALcyMapComponentChooser that is responsible to choose the correct map component for opening a particular data source. It is used in TLcyDataFormatManager.

Parameters:

aLucyEnv - The ILcyLucyEnv. Can be used as contextual information.

Returns:

The TLcyDataFormatManager.ALcyMapComponentChooser.