Package com.luciad.lucy.map.asynchronous

Class TLcyGXYAsynchronousLayerCustomizerPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.luciad.lucy.map.asynchronous.TLcyGXYAsynchronousLayerCustomizerPanel

All Implemented Interfaces:

ILcdUndoableSource, ILcyCustomizerPanel, ILcdPropertyChangeSource, ImageObserver, MenuContainer, Serializable, Accessible

public class TLcyGXYAsynchronousLayerCustomizerPanel
extends JPanel
implements ILcyCustomizerPanel

Panel wrapper for customizer panels that directly or indirectly influence asynchronously painted layers. It allows to easily convert a customizer panel into a customizer panel that supports asynchronous painting.

For LayerContexts, the calls are delegated using a safe layer context, as determined by ALcyAsynchronousPaintFacade.invokeNowOnGXYLayer(com.luciad.view.gxy.ILcdGXYLayer, com.luciad.view.gxy.asynchronous.ILcdGXYAsynchronousLayerRunnable) for canSetObject(java.lang.Object) and ALcyAsynchronousPaintFacade.invokeNowOnGXYLayer(com.luciad.view.gxy.ILcdGXYLayer, com.luciad.view.gxy.asynchronous.ILcdGXYAsynchronousLayerRunnable) for applyChanges() and setObject(java.lang.Object). For ModelContexts, DomainObjectContexts and ModelEncoderContexts, the calls are delegated with read-write model locks.

Any produced layer-related and model-related undoables are also safe to use.

Please note that once setObject(java.lang.Object) has exited, it is _not_ safe to use the layer until applyChanges() is called: asynchronous painting is allowed to continue while the customizer panel is visible.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.luciad.lucy.gui.customizer.ILcyCustomizerPanel

HINT_PINNED, HORIZONTAL_ALIGNMENT_HINT, LONG_DESCRIPTION, NAME, SHORT_DESCRIPTION, SMALL_ICON

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
TLcyGXYAsynchronousLayerCustomizerPanel(ILcyLucyEnv aLucyEnv, ILcyCustomizerPanel aPanel)	Creates a new wrapper panel.

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener aListener)	Registers the given PropertyChangeListener to be notified when this object's properties change.
void	addPropertyChangeListener(String aPropertyName, PropertyChangeListener aListener)	Adds the given listener for the specific property with name aPropertyName.
void	addUndoableListener(ILcdUndoableListener aUndoableListener)	Adds a listener to this source, so this listener is notified when something undoable has happened.
boolean	applyChanges()	Updates the set Object according to the current state of the user interface.
void	cancelChanges()	Updates the user interface state according to the current state of the set Object.
boolean	canSetObject(Object aObject)	Returns true if and only if setObject would not throw an IllegalArgumentException.
Object	getObject()	Returns the object that was set using setObject.
Dimension	getPreferredSize()
PropertyChangeListener[]	getPropertyChangeListeners()	Returns an array of all the PropertyChangeListeners registered on this ILcyCustomizerPanel.
PropertyChangeListener[]	getPropertyChangeListeners(String aPropertyName)	Returns an array of all the PropertyChangeListeners registered for aPropertyName.
Object	getValue(String aKey)	Gets the property value for the given key.
ILcyCustomizerPanel	getWrappedPanel()
boolean	isChangesPending()	Returns true if changes are pending.
boolean	isChangesValid()	Returns true if the pending changes are valid, or if there are no pending changes.
void	putValue(String aKey, Object aValue)	Sets the property value for aKey to aValue.
void	removePropertyChangeListener(PropertyChangeListener aListener)	De-registers the given PropertyChangeListener from receiving property change events for this object.
void	removePropertyChangeListener(String aPropertyName, PropertyChangeListener aListener)	Removes the given PropertyChangeListener for the specific property aPropertyName.
void	removeUndoableListener(ILcdUndoableListener aUndoableListener)	Removes the specified listener so it is no longer notified.
void	setObject(Object aObject)	Set the object to be edited.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Details

TLcyGXYAsynchronousLayerCustomizerPanel

public TLcyGXYAsynchronousLayerCustomizerPanel(ILcyLucyEnv aLucyEnv,
 ILcyCustomizerPanel aPanel)

Creates a new wrapper panel. All calls are delegated. If calls to setObject, canSetObject and applyChanges apply to an ILcdGXYLayer or ILcdModel, they are either delegated using a safe layer context or surrounded with read-write locks.

