com.luciad.lucy.gui

LuciadLightspeedInterface ILcyObjectCustomizerFactory

All Known Implementing Classes:

TLcyPrintAreaCustomizerFactory

Deprecated.

A more powerful ILcyCustomizerPanel 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 the ILcyCustomizerPanel mechanism for new code. Please refer to the Lucy developer's guide or TLcyUserInterfaceManager.getCompositeCustomizerPanelFactory() for more information on the new mechanism.

@Deprecated
public interface ILcyObjectCustomizerFactory

Interface for object customizer factories. An object customizer is a Customizer that is able to customize certain types of model objects.

Method Summary

Modifier and Type	Method and Description
boolean	canCreateObjectCustomizer(Object aObject, ILcdModel aModel, ILcdGXYView aGXYView) Deprecated. Returns true if createObjectCustomizer will return a customizer that can handle the given object, false otherwise.
Customizer	createObjectCustomizer(Object aObject, ILcdModel aModel, ILcdGXYView aGXYView) Deprecated. Returns a Customizer for the given object.
String	createObjectCustomizerDisplayName(Object aObject, ILcdModel aModel, ILcdGXYView aGXYView) Deprecated. Returns a display name for the customizer that will be created by createObjectCustomizer( aObject, aModel, aView )

Method Detail

createObjectCustomizerDisplayName

String createObjectCustomizerDisplayName(Object aObject,
                                         ILcdModel aModel,
                                         ILcdGXYView aGXYView)

Deprecated.

Returns a display name for the customizer that will be created by createObjectCustomizer( aObject, aModel, aView )

Returns:

The display name.

See Also:

createObjectCustomizer(java.lang.Object, com.luciad.model.ILcdModel, com.luciad.view.gxy.ILcdGXYView)

canCreateObjectCustomizer

boolean canCreateObjectCustomizer(Object aObject,
                                  ILcdModel aModel,
                                  ILcdGXYView aGXYView)

Deprecated.

Returns true if createObjectCustomizer will return a customizer that can handle the given object, false otherwise.

Parameters:

aObject - The object to test if a customizer can be created for it.

aModel - The model that contains aObject. This parameter can be null if no model is available.

aGXYView - The view the given object is in. This parameter can be null is no such view is available.

Returns:

True if createObjectCustomizer will return a customizer that can handle the given object, false otherwise.

See Also:

createObjectCustomizer(java.lang.Object, com.luciad.model.ILcdModel, com.luciad.view.gxy.ILcdGXYView)

createObjectCustomizer

Customizer createObjectCustomizer(Object aObject,
                                  ILcdModel aModel,
                                  ILcdGXYView aGXYView)

Deprecated.

Returns a Customizer for the given object. The Customizer should accept the given object, so it should not throw an exception when setObject( aObject ) is invoked on the created Customizer. Furthermore, the created Customizer must throw an IllegalArgumentException when an attempt is made to set any type of object to the Customizer that it cannot handle. All this is to be able to reuse the same Customizer instance (performance!) for customizing several objects, one after another. This typically means there is a strong relation between canCreateObjectCustomizer(Object, com.luciad.model.ILcdModel, com.luciad.view.gxy.ILcdGXYView) and customizer.setObject: at least when the canCreateObjectCustomizer method returns false, an IllegalArgumentException should be thrown by setObject for the same object.

setObject(null) can be used on the created Customizer to (temporarily) de-initialize it.

Note: the implementation of this method must not call setObject on the newly created Customizer as this is the responsibility of the user of the created Customizer.

Parameters:

aObject - The object to create a customizer for.

aModel - The model that contains aObject. This parameter can be null if no model is available.

aGXYView - The view the given object is in. This parameter can be null if no such view is available.

Returns:

The Customizer that can handle the given object.

Throws:

IllegalArgumentException - if and only if canCreateObjectCustomizer( aObject, aModel, aView ) returns false.

See Also:

canCreateObjectCustomizer(java.lang.Object, com.luciad.model.ILcdModel, com.luciad.view.gxy.ILcdGXYView)