Interface ILcyLucyEnv
- All Superinterfaces:
EventListener
,ILcdPropertyChangeSource
,ILcdStatusListener
,ILcdStatusSource
,ILcyModelDecoderContainer
,ILcyModelEncoderContainer
This is the central backend of Lucy where all add-ons are registered, to which add-ons can add functionality and from which already added functionality can be retrieved. The following figure shows where the back-end is situated in relation to the other parts of Lucy.
This interface is the back-end core of Lucy. It is the basic point where add-ons of Lucy and Lucy itself can:
- register certain extensions, like an add-on providing its own layer factory, or an additional object customizer factory, ... . For this the service mechanism is used (see below).
- retrieve all types of information, like the
ILcyMapManager
, the default user directory, the default format for coordinates, ...
The functionality of this back-end is split up in several managers:
Data format manager
: contains all methods related to the decoding and visualization of data formats.User interface manager
: contains all methods to display user interface components to Lucy.Map manager
: keeps track of all 2D maps that are displayed in the Lucy application.Data transfer manager
: contains all functionality to transfer domain objects from one layer to another.Workspace manager
: contains all functionality to store and restore the session of the Lucy application.Undo manager
: tracks undoable operations.Preferences manager
: central location for user preferences.Help manager
: enables context sensitive help.
ILcyLucyEnv
are shortcuts for
methods found in one of these managers, with the exception of:
- Methods for setting and retrieving the screen resolution.
- Methods for user units and formats.
- Methods for setting and retrieving the state of the Lucy application.
- Methods for time-dependent models.
- Methods for the status listener mechanism.
Services mechanism
The Lucy back-end provides a mechanism to share objects between different parts of Lucy without creating a hard
dependency between those parts.
This mechanism is called the services mechanism.
You can see it as a giant bag: objects can be put in the bag with addService(Object)
, and removed from
the bag with removeService(Object)
.
It is also possible to request from the bag all objects that extend or implement a certain class or interface.
See getServices(Class)
and getService(Class)
for more information.
An overview of what classes and interfaces the default Lucy add-ons register in the services registry can be found in the extended service documentation. The Lucy developer guide contains some examples on how to use this mechanism.
Status events
This interface extends ILcdStatusListener
and at
the same time is a producer of status events (because of methods
addStatusListener and removeStatusListener). The idea is that an
ILcyLucyEnv
can be used as a listener to time consuming tasks
that produce TLcdStatusEvent
s. GUI widgets that want to take
care of status events (typically a status bar or a popup window displaying a
progress bar) can than register themselves to ILcyLucyEnv
. To
achieve this, implementations have to redispatch all events they receive to
all associated listeners. And add-ons that perform time consuming tasks (like
decoding a large file) should register the ILcyLucyEnv
as a
ILcdStatusListener
to the time consuming thing (the decoder).
It is also possible to fire a TLcdStatusEvent
with ID
'TLcdStatusEvent.MESSAGE', to simply display that message in the status
bar (without being related to progress).
This interface is subject to change, use the available factories
(TLcyLucyEnvFactory
and
TLcyTabbedPaneLucyEnvFactory
) to create instances that
implement this interface and do not use delegation.
Please refer to the package comment
for a description of the relation
between this back-end and the other parts of the Lucy framework.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Constant defining the normal priority.static final int
Constant defining the fallback priority.static final int
Indicates that theILcyLucyEnv
has finished the closing operation.static final int
Indicates that theILcyLucyEnv
is going to close.static final int
Indicates that theILcyLucyEnv
is disposed.static final int
Indicates that theILcyLucyEnv
is disposing.static final int
Indicates that theILcyLucyEnv
has finished initializing.static final int
Indicates that theILcyLucyEnv
is initializing.static final int
Indicates that the state of thisILcyLucyEnv
is undefined. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAddOnContainerListener
(ILcyAddOnContainerListener aAddOnContainerListener) Adds the given addon container listener to this lucy environment.void
addCustomizerFactory
(ILcyCustomizerFactory aCustomizerFactory) Deprecated.void
Deprecated.Usenew TLcyCompositeCustomizerPanelFactory(aLucyEnv).addCustomizerPanelFactory(aFactory)
instead.void
addGXYLayerDecoder
(ILcdGXYLayerDecoder aGXYLayerDecoder, ALcyFileTypeDescriptor aFileTypeDescriptor) Deprecated.Usenew TLcyCompositeGXYLayerDecoder(aLucyEnv).addGXYLayerDecoder(aGXYLayerDecoder, aFileTypeDescriptor)
instead.void
addGXYLayerEncoder
(ILcdGXYLayerEncoder aGXYLayerEncoder, ALcyFileTypeDescriptor aFileTypeDescriptor) Deprecated.Usenew TLcyCompositeGXYLayerEncoder(aLucyEnv).addGXYLayerEncoder(aGXYLayerEncoder, aFileTypeDescriptor)
instead.void
addGXYLayerFactory
(ILcdGXYLayerFactory aGXYLayerFactory) Deprecated.Usenew TLcyCompositeGXYLayerFactory(aLucyEnv).addGXYLayerFactory(aGXYLayerFactory)
instead.void
addGXYLayerTypeProvider
(ILcyGXYLayerTypeProvider aGXYLayerTypeProvider) Deprecated.Usenew TLcyCompositeGXYLayerTypeProvider(aLucyEnv).addGXYLayerTypeProvider(aGXYLayerTypeProvider)
instead.void
addLucyEnvListener
(ILcyLucyEnvListener aLucyEnvListener) Adds the given lucy env listener to this lucy environment.void
addModelContentTypeProvider
(ILcyModelContentTypeProvider aModelContentTypeProvider) Deprecated.Usenew TLcyCompositeModelContentTypeProvider(aLucyEnv).addModelContentTypeProvider(aModelContentTypeProvider)
instead.void
addModelCustomizerFactory
(ILcyModelCustomizerFactory aModelCustomizerFactory) Deprecated.A more powerfulILcyCustomizerPanel
framework has been introduced aside of this functionality.void
addModelDecoder
(ILcdModelDecoder aModelDecoder, ALcyFileTypeDescriptor aFileTypeDescriptor) Deprecated.Usenew TLcyCompositeModelDecoder(aLucyEnv).addModelDecoder(aModelDecoder, aFileTypeDescriptor)
instead.void
addModelEncoder
(ILcdModelEncoder aModelEncoder, ALcyFileTypeDescriptor aFileTypeDescriptor) Deprecated.Usenew TLcyCompositeModelEncoder(aLucyEnv).addModelEncoder(aModelEncoder, aFileTypeDescriptor)
instead.void
addModelReferenceDecoder
(ILcdModelReferenceDecoder aModelReferenceDecoder) Deprecated.Usenew TLcyCompositeModelReferenceDecoder(aLucyEnv).addModelReferenceDecoder(aModelReferenceDecoder)
instead.void
addObjectCustomizerFactory
(ILcyObjectCustomizerFactory aObjectCustomizerFactory) Deprecated.A more powerfulILcyCustomizerPanel
framework has been introduced aside of this functionality.void
addPropertyChangeListener
(PropertyChangeListener aListener) Registers the givenPropertyChangeListener
to be notified when this object's properties change.void
addService
(Object aService) Adds the specified object to thisILcyLucyEnv
.void
addService
(Object aService, int aPriorityOrdinal) Add the specified object to thisILcyLucyEnv
, with the given priority.void
addSimulatorModelFactory
(ILcySimulatorModelFactory aSimulatorModelFactory) Deprecated.Add theILcySimulatorModelFactory
to a (new) back-end basedTLcyCompositeSimulatorModelFactory instance
or register the factory directly to the Lucy services (seeaddService(Object)
)void
addStatusListener
(ILcdStatusListener aListener) Adds the given listener to thisILcyLucyEnv
.void
addTopLevelComponent
(Component aTopLevelComponent) Short forgetUserInterfaceManager().addTopLevelComponent()
.getAddOn
(int aIndex) Returns the addon at the given index.int
Returns the number of plugged addons.Short forgetUserInterfaceManager().getApplicationPaneFactory()
.Returns theTLcyCombinedMapManager
associated with thisILcyLucyEnv
.Deprecated.Deprecated.Usenew TLcyCompositeGXYLayerDecoder(aLucyEnv)
instead.Deprecated.Usenew TLcyCompositeGXYLayerEncoder(aLucyEnv)
instead.Deprecated.Usenew TLcyCompositeGXYLayerFactory(aLucyEnv)
instead.Deprecated.Usenew TLcyCompositeGXYLayerTypeProvider(aLucyEnv)
instead.Deprecated.Usenew TLcyCompositeModelContentTypeProvider(aLucyEnv)
instead.Deprecated.Deprecated.Usenew TLcyCompositeModelDecoder(aLucyEnv)
instead.Deprecated.Usenew TLcyCompositeModelEncoder(aLucyEnv)
instead.Deprecated.Usenew TLcyCompositeModelReferenceDecoder(aLucyEnv)
instead.Deprecated.Deprecated.use a (new) back-end basedTLcyCompositeSimulatorModelFactory instance
instead.getCustomizerFactory
(int aIndex) Deprecated.int
Deprecated.Returns theTLcyDataFormatManager
associated with thisILcyLucyEnv
.Returns theTLcyDataTransferManager
associated with thisILcyLucyEnv
.getDecoderFileTypeDescriptor
(int aIndex) Deprecated.Usenew TLcyCompositeModelDecoder(aLucyEnv).getDecoderFileTypeDescriptor(aIndex)
instead.Returns the defaultTLcdAltitudeFormat
.Returns the defaultFormat
to format and parse azimuths.Deprecated.use the propertyTLcyPreferencesManager.DATA_DIRECTORY_KEY
of thegetPreferencesManager()
instead.Returns the current defaultFormat
to format and parse date objects.Returns the defaultTLcdDistanceFormat
.Returns the current defaultFormat
to format and parse duration objects.This format needs to acceptILcdPoint
objects in its format method.Returns the defaultILcdModelReference
, or null.Deprecated.uses the methodgetDefaultDataDirectory()
to retrieve the resource directory.Returns the current defaultFormat
to format and parse scale objects.Returns the defaultTLcdSpeedFormat
.Returns the default unit to present a altitude to a user.Deprecated.uses the methodgetDefaultDataDirectory()
to retrieve the user directory.Returns the default unit to present a distance to a user.Returns the default unit to present a speed to a user.getEncoderFileTypeDescriptor
(int aIndex) Deprecated.Usenew TLcyCompositeModelEncoder(aLucyEnv).getEncoderFileTypeDescriptor(aIndex)
instead.getGXYLayerDecoder
(int aIndex) Deprecated.Usenew TLcyCompositeGXYLayerDecoder(aLucyEnv).getGXYLayerDecoder(aIndex)
instead.int
Deprecated.Usenew TLcyCompositeGXYLayerDecoder(aLucyEnv).getGXYLayerDecoderCount()
instead.getGXYLayerDecoderFileTypeDescriptor
(int aIndex) Deprecated.Usenew TLcyCompositeGXYLayerDecoder(aLucyEnv).getFileTypeDescriptor(aIndex)
instead.getGXYLayerEncoder
(int aIndex) Deprecated.Usenew TLcyCompositeGXYLayerEncoder(aLucyEnv).getGXYLayerEncoder(aIndex)
instead.int
Deprecated.Usenew TLcyCompositeGXYLayerEncoder(aLucyEnv).getGXYLayerEncoderCount()
instead.getGXYLayerEncoderFileTypeDescriptor
(int aIndex) Deprecated.Usenew TLcyCompositeGXYLayerEncoder(aLucyEnv).getFileTypeDescriptor(aIndex)
instead.getGXYLayerFactory
(int aIndex) Deprecated.Usenew TLcyCompositeGXYLayerFactory(aLucyEnv).getGXYLayerFactory(aIndex)
instead.int
Deprecated.Usenew TLcyCompositeGXYLayerFactory(aLucyEnv).getGXYLayerFactoryCount()
instead.getGXYLayerTypeProvider
(int aIndex) Deprecated.Usenew TLcyCompositeGXYLayerTypeProvider(aLucyEnv).getGXYLayerTypeProvider(aIndex)
instead.int
Deprecated.Usenew TLcyCompositeGXYLayerTypeProvider(aLucyEnv).getGXYLayerTypeProviderCount()
instead.Returns the help manager associated to this lucy environment.int
Returns the current state of theILcyLucyEnv
.Short forgetUserInterfaceManager().getMainMenuBar()
.Returns theTLcyMapManager
associated with thisILcyLucyEnv
.getModelContentTypeProvider
(int aIndex) Deprecated.Usenew TLcyCompositeModelContentTypeProvider(aLucyEnv).getModelContentTypeProvider(aIndex)
instead.int
Deprecated.Usenew TLcyCompositeModelContentTypeProvider(aLucyEnv).getModelContentTypeProviderCount()
instead.getModelCustomizerFactory
(int aIndex) Deprecated.int
Deprecated.getModelDecoder
(int aIndex) Deprecated.Usenew TLcyCompositeModelDecoder(aLucyEnv).getModelDecoder(aIndex)
instead.int
Deprecated.Usenew TLcyCompositeModelDecoder(aLucyEnv).getModelDecoderCount()
instead.getModelEncoder
(int aIndex) Deprecated.Usenew TLcyCompositeModelEncoder(aLucyEnv).getModelEncoder(aIndex)
instead.int
Deprecated.Usenew TLcyCompositeModelEncoder(aLucyEnv).getModelEncoderCount()
instead.getModelReferenceDecoder
(int aIndex) Deprecated.Usenew TLcyCompositeModelReferenceDecoder(aLucyEnv).getModelReferenceDecoder(i)
instead.int
Deprecated.Usenew TLcyCompositeModelReferenceDecoder(aLucyEnv).getModelReferenceDecoderCount()
instead.getObjectCustomizerFactory
(int aIndex) Deprecated.int
Deprecated.Returns the preferences manager.Returns all registeredPropertyChangeListener
s.int
Returns the screen pixel density in toolkit dots per inch (dpi) associated to the lucy environment.<T> T
getService
(Class<T> aServiceClass) Retrieves the object registered with thisILcyLucyEnv
that is an instance of the specified class.<T> List
<T> getServices
(Class<T> aServiceClass) Retrieves the objects registered with thisILcyLucyEnv
that are instances of the specified class.getSimulatorModelFactory
(int aIndex) Deprecated.Use a (new) back-end basedTLcyCompositeSimulatorModelFactory instance
or use the registeredILcySimulatorModelFactory
service objects (seegetServices(Class)
).int
Deprecated.Use a (new) back-end basedTLcyCompositeSimulatorModelFactory instance
or count the number of registeredILcySimulatorModelFactory
service objects (seegetServices(Class)
).getTopLevelComponent
(int aIndex) Short forgetUserInterfaceManager().getTopLevelComponent()
.int
Short forgetUserInterfaceManager().getTopLevelComponentCount()
.Get theTLcdUndoManager
associated with thisILcyLucyEnv
.Returns theTLcyUserInterfaceManager
associated with thisILcyLucyEnv
.Returns theTLcyWorkspaceManager
associated with thisILcyLucyEnv
.void
Plugs the given addon into this lucy env.void
removeAddOnContainerListener
(ILcyAddOnContainerListener aAddOnContainerListener) Removes the given addon container listener from this lucy environment.void
removeCustomizerFactory
(ILcyCustomizerFactory aCustomizerFactory) Deprecated.void
Deprecated.Usenew TLcyCompositeCustomizerPanelFactory(aLucyEnv).removeCustomizerPanelFactory(aFactory)
instead.void
removeGXYLayerDecoder
(ILcdGXYLayerDecoder aGXYLayerDecoder) Deprecated.Usenew TLcyCompositeGXYLayerDecoder(aLucyEnv).removeGXYLayerDecoder(aGXYLayerDecoder)
instead.void
removeGXYLayerEncoder
(ILcdGXYLayerEncoder aGXYLayerEncoder) Deprecated.Usenew TLcyCompositeGXYLayerEncoder(aLucyEnv).removeGXYLayerEncoder(aGXYLayerEncoder, aFileTypeDescriptor)
instead.void
removeGXYLayerFactory
(ILcdGXYLayerFactory aGXYLayerFactory) Deprecated.Usenew TLcyCompositeGXYLayerFactory(aLucyEnv).removeGXYLayerFactory(aGXYLayerFactory)
instead.void
removeGXYLayerTypeProvider
(ILcyGXYLayerTypeProvider aGXYLayerTypeProvider) Deprecated.Usenew TLcyCompositeGXYLayerTypeProvider(aLucyEnv).removeGXYLayerTypeProvider(aGXYLayerTypeProvider)
instead.void
removeLucyEnvListener
(ILcyLucyEnvListener aLucyEnvListener) Removes the given lucy env listener from this lucy environment.void
removeModelContentTypeProvider
(ILcyModelContentTypeProvider aModelContentTypeProvider) Deprecated.Usenew TLcyCompositeModelContentTypeProvider(aLucyEnv).removeModelContentTypeProvider(aModelContentTypeProvider)
instead.void
removeModelCustomizerFactory
(ILcyModelCustomizerFactory aModelCustomizerFactory) Deprecated.void
removeModelDecoder
(ILcdModelDecoder aModelDecoder) Deprecated.Usenew TLcyCompositeModelDecoder(aLucyEnv).removeModelDecoder(aModelDecoder)
instead.void
removeModelEncoder
(ILcdModelEncoder aModelEncoder) Deprecated.Usenew TLcyCompositeModelEncoder(aLucyEnv).removeModelEncoder(aModelEncoder)
instead.void
removeModelReferenceDecoder
(ILcdModelReferenceDecoder aModelReferenceDecoder) Deprecated.Usenew TLcyCompositeModelReferenceDecoder(aLucyEnv).removeModelReferenceDecoder(aModelReferenceDecoder)
instead.void
removeObjectCustomizerFactory
(ILcyObjectCustomizerFactory aObjectCustomizerFactory) Deprecated.void
De-registers the givenPropertyChangeListener
from receiving property change events for this object.void
removeService
(Object aService) Removes the specifiedObject
from thisILcyLucyEnv
.void
removeSimulatorModelFactory
(ILcySimulatorModelFactory aSimulatorModelFactory) Deprecated.Remove theILcySimulatorModelFactory
from a (new) back-end basedTLcyCompositeSimulatorModelFactory instance
or remove the factory directly from the Lucy services (seeremoveService(Object)
)void
removeStatusListener
(ILcdStatusListener aListener) Removes the givenILcdStatusListener
from thisILcyLucyEnv
void
removeTopLevelComponent
(Component aTopLevelComponent) Short forgetUserInterfaceManager().removeTopLevelComponent()
.<T extends ALcyAddOn>
TretrieveAddOnByClass
(Class<T> aAddOnClass) Retrieves the actual instance of an add-on, given the class of the add-on.retrieveAddOnByClassName
(String aAddOnClassName) Retrieves the actual instance of an add-on, given the class name of the add-on.void
setDefaultAltitudeFormat
(TLcdAltitudeFormat aDefaultAltitudeFormat) Sets the defaultTLcdAltitudeFormat
.void
setDefaultAzimuthFormat
(Format aDefaultAzimuthFormat) Sets a newFormat
to format and parse azimuths.void
setDefaultDateTimeFormat
(Format aDefaultDateTimeFormat) Sets a newFormat
to format and parse date objects.void
setDefaultDistanceFormat
(TLcdDistanceFormat aDistanceFormat) Sets the defaultTLcdDistanceFormat
.void
setDefaultDurationFormat
(Format aDefaultDurationFormat) Sets a newFormat
to format and parse duration objects.void
setDefaultLonLatPointFormat
(Format aDefaultLonLatPointFormat) Sets a newFormat
to format and parse lon lat points.void
setDefaultModelReference
(ILcdModelReference aDefaultModelReference) Sets the default model reference.void
setDefaultScaleFormat
(Format aDefaultScaleFormat) Sets a newFormat
to format and parse scale objects.void
setDefaultSpeedFormat
(TLcdSpeedFormat aSpeedFormat) Sets the defaultTLcdSpeedFormat
.void
setDefaultUserAltitudeUnit
(TLcdAltitudeUnit aDefaultUserAltitudeUnit) Sets the default unit to present a altitude to a user.void
setDefaultUserDistanceUnit
(TLcdDistanceUnit aDefaultUserDistanceUnit) Sets the default unit to present a distance to a user.void
setDefaultUserSpeedUnit
(TLcdSpeedUnit aDefaultUserSpeedUnit) Sets the default unit to present a speed to a user.void
setHelpManager
(ALcyHelpManager aHelpManager) Sets the help manager used by this lucy environment.void
setLucyEnvState
(int aLucyEnvState) Puts thisILcyLucyEnv
in the given state.void
setLucyEnvState
(int aLucyEnvState, Runnable aRevokeVetoRunnable) Puts thisILcyLucyEnv
in the given state, with the ability for a listener to revoke its veto.void
setScreenResolution
(int aScreenPixelDensity) Deprecated.This method should no longer be used.void
unplugAddOn
(ALcyAddOn aAddOn) Unplugs the given addon from this lucy env.Methods inherited from interface com.luciad.util.ILcdStatusListener
statusChanged
-
Field Details
-
STATE_INITIALIZING
static final int STATE_INITIALIZINGIndicates that theILcyLucyEnv
is initializing.- See Also:
-
STATE_INITIALIZED
static final int STATE_INITIALIZEDIndicates that theILcyLucyEnv
has finished initializing. All resources are created and the add-ons are plugged.- See Also:
-
STATE_CLOSING
static final int STATE_CLOSINGIndicates that theILcyLucyEnv
is going to close.- See Also:
-
STATE_CLOSED
static final int STATE_CLOSEDIndicates that theILcyLucyEnv
has finished the closing operation.- See Also:
-
STATE_DISPOSING
static final int STATE_DISPOSINGIndicates that theILcyLucyEnv
is disposing.- See Also:
-
STATE_DISPOSED
static final int STATE_DISPOSEDIndicates that theILcyLucyEnv
is disposed.- See Also:
-
STATE_UNDEFINED
static final int STATE_UNDEFINEDIndicates that the state of thisILcyLucyEnv
is undefined. This is the default state of a newly createdILcyLucyEnv
.- See Also:
-
PRIORITY_DEFAULT
static final int PRIORITY_DEFAULTConstant defining the normal priority. Services added with this priority constant have a higher priority than services added with the
PRIORITY_FALLBACK
constant. Its value is10000
.- See Also:
-
PRIORITY_FALLBACK
static final int PRIORITY_FALLBACKConstant defining the fallback priority. Services added with this priority constant have a lower priority than services added with the
PRIORITY_NORMAL
constant. Its value is20000
.- See Also:
-
-
Method Details
-
addPropertyChangeListener
Registers the given
PropertyChangeListener
to be notified when this object's properties change.In case you need to register a listener which keeps a reference to an object with a shorter life-time than this change source, you can use a
ALcdWeakPropertyChangeListener
instance as property change listener.- Specified by:
addPropertyChangeListener
in interfaceILcdPropertyChangeSource
- Parameters:
aListener
- The listener to be notified- See Also:
-
removePropertyChangeListener
De-registers the given
PropertyChangeListener
from receiving property change events for this object.If the listener was added more than once, it will be notified one less time after being removed. If the listener is
null
, or was never added, no exception is thrown and no action is taken.- Specified by:
removePropertyChangeListener
in interfaceILcdPropertyChangeSource
- Parameters:
aListener
- the listener that should no longer be notified of changes of this object's properties- See Also:
-
getPropertyChangeListeners
Enumeration getPropertyChangeListeners()Returns all registeredPropertyChangeListener
s.- Returns:
- all registered
PropertyChangeListener
s.
-
addAddOnContainerListener
Adds the given addon container listener to this lucy environment. Events will be fired upon plugging and unplugging addons.- Parameters:
aAddOnContainerListener
- The listener to add.- See Also:
-
removeAddOnContainerListener
Removes the given addon container listener from this lucy environment. Nothing will happen if the listener was never added or when it is already removed.- Parameters:
aAddOnContainerListener
- The listener to remove.- See Also:
-
addLucyEnvListener
Adds the given lucy env listener to this lucy environment. Events will be fired upon initializing, closing and disposing of this lucy env.- Parameters:
aLucyEnvListener
- The listener to add.- See Also:
-
removeLucyEnvListener
Removes the given lucy env listener from this lucy environment. Nothing will happen if the listener was never added or when it is already removed.- Parameters:
aLucyEnvListener
- The listener to remove.- See Also:
-
getDefaultDataDirectory
Deprecated.use the propertyTLcyPreferencesManager.DATA_DIRECTORY_KEY
of thegetPreferencesManager()
instead.Returns the default directory where data file's can be found.- Returns:
- the default directory where data file's can be found.
-
getDefaultUserDirectory
Deprecated.uses the methodgetDefaultDataDirectory()
to retrieve the user directory.Returns the default directory where the user wants to load/save files.- Returns:
- the default directory where the user wants to load/save files.
-
getDefaultResourceDirectory
Deprecated.uses the methodgetDefaultDataDirectory()
to retrieve the resource directory.Returns the default directory where resource files can be found.- Returns:
- the default directory where resource files can be found.
-
getMapManager
TLcyMapManager getMapManager()Returns the
TLcyMapManager
associated with thisILcyLucyEnv
. Use the map manager to retrieve allILcyMapComponent
s currently available in Lucy and/or to be notified about the creation of new maps or the removal of existing ones.This map manager only deals with
ILcyMapComponent
instances (GXY views), not with Lightspeed maps (ILcyLspMapComponent
). If your application only works with Lightspeed maps, you can use the following code to retrieve the Lightspeed map components:TLcyLspMapManager mapManager = aLucyEnv.getService( TLcyLspMapManager.class ); //retrieve for example the active map component ILcyGenericMapComponent<ILspView,ILspLayer> activeMap = mapManager.getActiveMapComponent(); ILspView view = activeMap.getMainView();
Note that the
TLcyLspMapManager
will only be available after theTLcyLspMapAddOn
has been plugged in. As an alternative, you can use thegetCombinedMapManager()
to find the Lightspeed map components. The benefit is that combined map manager is always available on the Lucy back-end. The drawback is that it returns generic map components, so you will have to do a cast.TLcyCombinedMapManager mapManager = aLucyEnv.getCombinedMapManager(); //retrieve for example the active map component ILcyGenericMapComponent<?,?> activeMap = mapManager.getActiveMapComponent(); //if you know your application contains only Lightspeed maps, you can safely cast //if you mix GXY and Lightspeed maps, you will need to use an instance of check since //the combined map manager can return GXY and Lightspeed maps ILspView view = (ILspView)activeMap.getMainView();
- Returns:
- the
TLcyMapManager
associated with thisILcyLucyEnv
.
-
getCombinedMapManager
TLcyCombinedMapManager getCombinedMapManager()Returns the
TLcyCombinedMapManager
associated with thisILcyLucyEnv
.Use this combined map manager as the central access point to the registered map managers of the Lucy environment: GXY based maps, Lightspeed based maps etc.
- Returns:
- the
TLcyCombinedMapManager
associated with thisILcyLucyEnv
. - See Also:
-
getWorkspaceManager
TLcyWorkspaceManager getWorkspaceManager()Returns theTLcyWorkspaceManager
associated with thisILcyLucyEnv
. Use this workspace manager to register your workspace codecs, codec delegates and object codecs and/or to be notified when workspace encoding and decoding starts.- Returns:
- The
TLcyWorkspaceManager
associated with thisILcyLucyEnv
.
-
getCompositeModelCustomizerFactory
Deprecated.Returns the model customizer factory which is the composite factory of all added model customizers.- Returns:
- the model customizer factory which is the composite factory of all added model customizers.
-
addModelCustomizerFactory
Deprecated.A more powerfulILcyCustomizerPanel
framework has been introduced aside of this functionality. Please note that all existing uses of this mechanism, both adding custom implementations and retrieving implementations added by Lucy addons, keep on working. It is however strongly recommended to use theILcyCustomizerPanel
mechanism for new code. Please refer to the Lucy developer's guide orTLcyUserInterfaceManager.getCompositeCustomizerPanelFactory()
for more information on the new mechanism.Adds a given model customizer factory. This factory will be included in the composite model customizer factory. This allows an addon to provide lucy with its own type of model customizers for its models.- Parameters:
aModelCustomizerFactory
- The model customizer factory to add.- See Also:
-
removeModelCustomizerFactory
Deprecated.Removes the given model customizer factory. The factory will also be removed from the composite factory. Has no effect if the factory was never added.- Parameters:
aModelCustomizerFactory
- The factory to remove.
-
getModelCustomizerFactoryCount
Deprecated.Returns the number of associated model customizer factories.- Returns:
- the number of associated model customizer factories.
-
getModelCustomizerFactory
Deprecated.Returns the model customizer factory at the given index.- Parameters:
aIndex
- The index of the factory to retrieve.0 <= aIndex < getModelCustomizerFactoryCount()
- Returns:
- the model customizer factory at the given index.
-
getCompositeObjectCustomizerFactory
Deprecated.Returns the object customizer factory which is the combined factory of all added object customizer factories. This composite factory can provide a certain Customizer ( a GUI ) to customize a given model object.- Returns:
- The composite object customizer factory of the lucy environment.
-
addObjectCustomizerFactory
Deprecated.A more powerfulILcyCustomizerPanel
framework has been introduced aside of this functionality. Please note that all existing uses of this mechanism, both adding custom implementations and retrieving implementations added by Lucy addons, keep on working. It is however strongly recommended to use theILcyCustomizerPanel
mechanism for new code. Please refer to the Lucy developer's guide orTLcyUserInterfaceManager.getCompositeCustomizerPanelFactory()
for more information on the new mechanism.Adds a given object customizer factory. This customizer factory will be included in the composite object customizer factory. This allows an addon to provide lucy with its own type of customizers for its model objects.- Parameters:
aObjectCustomizerFactory
- The object customizer factory to add.- See Also:
-
removeObjectCustomizerFactory
@Deprecated void removeObjectCustomizerFactory(ILcyObjectCustomizerFactory aObjectCustomizerFactory) Deprecated.Removes the given object customizer factory from the combined factory.- Parameters:
aObjectCustomizerFactory
- The factory to remove.
-
getObjectCustomizerFactoryCount
Deprecated.Returns the number of associated object customizer factories.- Returns:
- the number of associated object customizer factories.
-
getObjectCustomizerFactory
Deprecated.Returns the object customizer factory at the given index.- Parameters:
aIndex
- The index of the object customizer factory to retrieve.0 <= aIndex < getObjectCustomizerFactoryCount
- Returns:
- the object customizer factory at the given index.
-
getCompositeCustomizerFactory
Deprecated.Returns the customizer factory which is the combined factory of all added customizer factories. This composite factory can provide a certain Customizer ( a GUI ) to customize a given object.- Returns:
- The composite object customizer factory of the lucy environment.
-
addCustomizerFactory
Deprecated.A more powerfulILcyCustomizerPanel
framework has been introduced aside of this functionality. Please note that all existing uses of this mechanism, both adding custom implementations and retrieving implementations added by Lucy addons, keep on working. It is however strongly recommended to use theILcyCustomizerPanel
mechanism for new code. Please refer to the Lucy developer's guide orTLcyUserInterfaceManager.getCompositeCustomizerPanelFactory()
for more information on the new mechanism.Adds a given customizer factory. This customizer factory will be included in the composite customizer factory. This allows an addon to provide lucy with its own type of customizers for itsObject
s. This object can be anything, aILcdGXYLayer
, ...- Parameters:
aCustomizerFactory
- The object customizer factory to add.- See Also:
-
removeCustomizerFactory
Deprecated.Removes the given customizer factory from the composite factory.- Parameters:
aCustomizerFactory
- The factory to remove.
-
getCustomizerFactoryCount
Deprecated.Returns the number of associated customizer factories.- Returns:
- the number of associated customizer factories.
-
getCustomizerFactory
Deprecated.Returns the customizer factory at the given index.- Parameters:
aIndex
- The index of the customizer factory to retrieve.0 <= aIndex < getCustomizerFactoryCount
- Returns:
- the customizer factory at the given index.
-
getCompositeSimulatorModelFactory
Deprecated.use a (new) back-end basedTLcyCompositeSimulatorModelFactory instance
instead.Returns the simulator model factory which is the composite simulator model factory for all associated simulator model factories.- Returns:
- the composite simulator model factory.
- See Also:
-
addSimulatorModelFactory
Deprecated.Add theILcySimulatorModelFactory
to a (new) back-end basedTLcyCompositeSimulatorModelFactory instance
or register the factory directly to the Lucy services (seeaddService(Object)
)Adds the given simulator model factory to the associated list of simulator model factories.- Parameters:
aSimulatorModelFactory
- The simulator model factory to add.- See Also:
-
removeSimulatorModelFactory
Deprecated.Remove theILcySimulatorModelFactory
from a (new) back-end basedTLcyCompositeSimulatorModelFactory instance
or remove the factory directly from the Lucy services (seeremoveService(Object)
)Removes the given simulator model factory from the associated list of simulator model factories. Nothing happens if the given simulator model factory was never added.- Parameters:
aSimulatorModelFactory
- The simulator model factory to remove.- See Also:
-
getSimulatorModelFactoryCount
Deprecated.Use a (new) back-end basedTLcyCompositeSimulatorModelFactory instance
or count the number of registeredILcySimulatorModelFactory
service objects (seegetServices(Class)
).Returns the number of associated simulator model factories.- Returns:
- the number of associated simulator model factories.
- See Also:
-
getSimulatorModelFactory
Deprecated.Use a (new) back-end basedTLcyCompositeSimulatorModelFactory instance
or use the registeredILcySimulatorModelFactory
service objects (seegetServices(Class)
).Returns the simulator model factory at the given index.- Parameters:
aIndex
- The index to retrieve the simulator model factory for.- Returns:
- The simulator model factory at the given index.
- See Also:
-
getAddOnCount
int getAddOnCount()Returns the number of plugged addons.- Returns:
- the number of loaded addons.
- See Also:
-
getAddOn
Returns the addon at the given index.- Parameters:
aIndex
- The index to retrieve the addon for.- Returns:
- the addon at the given index.
- See Also:
-
plugAddOn
Plugs the given addon into this lucy env. The addons plugInto method will be invoked by this method. An event will be fired to all addon container listeners.- Parameters:
aAddOn
- The addon to plug
-
unplugAddOn
Unplugs the given addon from this lucy env. The addons unplugFrom method will be invoked by this method.- Parameters:
aAddOn
- The addon to unplug.
-
retrieveAddOnByClass
Retrieves the actual instance of an add-on, given the class of the add-on. It preferably returns an add-on instance that matches exactly with the given class, but it can also return a (compatible) sub-class.- Parameters:
aAddOnClass
- The class of the add-on to retrieve the instance for.- Returns:
- the actual instance of an add-on, or null if no such instance exists.
- See Also:
-
retrieveAddOnByClassName
Retrieves the actual instance of an add-on, given the class name of the add-on. It preferably returns an add-on instance that matches exactly with the given class name, but it can also return a (compatible) sub-class.- Parameters:
aAddOnClassName
- The name of the class of the add-on to retrieve the instance for. Should be the full name of the class (e.g.com.luciad.lucy.addons.map.TLcyMapAddOn
and notTLcyMapAddOn
).- Returns:
- the actual instance of an add-on, or null if no such instance exists.
- See Also:
-
addStatusListener
Adds the given listener to thisILcyLucyEnv
. From this point on the listener will receive allTLcdStatusEvent
s thisILcyLucyEnv
receives. Intended to be able to register GUI widgets to take care of theTLcdStatusEvent
s.- Specified by:
addStatusListener
in interfaceILcdStatusSource
- Parameters:
aListener
- The listener to add.- See Also:
-
removeStatusListener
Removes the givenILcdStatusListener
from thisILcyLucyEnv
- Specified by:
removeStatusListener
in interfaceILcdStatusSource
- Parameters:
aListener
- The listener to remove.- See Also:
-
getLucyEnvState
int getLucyEnvState()Returns the current state of theILcyLucyEnv
. One ofSTATE_INITIALIZING
,STATE_INITIALIZED
,STATE_CLOSING
,STATE_CLOSED
,STATE_DISPOSING
,STATE_DISPOSED
orSTATE_UNDEFINED
.- Returns:
- the current state of the
ILcyLucyEnv
.
-
setLucyEnvState
Puts thisILcyLucyEnv
in the given state. This method should be invoked from the frontend, not from an add-on. The possible states that can be set are: States must be set in the order mentioned above. For example, when the current state isSTATE_INITIALIZING
, the only valid state to set isSTATE_INITIALIZED
. When the current state isSTATE_INITIALIZED
, it can only be set toSTATE_CLOSING
, and so on. The initial state of aILcyLucyEnv
isSTATE_UNDEFINED
. After it has changed, theILcyLucyEnv
can never go back to the stateSTATE_UNDEFINED
.Vetoing changes
Changing the state fires aTLcyLucyEnvEvent
to all associatedILcyLucyEnvListener
s. Those listeners can veto the change: they can throw aTLcyVetoException
if they don't agree with the change, causing the state to be reverted to the original state. This is useful if add-ons want to prevent closing the application from e.g. a popup dialog. The mechanism is similar to Java'sPropertyVetoException
mechanism.- Parameters:
aLucyEnvState
- The new state of the lucy environment.- Throws:
TLcyVetoException
- In case a listener has vetoed the change. The state will stick to its old value in that case.
-
setLucyEnvState
Puts thisILcyLucyEnv
in the given state, with the ability for a listener to revoke its veto. Refer tosetLucyEnvState(int)
for more information.- Parameters:
aLucyEnvState
- The new state of the lucy environment.aRevokeVetoRunnable
- A runnable to revoke a veto. It typically re-triggers the action that was veto'ed in the first place. For example, if exiting the application was veto'ed, this action tries to exit once more.- Throws:
TLcyVetoException
- In case a listener has vetoed the change. The state will stick to its old value in that case.- Since:
- 2022.1
-
getDefaultAzimuthFormat
Format getDefaultAzimuthFormat()Returns the defaultFormat
to format and parse azimuths.- Returns:
- the default
Format
to format and parse azimuths. - See Also:
-
setDefaultAzimuthFormat
Sets a new
Format
to format and parse azimuths.The format needs to accept
Double
objects in its format method. The parseObject method needs to return an instance ofDouble
. AllDouble
instances passed to this method are azimuths expressed in radians, and the returnedDouble
value of the parseObject must express the azimuth in radians as well.- Parameters:
aDefaultAzimuthFormat
- The new format to format and parse an azimuth- See Also:
-
getDefaultDistanceFormat
TLcdDistanceFormat getDefaultDistanceFormat()Returns the default
TLcdDistanceFormat
. Use it to format and parse distances.ILcyLucyEnv lucy = ...; TLcdDistanceFormat format = lucy.getDefaultDistanceFormat(); double distanceInMetres = 1000; format.format( distanceInMetres );// e.g. 1000m, 1km, ... depending on the settings of the format
The above snippet assumes you have the distance available in metres. In case you have the distance only available in another unit, you first need to convert it to metres before passing it to the format.
ILcyLucyEnv lucy = ...; TLcdDistanceFormat format = lucy.getDefaultDistanceFormat(); double distanceInKilometres = 1; double distanceInMetres = TLcdDistanceUnit.KM_UNIT.convertToStandard( distanceInKilometres ); format.format( distanceInMetres );// e.g. 1000m, 1km, ... depending on the settings of the format
In case you are only interested in the user/display unit, you can either retrieve it from the format or use the getter:
ILcyLucyEnv lucy = ...; TLcdDistanceFormat format = lucy.getDefaultDistanceFormat(); TLcdDistanceUnit userUnit = format.getDisplayUnit(); //or the equivalent using the getter userUnit = lucy.getDefaultUserDistanceUnit();
Note: It is not allowed to modify the returned format. You can use the
setDefaultDistanceFormat
method to replace the format, orsetDefaultUserDistanceUnit
to adjust the unit.PropertyChangeEvent
s will be fired when either the format itself is replaced, or when the user unit is adjusted. If you have a UI which displays distances using this formatting, you must make sure your UI gets updated each time the format or the unit is changed. This can for example by adding aPropertyChangeListener
to Lucy:ILcyLucyEnv lucy = ...; lucy.addPropertyChangeListener( new PropertyChangeListener(){ @Override public void propertyChange( PropertyChangeEvent aEvent ){ String name = aEvent.getPropertyName(); if ( "defaultDistanceFormat".equals( name ) || "defaultUserDistanceUnit".equals( name ) ){ //formatting for distances has changed //react on it } } } );
- Returns:
- the default
TLcdDistanceFormat
to format and parse distances. - See Also:
-
setDefaultDistanceFormat
Sets the default
TLcdDistanceFormat
. This will modify theaDistanceFormat
to keep the user unit synchronized.The program unit of
aDistanceFormat
must be the default program unit ofTLcdDistanceFormat
, and may never be changed. The user unit can be modified through the setDefaultUserDistanceUnit method.Note: It is not allowed to modify
aDistanceFormat
afterwards. You can use this setter again with a new format, or callsetDefaultUserDistanceUnit
to adjust the unit. SeegetDefaultDistanceFormat()
for more information.- Parameters:
aDistanceFormat
- the default distance format- See Also:
-
getDefaultUserDistanceUnit
TLcdDistanceUnit getDefaultUserDistanceUnit()Returns the default unit to present a distance to a user.
See the javadoc of
getDefaultDistanceFormat()
for more information on the distance format and unit, and how to use them.- Returns:
- the default unit to present a distance to a user.
- See Also:
-
setDefaultUserDistanceUnit
Sets the default unit to present a distance to a user. This will modify the defaultDistanceFormat to keep them synchronized. If you need to format/parse distances, use the defaultDistanceFormat or create your own format and set the distance unit to it.
See the javadoc of
getDefaultDistanceFormat()
for more information on the distance format and unit, and how to use them.- Parameters:
aDefaultUserDistanceUnit
- The new default unit.- See Also:
-
getDefaultAltitudeFormat
TLcdAltitudeFormat getDefaultAltitudeFormat()Returns the default
TLcdAltitudeFormat
. Use it to format and parse altitudes.ILcyLucyEnv lucy = ...; TLcdAltitudeFormat format = lucy.getDefaultAltitudeFormat(); double altitudeInMetres = 1000; format.format( altitudeInMetres );// e.g. 1000m, 1km, ... depending on the settings of the format
The above snippet assumes you have the altitude available in metres. In case you have the altitude only available in another unit, you first need to convert it to metres before passing it to the format.
ILcyLucyEnv lucy = ...; TLcdAltitudeFormat format = lucy.getDefaultAltitudeFormat(); double altitudeInKilometres = 1; double altitudeInMetres = TLcdAltitudeUnit.KM.convertToStandard( altitudeInKilometres ); format.format( altitudeInMetres );// e.g. 1000m, 1km, ... depending on the settings of the format
In case you are only interested in the user/display unit, you can either retrieve it from the format or use the getter:
ILcyLucyEnv lucy = ...; TLcdAltitudeFormat format = lucy.getDefaultAltitudeFormat(); TLcdAltitudeUnit userUnit = format.getDisplayUnit(); //or the equivalent using the getter userUnit = lucy.getDefaultUserAltitudeUnit();
Note: It is not allowed to modify the returned format. You can use the
setDefaultAltitudeFormat
method to replace the format, orsetDefaultUserAltitudeUnit
to adjust the unit.PropertyChangeEvent
s will be fired when either the format itself is replaced, or when the user unit is adjusted. If you have a UI which displays altitudes using this formatting, you must make sure your UI gets updated each time the format or the unit is changed. This can for example by adding aPropertyChangeListener
to Lucy:ILcyLucyEnv lucy = ...; lucy.addPropertyChangeListener( new PropertyChangeListener(){ @Override public void propertyChange( PropertyChangeEvent aEvent ){ String name = aEvent.getPropertyName(); if ( "defaultAltitudeFormat".equals( name ) || "defaultUserAltitudeUnit".equals( name ) ){ //formatting for altitudes has changed //react on it } } } );
- Returns:
- the default
TLcdAltitudeFormat
to format and parse altitudes. - See Also:
-
setDefaultAltitudeFormat
Sets the default
TLcdAltitudeFormat
. This will modify theaDefaultAltitudeFormat
to keep the user unit synchronized.The program unit of
aDefaultAltitudeFormat
must be the default program unit ofTLcdAltitudeFormat
, and may never be changed. The user unit can be modified through the setDefaultUserAltitudeUnit method.Note: It is not allowed to modify
aDefaultAltitudeFormat
afterwards. You can use this setter again with a new format, or callsetDefaultUserAltitudeUnit
to adjust the unit. SeegetDefaultAltitudeFormat()
for more information.- Parameters:
aDefaultAltitudeFormat
- the default altitude format- See Also:
-
getDefaultUserAltitudeUnit
TLcdAltitudeUnit getDefaultUserAltitudeUnit()Returns the default unit to present a altitude to a user.
See the javadoc of
getDefaultAltitudeFormat()
for more information on the altitude format and unit, and how to use them.- Returns:
- the default unit to present a altitude to a user.
- See Also:
-
setDefaultUserAltitudeUnit
Sets the default unit to present a altitude to a user. This will modify the defaultAltitudeFormat to keep them synchronized. If you need to format/parse altitudes, use the defaultAltitudeFormat or create your own format and set the altitude unit to it.
See the javadoc of
getDefaultAltitudeFormat()
for more information on the altitude format and unit, and how to use them.- Parameters:
aDefaultUserAltitudeUnit
- The new default unit.- See Also:
-
getDefaultSpeedFormat
TLcdSpeedFormat getDefaultSpeedFormat()Returns the default
TLcdSpeedFormat
. Use it to format and parse speeds.ILcyLucyEnv lucy = ...; TLcdSpeedFormat format = lucy.getDefaultSpeedFormat(); double speedInMetresPerSecond = 1852; format.format( speedInMetresPerSecond );// e.g. 1852 m/s, 1 NM/s, ... depending on the settings of the format
The above snippet assumes you have the speed available in metres/second. In case you have the speed only available in another unit, you first need to convert it to metres/second before passing it to the format.
ILcyLucyEnv lucy = ...; TLcdSpeedFormat format = lucy.getDefaultSpeedFormat(); double speedInNauticalMilesPerSecond = 1; double speedInMetresPerSecond = TLcdSpeedUnit.NM_S.convertToStandard( speedInNauticalMilesPerSecond ); format.format( speedInMetresPerSecond );// e.g. 1852 m/s, 1 NM/s, ... depending on the settings of the format
In case you are only interested in the user/display unit, you can either retrieve it from the format or use the getter:
ILcyLucyEnv lucy = ...; TLcdSpeedFormat format = lucy.getDefaultSpeedFormat(); TLcdSpeedUnit userUnit = format.getDisplayUnit(); //or the equivalent using the getter userUnit = lucy.getDefaultUserSpeedUnit();
Note: It is not allowed to modify the returned format. You can use the
setDefaultSpeedFormat
method to replace the format, orsetDefaultUserSpeedUnit
to adjust the unit.PropertyChangeEvent
s will be fired when either the format itself is replaced, or when the user unit is adjusted. If you have a UI which displays speeds using this formatting, you must make sure your UI gets updated each time the format or the unit is changed. This can for example by adding aPropertyChangeListener
to Lucy:ILcyLucyEnv lucy = ...; lucy.addPropertyChangeListener( new PropertyChangeListener(){ @Override public void propertyChange( PropertyChangeEvent aEvent ){ String name = aEvent.getPropertyName(); if ( "defaultSpeedFormat".equals( name ) || "defaultUserSpeedUnit".equals( name ) ){ //formatting for speeds has changed //react on it } } } );
- Returns:
- the default
TLcdSpeedFormat
to format and parse speeds. - See Also:
-
setDefaultSpeedFormat
Sets the default
TLcdSpeedFormat
. This will modify theaSpeedFormat
to keep the user unit synchronized.The program unit of
aSpeedFormat
must be the default program unit ofTLcdSpeedFormat
, and may never be changed. The user unit can be modified through the setDefaultUserSpeedUnit method.Note: It is not allowed to modify
aSpeedFormat
afterwards. You can use this setter again with a new format, or callsetDefaultUserSpeedUnit
to adjust the unit. SeegetDefaultSpeedFormat()
for more information.- Parameters:
aSpeedFormat
- the default speed format- See Also:
-
getDefaultUserSpeedUnit
TLcdSpeedUnit getDefaultUserSpeedUnit()Returns the default unit to present a speed to a user.
See the javadoc of
getDefaultSpeedFormat()
for more information on the speed format and unit, and how to use them.- Returns:
- the default unit to present a speed to a user.
- See Also:
-
setDefaultUserSpeedUnit
Sets the default unit to present a speed to a user. This will modify the defaultSpeedFormat to keep them synchronized. If you need to format/parse speeds, you can use the defaultSpeedFormat or create your own format and set the speed unit to it.
See the javadoc of
getDefaultSpeedFormat()
for more information on the speed format and unit, and how to use them.- Parameters:
aDefaultUserSpeedUnit
- The new default unit.- See Also:
-
getDefaultDateTimeFormat
Format getDefaultDateTimeFormat()Returns the current default
This format needs to acceptFormat
to format and parse date objects.Date
objects in its format method. The parseObject method needs to return an instance ofjava.util.Date
.- Returns:
- the current default
Format
to format and parse date objects. - See Also:
-
setDefaultDateTimeFormat
Sets a newFormat
to format and parse date objects. This format needs to acceptDate
objects in its format method. The parseObject method needs to return an instance ofjava.util.Date
. Fires aPropertyChangeEvent
.- Parameters:
aDefaultDateTimeFormat
- The new format to format and parse a date objects.- See Also:
-
getDefaultDurationFormat
Format getDefaultDurationFormat()Returns the current defaultFormat
to format and parse duration objects. This format needs to acceptILcdISO19103Measure
objects with a unit of measure type codeTLcdISO19103MeasureTypeCodeExtension.DURATION
in its format method. The parseObject method needs to return an instance ofILcdISO19103Measure
with a unit of measure type codeTLcdISO19103MeasureTypeCodeExtension.DURATION
.- Returns:
- the current default
Format
to format and parse date objects. - See Also:
-
setDefaultDurationFormat
Sets a newFormat
to format and parse duration objects. This format needs to acceptILcdISO19103Measure
objects with a unit of measure type codeTLcdISO19103MeasureTypeCodeExtension.DURATION
in its format method. The parseObject method needs to return an instance ofILcdISO19103Measure
with a unit of measure type codeTLcdISO19103MeasureTypeCodeExtension.DURATION
. Fires aPropertyChangeEvent
.- Parameters:
aDefaultDurationFormat
- The new format to format and parse a duration objects.- See Also:
-
getDefaultScaleFormat
Format getDefaultScaleFormat()Returns the current default
Format
to format and parse scale objects.This format needs to accept
Number
objects in its format method. The parseObject method needs to return aNumber
instance.- Returns:
- the current default
Format
to format and parse scale objects. - See Also:
-
setDefaultScaleFormat
Sets a new
Format
to format and parse scale objects.This format needs to accept
Number
objects in its format method. The parseObject method needs to return aNumber
instance.Fires a
PropertyChangeEvent
.- Parameters:
aDefaultScaleFormat
- The new format to format and parse scale objects.- See Also:
-
getDefaultLonLatPointFormat
Format getDefaultLonLatPointFormat()This format needs to accept
ILcdPoint
objects in its format method. The parseObject method needs to return an instance ofILcdPoint
.It simply formats and parses the point to and from a string, it for example does not perform any coordinate conversions. So the point can be defined in any reference system (e.g. WGS 84, WGS 72, ...), it will just be formatted as is, and should be interpreted according to its reference.
- Returns:
- the current default
Format
to format and parse lon lat points. - See Also:
-
setDefaultLonLatPointFormat
Sets a new
Format
to format and parse lon lat points.This format needs to accept
ILcdPoint
objects in its format method. The parseObject method needs to return an instance ofILcdPoint
.- Parameters:
aDefaultLonLatPointFormat
- The new format to format and parse a lon lat point- See Also:
-
getDefaultModelReference
ILcdModelReference getDefaultModelReference()Returns the defaultILcdModelReference
, or null.- Returns:
- Null, or the default
ILcdModelReference
. - See Also:
-
setDefaultModelReference
Sets the default model reference. The default model reference can be used to present coordinates to a user. If a given coordinate is in another reference than the default reference, this means you will have to convert it before displaying it.If the default model reference is null, coordinates should be represented to the user in the model reference of the data itself, so no conversions will be needed in that case.
- Parameters:
aDefaultModelReference
- The model reference to set.- See Also:
-
getHelpManager
ALcyHelpManager getHelpManager()Returns the help manager associated to this lucy environment. It allows to manage context sensitive help.- Returns:
- the help manager.
-
setHelpManager
Sets the help manager used by this lucy environment. The help manager allows to manage context sensitive help.- Parameters:
aHelpManager
- The help manager to be used from this point on.
-
getPreferencesManager
TLcyPreferencesManager getPreferencesManager()Returns the preferences manager. It keeps track of application preferences. SeeTLcyPreferencesManager
for more details.- Returns:
- The preferences manager.
-
getScreenResolution
int getScreenResolution()Returns the screen pixel density in toolkit dots per inch (dpi) associated to the lucy environment.- Returns:
- Screen pixel density in toolkit dots per inch (dpi).
- See Also:
-
setScreenResolution
Deprecated.This method should no longer be used. All Lucy classes are still using the screen resolution set on the Lucy back-end (e.g. the scale combobox on a 2D map). However, this information is not passed on to non-Lucy classes. An example of such a class is aTLspSLDStyler
, which needs to determine the scale of a view for which it uses the screen resolution. As a result, mixing Lucy and non-Lucy classes will result in inconsistent behavior. It is therefore strongly recommended to avoid altering the screen resolution on the Lucy back-end, and leave it on the default value.Sets the screen pixel density used by the lucy environment, expressed as toolkit dots per inch (dpi).The screen pixel density will be used to convert a distance in screen pixels to a real distance and vice versa.
- Parameters:
aScreenPixelDensity
- The screen pixel density that will be used (in dpi).- See Also:
-
getUndoManager
TLcdUndoManager getUndoManager()Get theTLcdUndoManager
associated with thisILcyLucyEnv
. This manager managesILcdUndoable
objects.- Returns:
- The
TLcdUndoManager
associated with hisILcyLucyEnv
.
-
getDataTransferManager
TLcyDataTransferManager getDataTransferManager()Returns theTLcyDataTransferManager
associated with thisILcyLucyEnv
. This manager managesALcyLayerSelectionTransferHandler
objects.- Returns:
- The
TLcyDataTransferManager
associated with thisILcyLucyEnv
.
-
getDataFormatManager
TLcyDataFormatManager getDataFormatManager()Returns theTLcyDataFormatManager
associated with thisILcyLucyEnv
. This manager keeps a list ofILcdModelDecoder
s,ILcdModelEncoder
s, ... and allows to open data sources, such as files.- Returns:
- the
TLcyDataFormatManager
associated with thisILcyLucyEnv
.
-
getUserInterfaceManager
TLcyUserInterfaceManager getUserInterfaceManager()Returns theTLcyUserInterfaceManager
associated with thisILcyLucyEnv
. This manager keeps a list of top levelComponent
s, anILcyApplicationPaneFactory
s and a collection ofILcyCustomizerPanelFactory
s (small UI's to customize the properties of an object).- Returns:
- the
TLcyUserInterfaceManager
associated with thisILcyLucyEnv
.
-
addService
Adds the specified object to thisILcyLucyEnv
. This method is a shorthand for:add( aServiceProvider, PRIORITY_DEFAULT )
- Parameters:
aService
- TheObject
to add to thisILcyLucyEnv
. This must not benull
.- See Also:
-
addService
Add the specified object to this
ILcyLucyEnv
, with the given priority. A single instance can only have one priority at a time, so it cannot be added twice with two different priorities. Any type of object can be added to this list, and retrieved later on.See the extended service documentation for extra information.
It is strongly recommended to only use this method during the initialization phase (e.g. in the
ALcyAddOn.plugInto(ILcyLucyEnv)
method).- Parameters:
aService
- TheObject
to add to thisILcyLucyEnv
. This must not benull
.aPriorityOrdinal
- The priority of the service. Lower values mean higher priorities. Services with higher priority appear earlier in the list of results. Common values arePRIORITY_DEFAULT
andPRIORITY_FALLBACK
.- See Also:
-
removeService
Removes the specified
Object
from thisILcyLucyEnv
. The specifiedObject
will no longer be included in any queries using thegetServices
method.- Parameters:
aService
- TheObject
to remove. This must not benull
. If anObject
is specified that is not present in thisILcyLucyEnv
, nothing happens.- See Also:
-
getServices
Retrieves the objects registered with this
ILcyLucyEnv
that are instances of the specified class.See the extended service documentation for a list of out-of-the-box supported services.
- Parameters:
aServiceClass
- The class whose instances you want to retrieve. This must not benull
.- Returns:
- An unmodifiable
List
of all the objects in thisILcyLucyEnv
that are assignable from the specified class. Clients should not keep a long-term reference to this collection, as changes in thisILcyLucyEnv
will not be reflected in thisList
. The order of the elements in the list respects the priority with which they were added. The order of elements with the same priority is left unspecified. There are no duplicates in thisList
. As long as no changes are made to the services, subsequent calls of this method should return aList
with the same elements in the same order. - See Also:
-
getService
Retrieves the object registered with this
ILcyLucyEnv
that is an instance of the specified class. See the extended service documentation for a list of out-of-the-box supported services.This method should only be used when only one instance of the specified class is registered with this
ILcyLucyEnv
. When multiple objects are registered for the specified class, calling this method will throw anIllegalArgumentException
. In such case one should use thegetServices(Class)
method.- Parameters:
aServiceClass
- The class whose instance you want to retrieve. This must not benull
.- Returns:
- The object in this
ILcyLucyEnv
that is assignable from the specified class ornull
when no such object was registered. - See Also:
-
getCompositeModelEncoder
Deprecated.Usenew TLcyCompositeModelEncoder(aLucyEnv)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelEncoder(aLucyEnv)
-
getCompositeModelDecoder
Deprecated.Usenew TLcyCompositeModelDecoder(aLucyEnv)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelDecoder(aLucyEnv)
-
addModelReferenceDecoder
Deprecated.Usenew TLcyCompositeModelReferenceDecoder(aLucyEnv).addModelReferenceDecoder(aModelReferenceDecoder)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelReferenceDecoder(aLucyEnv).addModelReferenceDecoder(aModelReferenceDecoder)
-
removeModelReferenceDecoder
Deprecated.Usenew TLcyCompositeModelReferenceDecoder(aLucyEnv).removeModelReferenceDecoder(aModelReferenceDecoder)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelReferenceDecoder(aLucyEnv).removeModelReferenceDecoder(aModelReferenceDecoder)
-
getModelReferenceDecoderCount
Deprecated.Usenew TLcyCompositeModelReferenceDecoder(aLucyEnv).getModelReferenceDecoderCount()
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelReferenceDecoder(aLucyEnv).getModelReferenceDecoderCount()
-
getModelReferenceDecoder
Deprecated.Usenew TLcyCompositeModelReferenceDecoder(aLucyEnv).getModelReferenceDecoder(i)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelReferenceDecoder(aLucyEnv).getModelReferenceDecoder(i)
-
getCompositeModelReferenceDecoder
Deprecated.Usenew TLcyCompositeModelReferenceDecoder(aLucyEnv)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelReferenceDecoder(aLucyEnv)
-
getCompositeGXYLayerTypeProvider
Deprecated.Usenew TLcyCompositeGXYLayerTypeProvider(aLucyEnv)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerTypeProvider(aLucyEnv)
-
addGXYLayerTypeProvider
Deprecated.Usenew TLcyCompositeGXYLayerTypeProvider(aLucyEnv).addGXYLayerTypeProvider(aGXYLayerTypeProvider)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerTypeProvider(aLucyEnv).addGXYLayerTypeProvider(aGXYLayerTypeProvider)
-
removeGXYLayerTypeProvider
Deprecated.Usenew TLcyCompositeGXYLayerTypeProvider(aLucyEnv).removeGXYLayerTypeProvider(aGXYLayerTypeProvider)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerTypeProvider(aLucyEnv).removeGXYLayerTypeProvider(aGXYLayerTypeProvider)
-
getGXYLayerTypeProviderCount
Deprecated.Usenew TLcyCompositeGXYLayerTypeProvider(aLucyEnv).getGXYLayerTypeProviderCount()
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerTypeProvider(aLucyEnv).getGXYLayerTypeProviderCount()
-
getGXYLayerTypeProvider
Deprecated.Usenew TLcyCompositeGXYLayerTypeProvider(aLucyEnv).getGXYLayerTypeProvider(aIndex)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerTypeProvider(aLucyEnv).getGXYLayerTypeProvider(aIndex)
-
getCompositeModelContentTypeProvider
Deprecated.Usenew TLcyCompositeModelContentTypeProvider(aLucyEnv)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelContentTypeProvider(aLucyEnv)
-
addModelContentTypeProvider
@Deprecated void addModelContentTypeProvider(ILcyModelContentTypeProvider aModelContentTypeProvider) Deprecated.Usenew TLcyCompositeModelContentTypeProvider(aLucyEnv).addModelContentTypeProvider(aModelContentTypeProvider)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelContentTypeProvider(aLucyEnv).addModelContentTypeProvider(aModelContentTypeProvider)
-
removeModelContentTypeProvider
@Deprecated void removeModelContentTypeProvider(ILcyModelContentTypeProvider aModelContentTypeProvider) Deprecated.Usenew TLcyCompositeModelContentTypeProvider(aLucyEnv).removeModelContentTypeProvider(aModelContentTypeProvider)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelContentTypeProvider(aLucyEnv).removeModelContentTypeProvider(aModelContentTypeProvider)
-
getModelContentTypeProviderCount
Deprecated.Usenew TLcyCompositeModelContentTypeProvider(aLucyEnv).getModelContentTypeProviderCount()
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelContentTypeProvider(aLucyEnv).getModelContentTypeProviderCount()
-
getModelContentTypeProvider
Deprecated.Usenew TLcyCompositeModelContentTypeProvider(aLucyEnv).getModelContentTypeProvider(aIndex)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelContentTypeProvider(aLucyEnv).getModelContentTypeProvider(aIndex)
-
getCompositeGXYLayerFactory
Deprecated.Usenew TLcyCompositeGXYLayerFactory(aLucyEnv)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerFactory(aLucyEnv)
-
addGXYLayerFactory
Deprecated.Usenew TLcyCompositeGXYLayerFactory(aLucyEnv).addGXYLayerFactory(aGXYLayerFactory)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerFactory(aLucyEnv).addGXYLayerFactory(aGXYLayerFactory)
-
removeGXYLayerFactory
Deprecated.Usenew TLcyCompositeGXYLayerFactory(aLucyEnv).removeGXYLayerFactory(aGXYLayerFactory)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerFactory(aLucyEnv).removeGXYLayerFactory(aGXYLayerFactory)
-
getGXYLayerFactoryCount
Deprecated.Usenew TLcyCompositeGXYLayerFactory(aLucyEnv).getGXYLayerFactoryCount()
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerFactory(aLucyEnv).getGXYLayerFactoryCount()
-
getGXYLayerFactory
Deprecated.Usenew TLcyCompositeGXYLayerFactory(aLucyEnv).getGXYLayerFactory(aIndex)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerFactory(aLucyEnv).getGXYLayerFactory(aIndex)
-
getCompositeGXYLayerEncoder
Deprecated.Usenew TLcyCompositeGXYLayerEncoder(aLucyEnv)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerEncoder(aLucyEnv)
-
addGXYLayerEncoder
@Deprecated void addGXYLayerEncoder(ILcdGXYLayerEncoder aGXYLayerEncoder, ALcyFileTypeDescriptor aFileTypeDescriptor) Deprecated.Usenew TLcyCompositeGXYLayerEncoder(aLucyEnv).addGXYLayerEncoder(aGXYLayerEncoder, aFileTypeDescriptor)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerEncoder(aLucyEnv).addGXYLayerEncoder(aGXYLayerEncoder, aFileTypeDescriptor)
-
removeGXYLayerEncoder
Deprecated.Usenew TLcyCompositeGXYLayerEncoder(aLucyEnv).removeGXYLayerEncoder(aGXYLayerEncoder, aFileTypeDescriptor)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerEncoder(aLucyEnv).removeGXYLayerEncoder(aGXYLayerEncoder, aFileTypeDescriptor)
-
getGXYLayerEncoderCount
Deprecated.Usenew TLcyCompositeGXYLayerEncoder(aLucyEnv).getGXYLayerEncoderCount()
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerEncoder(aLucyEnv).getGXYLayerEncoderCount()
-
getGXYLayerEncoder
Deprecated.Usenew TLcyCompositeGXYLayerEncoder(aLucyEnv).getGXYLayerEncoder(aIndex)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerEncoder(aLucyEnv).getGXYLayerEncoder(aIndex)
-
getGXYLayerEncoderFileTypeDescriptor
Deprecated.Usenew TLcyCompositeGXYLayerEncoder(aLucyEnv).getFileTypeDescriptor(aIndex)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerEncoder(aLucyEnv).getFileTypeDescriptor(aIndex)
-
getCompositeGXYLayerDecoder
Deprecated.Usenew TLcyCompositeGXYLayerDecoder(aLucyEnv)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerDecoder(aLucyEnv)
-
addGXYLayerDecoder
@Deprecated void addGXYLayerDecoder(ILcdGXYLayerDecoder aGXYLayerDecoder, ALcyFileTypeDescriptor aFileTypeDescriptor) Deprecated.Usenew TLcyCompositeGXYLayerDecoder(aLucyEnv).addGXYLayerDecoder(aGXYLayerDecoder, aFileTypeDescriptor)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerDecoder(aLucyEnv).addGXYLayerDecoder(aGXYLayerDecoder, aFileTypeDescriptor)
-
removeGXYLayerDecoder
Deprecated.Usenew TLcyCompositeGXYLayerDecoder(aLucyEnv).removeGXYLayerDecoder(aGXYLayerDecoder)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerDecoder(aLucyEnv).removeGXYLayerDecoder(aGXYLayerDecoder)
-
getGXYLayerDecoderCount
Deprecated.Usenew TLcyCompositeGXYLayerDecoder(aLucyEnv).getGXYLayerDecoderCount()
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerDecoder(aLucyEnv).getGXYLayerDecoderCount()
-
getGXYLayerDecoder
Deprecated.Usenew TLcyCompositeGXYLayerDecoder(aLucyEnv).getGXYLayerDecoder(aIndex)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerDecoder(aLucyEnv).getGXYLayerDecoder(aIndex)
-
getGXYLayerDecoderFileTypeDescriptor
Deprecated.Usenew TLcyCompositeGXYLayerDecoder(aLucyEnv).getFileTypeDescriptor(aIndex)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeGXYLayerDecoder(aLucyEnv).getFileTypeDescriptor(aIndex)
-
addModelDecoder
@Deprecated void addModelDecoder(ILcdModelDecoder aModelDecoder, ALcyFileTypeDescriptor aFileTypeDescriptor) Deprecated.Usenew TLcyCompositeModelDecoder(aLucyEnv).addModelDecoder(aModelDecoder, aFileTypeDescriptor)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelDecoder(aLucyEnv).addModelDecoder(aModelDecoder, aFileTypeDescriptor)
- Specified by:
addModelDecoder
in interfaceILcyModelDecoderContainer
- Parameters:
aModelDecoder
- The model decoder to addaFileTypeDescriptor
- The file type descriptor that provides more information on the file types this decoder can handle, or null if this decoder does not work with files.
-
removeModelDecoder
Deprecated.Usenew TLcyCompositeModelDecoder(aLucyEnv).removeModelDecoder(aModelDecoder)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelDecoder(aLucyEnv).removeModelDecoder(aModelDecoder)
- Specified by:
removeModelDecoder
in interfaceILcyModelDecoderContainer
- Parameters:
aModelDecoder
- The model decoder to remove.
-
getModelDecoderCount
Deprecated.Usenew TLcyCompositeModelDecoder(aLucyEnv).getModelDecoderCount()
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelDecoder(aLucyEnv).getModelDecoderCount()
- Specified by:
getModelDecoderCount
in interfaceILcyModelDecoderContainer
- Returns:
- the number of model decoders currently in this container.
-
getModelDecoder
Deprecated.Usenew TLcyCompositeModelDecoder(aLucyEnv).getModelDecoder(aIndex)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelDecoder(aLucyEnv).getModelDecoder(aIndex)
- Specified by:
getModelDecoder
in interfaceILcyModelDecoderContainer
- Parameters:
aIndex
- The index of the asked model decoder. Make sure 0 <= aIndex <ILcyModelDecoderContainer.getModelDecoderCount()
- Returns:
- The model decoder at the given index.
-
getDecoderFileTypeDescriptor
Deprecated.Usenew TLcyCompositeModelDecoder(aLucyEnv).getDecoderFileTypeDescriptor(aIndex)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelDecoder(aLucyEnv).getDecoderFileTypeDescriptor(aIndex)
- Specified by:
getDecoderFileTypeDescriptor
in interfaceILcyModelDecoderContainer
- Parameters:
aIndex
- The index to retrieve the file type descriptor for.- Returns:
- the file type descriptor at the given index.
-
addModelEncoder
@Deprecated void addModelEncoder(ILcdModelEncoder aModelEncoder, ALcyFileTypeDescriptor aFileTypeDescriptor) Deprecated.Usenew TLcyCompositeModelEncoder(aLucyEnv).addModelEncoder(aModelEncoder, aFileTypeDescriptor)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelEncoder(aLucyEnv).addModelEncoder(aModelEncoder, aFileTypeDescriptor)
- Specified by:
addModelEncoder
in interfaceILcyModelEncoderContainer
- Parameters:
aModelEncoder
- The model encoder to addaFileTypeDescriptor
- Descriptor that provides additional information about the file types this decoder can handle, or null if this encoder does not work with files.
-
removeModelEncoder
Deprecated.Usenew TLcyCompositeModelEncoder(aLucyEnv).removeModelEncoder(aModelEncoder)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelEncoder(aLucyEnv).removeModelEncoder(aModelEncoder)
- Specified by:
removeModelEncoder
in interfaceILcyModelEncoderContainer
- Parameters:
aModelEncoder
- The model encoder to remove.
-
getModelEncoderCount
Deprecated.Usenew TLcyCompositeModelEncoder(aLucyEnv).getModelEncoderCount()
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelEncoder(aLucyEnv).getModelEncoderCount()
- Specified by:
getModelEncoderCount
in interfaceILcyModelEncoderContainer
- Returns:
- the number of model encoders currently in this container.
-
getModelEncoder
Deprecated.Usenew TLcyCompositeModelEncoder(aLucyEnv).getModelEncoder(aIndex)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelEncoder(aLucyEnv).getModelEncoder(aIndex)
- Specified by:
getModelEncoder
in interfaceILcyModelEncoderContainer
- Parameters:
aIndex
- The index of the asked model encoder. Make sure0 <= aIndex < getModelEncoderCount()
- Returns:
- The model encoder at the given index.
-
getEncoderFileTypeDescriptor
Deprecated.Usenew TLcyCompositeModelEncoder(aLucyEnv).getEncoderFileTypeDescriptor(aIndex)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeModelEncoder(aLucyEnv).getEncoderFileTypeDescriptor(aIndex)
- Specified by:
getEncoderFileTypeDescriptor
in interfaceILcyModelEncoderContainer
- Parameters:
aIndex
- The index to retrieve the file type descriptor for.- Returns:
- the file type descriptor at the given index.
-
getApplicationPaneFactory
ILcyApplicationPaneFactory getApplicationPaneFactory()Short forgetUserInterfaceManager().getApplicationPaneFactory()
.- See Also:
-
getMainMenuBar
ILcyMenuBar getMainMenuBar()Short forgetUserInterfaceManager().getMainMenuBar()
.- See Also:
-
addTopLevelComponent
Short forgetUserInterfaceManager().addTopLevelComponent()
.- See Also:
-
removeTopLevelComponent
Short forgetUserInterfaceManager().removeTopLevelComponent()
.- See Also:
-
getTopLevelComponentCount
int getTopLevelComponentCount()Short forgetUserInterfaceManager().getTopLevelComponentCount()
.- See Also:
-
getTopLevelComponent
Short forgetUserInterfaceManager().getTopLevelComponent()
.- See Also:
-
addCustomizerPanelFactory
Deprecated.Usenew TLcyCompositeCustomizerPanelFactory(aLucyEnv).addCustomizerPanelFactory(aFactory)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeCustomizerPanelFactory(aLucyEnv).addCustomizerPanelFactory(aFactory)
-
removeCustomizerPanelFactory
Deprecated.Usenew TLcyCompositeCustomizerPanelFactory(aLucyEnv).removeCustomizerPanelFactory(aFactory)
instead. The Lucy API offers composite implementations of all interfaces which can be registered on the services. Those composite implementations will use those registered instances when the constructor with the Lucy back-end as parameter is used. See the javadoc ofaddService(Object, int)
and the Lucy developer guide for more information.Equivalent ofnew TLcyCompositeCustomizerPanelFactory(aLucyEnv).removeCustomizerPanelFactory(aFactory)
-
ILcyCustomizerPanel
framework has been introduced aside of this functionality.