com.luciad.lucy.gui.customizer

LuciadLightspeedClass ALcyCustomizerPanelFactory

java.lang.Object

com.luciad.lucy.gui.customizer.ALcyCustomizerPanelFactory

All Implemented Interfaces:

ILcyCustomizerPanelFactory

Direct Known Subclasses:

TLcyEditableAPP6AObjectCustomizerPanelFactory , TLcyEditableMS2525bObjectCustomizerPanelFactory

public abstract class ALcyCustomizerPanelFactory
extends Object
implements ILcyCustomizerPanelFactory

Abstract implementation of ILcyCustomizerPanelFactory that uses a ILcdFilter to decide if this factory can be used for a given object.

When using an extension of ALcyCustomizerPanel as the actual customizer, the ILcdFilter instance can thus be shared between the factory and the panel itself, enforcing a consistent behavior.

Constructor Summary

Constructors

Constructor and Description
ALcyCustomizerPanelFactory(ILcdFilter aObjectFilter) Creates a new ALcyCustomizerPanelFactory.

Method Summary

Modifier and Type	Method and Description
boolean	canCreateCustomizerPanel(Object aObject) Returns true if createObjectCustomizer will return a customizer that can handle the given object, false otherwise.
ILcyCustomizerPanel	createCustomizerPanel(Object aObject) Creates a new instance of ILcyCustomizerPanel.
protected abstract ILcyCustomizerPanel	createCustomizerPanelImpl(Object aObject) Called by createCustomizerPanel if the given object has passed the filter.
ILcdFilter	getFilter() Returns the ILcdFilter used to decide if this factory accepts a certain object or not.
void	setFilter(ILcdFilter aFilter) Sets the ILcdFilter that is used to decide if this factory accepts a certain object or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

ALcyCustomizerPanelFactory

public ALcyCustomizerPanelFactory(ILcdFilter aObjectFilter)

Creates a new ALcyCustomizerPanelFactory. The accept method of the specified filter will receive the objects passed in canCreateCustomizerPanel.

Parameters:

aObjectFilter - The filter used to decide if this factory accepts a certain object or not. This must not be null.

Method Detail

getFilter

public ILcdFilter getFilter()

Returns the ILcdFilter used to decide if this factory accepts a certain object or not.

Returns:

the ILcdFilter used to decide if this factory accepts a certain object or not. This will never be null.

See Also:

setFilter(com.luciad.util.ILcdFilter)

setFilter

public void setFilter(ILcdFilter aFilter)

Sets the ILcdFilter that is used to decide if this factory accepts a certain object or not. The accept method of the specified filter will receive the objects passed in canCreateCustomizerPanel. So canCreateCustomizerPanel has the same return value for a given object as aFilter.accept.

Parameters:

aFilter - The filter to decide if an object is accepted or not. This must not be null.

canCreateCustomizerPanel

public boolean canCreateCustomizerPanel(Object aObject)

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

Specified by:

canCreateCustomizerPanel in interface ILcyCustomizerPanelFactory

Parameters:

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

Returns:

getFilter().accept( aObject )

See Also:

ILcyCustomizerPanelFactory.createCustomizerPanel(java.lang.Object)

createCustomizerPanel

public final ILcyCustomizerPanel createCustomizerPanel(Object aObject)

Creates a new instance of ILcyCustomizerPanel. Users of this method will most likely set an object to the returned ILcyCustomizerPanel using ILcyCustomizerPanel.setObject(Object). Whether that is possible can be verified in advance using ILcyCustomizerPanelFactory.canCreateCustomizerPanel(Object).

Specified by:

createCustomizerPanel in interface ILcyCustomizerPanelFactory

Parameters:

aObject - The object to create an ILcyCustomizerPanel for.

Returns:

The result of createCustomizerPanelImpl(Object) if the object was accepted by canCreateCustomizerPanel.

Throws:

IllegalArgumentException - if canCreateCustomizerPanel returns false for aObject.

See Also:

ILcyCustomizerPanelFactory.canCreateCustomizerPanel(java.lang.Object)

createCustomizerPanelImpl

protected abstract ILcyCustomizerPanel createCustomizerPanelImpl(Object aObject)

Called by createCustomizerPanel if the given object has passed the filter. Please refer to ILcyCustomizerPanelFactory.createCustomizerPanel(Object) for more details about what this method should do.

Parameters:

aObject - The object to customize, it is guaranteed to have passed the filter.

Returns:

The created ILcyCustomizerPanel. This should never be null.