Parameters:

aLucyEnv - the Lucy environment

aPanel - a panel to wrap. Must be an instance of java.awt.Component

Method Details

getWrappedPanel

public ILcyCustomizerPanel getWrappedPanel()

applyChanges

public boolean applyChanges()

Description copied from interface: ILcyCustomizerPanel

Updates the set Object according to the current state of the user interface. This means all pending changes are committed.

If there were any pending changes, so isChangesPending returned true, it should return false after this method has finished, and therefore also a "changesPending" property change event must be fired.

E.g. consider that a ILcdGXYLayer object is set and a new label text is entered in a text field. When this method is called, the new label text should be set to the ILcdGXYLayer (using ILcdGXYLayer.setLabel).

Specified by:

applyChanges in interface ILcyCustomizerPanel

Returns:

True if the changes were applied or if there were no changes, false if the changes could not be applied because they are invalid. In that event, isChangesValid returns false.

cancelChanges

public void cancelChanges()

Description copied from interface: ILcyCustomizerPanel

Updates the user interface state according to the current state of the set Object. Any changes that were made in the user interface but were not yet applied, should be discarded.

E.g. consider that an ILcdGXYLayer is being edited and a new label text was entered in a text field. When this method is called, the new label text should be cleared and the current label of the ILcdGXYLayer should be put in the text field (ILcdGXYLayer.getLabel()).

Specified by:

cancelChanges in interface ILcyCustomizerPanel

canSetObject

public boolean canSetObject(Object aObject)

Description copied from interface: ILcyCustomizerPanel

Returns true if and only if setObject would not throw an IllegalArgumentException.

Specified by:

canSetObject in interface ILcyCustomizerPanel

Parameters:

aObject - The object to check.

Returns:

true if setObject would accept the object, false if it would throw an exception.

setObject

public void setObject(Object aObject)

Description copied from interface: ILcyCustomizerPanel

Set the object to be edited. This method should be called before the ILcyCustomizerPanel has been added to any parent AWT container. It can be called afterwards as well however. In this case the user interface should update itself to represent the newly set object.

A value of null is set to inform this ILcyCustomizerPanel to (temporarily) deinitialize itself, it allows to perform cleanup tasks, such as removing listeners.

Specified by:

setObject in interface ILcyCustomizerPanel

Parameters:

aObject - The object to be customized, or null to inform that editing is temporarily disabled.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener aListener)

Description copied from interface: ILcdPropertyChangeSource

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 interface ILcdPropertyChangeSource

Overrides:

addPropertyChangeListener in class Container

Parameters:

aListener - The listener to be notified

See Also:

• ALcdWeakPropertyChangeListener
• ILcdPropertyChangeSource.removePropertyChangeListener(java.beans.PropertyChangeListener)

addPropertyChangeListener

public void addPropertyChangeListener(String aPropertyName,
 PropertyChangeListener aListener)

Description copied from interface: ILcyCustomizerPanel

Adds the given listener for the specific property with name aPropertyName.

Property change events will be fired for the Bean properties of this class, as well for changes in the key-value pairs of this class (see ILcyCustomizerPanel.putValue(String, Object)).

Specified by:

addPropertyChangeListener in interface ILcyCustomizerPanel

Overrides:

addPropertyChangeListener in class Container

Parameters:

aPropertyName - The property name for which aListener will receive events.

aListener - The listener. It only receives events for the given property name.

See Also:

• ILcyCustomizerPanel.removePropertyChangeListener(String, java.beans.PropertyChangeListener)
• ILcyCustomizerPanel.getPropertyChangeListeners(String)

getObject

public Object getObject()

Description copied from interface: ILcyCustomizerPanel

Returns the object that was set using setObject. This can be null.

Specified by:

getObject in interface ILcyCustomizerPanel

Returns:

the object that was set using setObject.

See Also:

• ILcyCustomizerPanel.setObject(Object)

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()

Description copied from interface: ILcyCustomizerPanel

Returns an array of all the PropertyChangeListeners registered on this ILcyCustomizerPanel.

Specified by:

getPropertyChangeListeners in interface ILcyCustomizerPanel

Overrides:

getPropertyChangeListeners in class Component

Returns:

an array of all the PropertyChangeListeners registered on this ILcyCustomizerPanel, or an empty array if no PropertyChangeListeners are currently registered.

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners(String aPropertyName)

Description copied from interface: ILcyCustomizerPanel

