Package com.luciad.lucy.gui.customizer.dataproperty

Class ALcyDataPropertyCustomizerPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.luciad.lucy.gui.customizer.ALcyCustomizerPanel

com.luciad.lucy.gui.customizer.dataproperty.ALcyDataPropertyCustomizerPanel

All Implemented Interfaces:

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

public abstract class ALcyDataPropertyCustomizerPanel
extends ALcyCustomizerPanel

Abstract base class for data property value customizer panels. If offers some convenience method and will inform implementations they should adapt their horizontal alignment when a ILcyCustomizerPanel.HORIZONTAL_ALIGNMENT_HINT is set.

Since:

2013.0

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

Modifier	Constructor	Description
protected	ALcyDataPropertyCustomizerPanel(ILcdFilter aObjectFilter, ILcyLucyEnv aLucyEnv)	Base constructor for ALcyDataPropertyCustomizerPanel.

Method Summary

Modifier and Type	Method	Description
protected abstract Component	getComponentToFocus()	When this component is offered keyboard focus, it is typically desirable that one of the children, a text field or a button for instance, gets the focus instead.
protected ILcyLucyEnv	getLucyEnv()	Returns the current Lucy environment.
protected final TLcdDataPropertyValueContext	getPropertyValue()	Returns the TLcdDataPropertyValueContext currently set on this customizer.
void	putValue(String aKey, Object aValue)	Sets the property value for aKey to aValue.
void	requestFocus()	This method is overridden to allow implementations to switch the focus to one of the child components, a text field for instance.
protected abstract void	updateHorizontalAlignment(int aHorizontalAlignment)	This method is responsible for making sure the customizer respects the requested alignment.

Methods inherited from class com.luciad.lucy.gui.customizer.ALcyCustomizerPanel

addUndoableListener, applyChanges, applyChangesImpl, cancelChanges, canSetObject, fireUndoableHappened, getObject, getObjectFilter, getValue, isChangesPending, isChangesValid, removeUndoableListener, setChangesPending, setChangesValid, setName, setObject, setObjectFilter, updateCustomizerPanelFromObject

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, getPreferredSize, 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, 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, addPropertyChangeListener, addPropertyChangeListener, 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, getPropertyChangeListeners, getPropertyChangeListeners, 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, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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

Methods inherited from interface com.luciad.util.ILcdPropertyChangeSource

addPropertyChangeListener, removePropertyChangeListener

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

addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener

Constructor Details

ALcyDataPropertyCustomizerPanel

protected ALcyDataPropertyCustomizerPanel(ILcdFilter aObjectFilter,
 ILcyLucyEnv aLucyEnv)

Base constructor for ALcyDataPropertyCustomizerPanel. Implementations of this class should only customize instances of TLcdDataPropertyValueContext.

Parameters:

aObjectFilter - the object filter that accepts object that can be customized. This filter should only accept instances of TLcdDataPropertyValueContext.

aLucyEnv - the lucy env.

Method Details

getPropertyValue

protected final TLcdDataPropertyValueContext getPropertyValue()

Returns the TLcdDataPropertyValueContext currently set on this customizer. This method returns the same instance as getObject(), which can be null.

Returns:

the property value.

See Also:

• ALcyCustomizerPanel.getObject()

getLucyEnv

protected ILcyLucyEnv getLucyEnv()

Returns the current Lucy environment.

requestFocus

public void requestFocus()

This method is overridden to allow implementations to switch the focus to one of the child components, a text field for instance.

Overrides:

requestFocus in class JComponent

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

Overrides:

putValue in class ALcyCustomizerPanel

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

getComponentToFocus

protected abstract Component getComponentToFocus()

When this component is offered keyboard focus, it is typically desirable that one of the children, a text field or a button for instance, gets the focus instead. This method must be implemented to designate one of the children as the future focus owner, instead of the customizer panel itself.

Returns:

the component that should receive the keyboard focus when it is offered to the customizer.

updateHorizontalAlignment

protected abstract void updateHorizontalAlignment(int aHorizontalAlignment)

This method is responsible for making sure the customizer respects the requested alignment. If your customizer does not have alignment options, the implementation should be empty.

Parameters:

aHorizontalAlignment - this will always be one of the following constants:

• SwingConstants.RIGHT
• SwingConstants.LEFT
• SwingConstants.CENTER
• SwingConstants.LEADING
• SwingConstants.TRAILING