Returns an array of all the PropertyChangeListeners registered for aPropertyName.

Specified by:

getPropertyChangeListeners in interface ILcyCustomizerPanel

Overrides:

getPropertyChangeListeners in class Component

Parameters:

aPropertyName - The property name to retrieve the listeners for.

Returns:

an array of all the PropertyChangeListeners registered for aPropertyName, or an empty array if no listeners are registered for that property.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener aListener)

Description copied from interface: ILcdPropertyChangeSource

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 interface ILcdPropertyChangeSource

Overrides:

removePropertyChangeListener in class Component

Parameters:

aListener - the listener that should no longer be notified of changes of this object's properties

See Also:

• ILcdPropertyChangeSource.addPropertyChangeListener(java.beans.PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(String aPropertyName,
 PropertyChangeListener aListener)

Description copied from interface: ILcyCustomizerPanel

Removes the given PropertyChangeListener for the specific property aPropertyName. This method should be used to remove PropertyChangeListeners that were registered for a specific property name.

Specified by:

removePropertyChangeListener in interface ILcyCustomizerPanel

Overrides:

removePropertyChangeListener in class Component

Parameters:

aPropertyName - The property name.

aListener - The listener.

See Also:

• ILcyCustomizerPanel.addPropertyChangeListener(String, java.beans.PropertyChangeListener)

addUndoableListener

public void addUndoableListener(ILcdUndoableListener aUndoableListener)

Description copied from interface: ILcdUndoableSource

Adds a listener to this source, so this listener is notified when something undoable has happened.

Specified by:

addUndoableListener in interface ILcdUndoableSource

Parameters:

aUndoableListener - The listener to be notified when something undoable has happened.

removeUndoableListener

public void removeUndoableListener(ILcdUndoableListener aUndoableListener)

Description copied from interface: ILcdUndoableSource

Removes the specified listener so it is no longer notified.

Specified by:

removeUndoableListener in interface ILcdUndoableSource

Parameters:

aUndoableListener - The listener to remove.

getValue

public Object getValue(String aKey)

Description copied from interface: ILcyCustomizerPanel

Gets the property value for the given key.

Specified by:

getValue in interface ILcyCustomizerPanel

Parameters:

aKey - The key to retrieve the value for.

Returns:

the property value for the given key.

See Also:

• ILcyCustomizerPanel.putValue(java.lang.String, java.lang.Object)

isChangesPending

public boolean isChangesPending()

Description copied from interface: ILcyCustomizerPanel

Returns true if changes are pending. A change is a modification made by the user, e.g., the modified content of a text field. Pending means the method applyChanges was not invoked after the change occurred.

A property change event "changesPending" must be fired if the return value of this method is changed. This can for example be used to enable/disable an apply button.

Specified by:

isChangesPending in interface ILcyCustomizerPanel

Returns:

true if there are pending changes, false otherwise.

isChangesValid

public boolean isChangesValid()

Description copied from interface: ILcyCustomizerPanel

Returns true if the pending changes are valid, or if there are no pending changes. Returns false if there are invalid pending changes. A change is a modification made by the user, e.g., the modified content of a text field. Pending means the method applyChanges was not invoked after the change occurred.

False could for example be returned if the user has entered invalid input that cannot be applied, such as text where a number is expected.

A property change event "changesValid" must be fired if the return value of this method is changed. This can for example be used to enable/disable an apply button, or to inform the user that he must first correct the invalid content.

Implementations can ignore this feature by always returning true.

Specified by:

isChangesValid in interface ILcyCustomizerPanel

Returns:

true if the changes can be applied, false otherwise.

putValue

public void putValue(String aKey,
 Object aValue)

Description copied from interface: ILcyCustomizerPanel

Sets the property value for aKey to aValue. If the value has changed, a PropertyChangeEvent is sent to the listeners. The property name of the event equals the value of aKey.

Specified by:

putValue in interface ILcyCustomizerPanel

Parameters:

aKey - The key. Should preferably start with an uppercase letter to avoid confusion with regular properties.

aValue - The value.

See Also:

• ILcyCustomizerPanel.getValue(java.lang.String)
• ILcyCustomizerPanel.NAME
• ILcyCustomizerPanel.SMALL_ICON
• ILcyCustomizerPanel.SHORT_DESCRIPTION
• ILcyCustomizerPanel.LONG_DESCRIPTION
• ILcyCustomizerPanel.HINT_PINNED

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class JComponent