com.metamatrix.toolbox.ui.widget.property
Class ObjectReferencePropertyComponent

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.metamatrix.toolbox.ui.widget.property.MultivaluedPropertyComponent
                      com.metamatrix.toolbox.ui.widget.property.ObjectReferencePropertyComponent

All Implemented Interfaces:

PropertyComponent, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class ObjectReferencePropertyComponent
extends MultivaluedPropertyComponent
implements PropertyComponent

ObjectReferencePropertyComponent is an extension of MultivaluedPropertyComponent for displaying and editing PropertyDefinition values of type PropertyType.OBJECT_REFERENCE. It differs from MultivaluedPropertyComponent in that it may be called for PropertyDefinitions that are single valued. This component will respond appropriately.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class com.metamatrix.toolbox.ui.widget.property.MultivaluedPropertyComponent

buttonBox, focusListener

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.metamatrix.toolbox.ui.widget.property.PropertyComponent

EMPTY_STRING

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

ObjectReferencePropertyComponent(PropertyDefinition dfn, java.lang.Object data, boolean readOnly, int index, PropertiedObject object, PropertiedObjectEditor editor, ObjectReferenceHandler handler, PropertyChangeAdapter adapter)
Constructor

Method Summary

protected void	addButtonPressed() Method overridden from super class to call the appropriate ObjectReferenceHandler method when the '+' button is clicked.
protected void	createCustomComponent()
java.lang.Object	getValue() Override method which checks multiplicity of the propertied object, just in case it is a single value and not multi valued.
boolean	isCurrentValueEqualTo(java.lang.Object value) Return whether or not the specified value Object is equal to this component's currently displayed value.
protected void	moreButtonPressed() called by the moreButton's action processor method.
protected void	navigateButtonPressed()
protected void	removeButtonPressed()
protected void	setValue(java.lang.Object value)

Methods inherited from class com.metamatrix.toolbox.ui.widget.property.MultivaluedPropertyComponent

addActionListener, addFocusListener, editingStarted, editingStopped, fireFocusEvent, getInputValue, getList, getListWidget, getNullValue, getRemoveButton, getSingleRowComponent, getSingleRowString, initializeMultivaluedPropertyComponent, isFocusTraversable, processFocusLostEvent, removeActionListener, removeFocusListener, removePropertyValidationListener, setEnabled, setPropertyValidationListener, setValidity, updateList

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, 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, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.metamatrix.toolbox.ui.widget.property.PropertyComponent

addActionListener, addFocusListener, editingStarted, editingStopped, getNullValue, getSingleRowComponent, getSingleRowString, removePropertyValidationListener, setEnabled, setPropertyValidationListener, setValidity

Constructor Detail

ObjectReferencePropertyComponent

public ObjectReferencePropertyComponent(PropertyDefinition dfn,
                                        java.lang.Object data,
                                        boolean readOnly,
                                        int index,
                                        PropertiedObject object,
                                        PropertiedObjectEditor editor,
                                        ObjectReferenceHandler handler,
                                        PropertyChangeAdapter adapter)

Constructor

Method Detail

moreButtonPressed

protected void moreButtonPressed()

Description copied from class: MultivaluedPropertyComponent

called by the moreButton's action processor method. The moreButton is generated when there are "allowable values" available for this PropertyDefinition. May be overridden by subclasses to provide different functionality.

Overrides:

moreButtonPressed in class MultivaluedPropertyComponent

addButtonPressed

protected void addButtonPressed()

Method overridden from super class to call the appropriate ObjectReferenceHandler method when the '+' button is clicked. This method will never be called if the handler is null.

Overrides:

addButtonPressed in class MultivaluedPropertyComponent

setValue

protected void setValue(java.lang.Object value)

getValue

public java.lang.Object getValue()

Override method which checks multiplicity of the propertied object, just in case it is a single value and not multi valued. Get the value being displayed by this component. This value will be obtained from the PropertyChangeAdapter immediately prior to and after editing. After the user has stopped editing the value, the isEqualTo() method will be called allowing this component to determine if the user has changed the value.

Specified by:

getValue in interface PropertyComponent

Overrides:

getValue in class MultivaluedPropertyComponent

Returns:

the property's value. May be a single object or a Collection.

isCurrentValueEqualTo

public boolean isCurrentValueEqualTo(java.lang.Object value)

Return whether or not the specified value Object is equal to this component's currently displayed value. This method is called by PropertyChangeAdapter and allows the value comparison logic to reside within the custom component, rather than requiring custom components to hardcode comparison logic in the adapter.

Specified by:

isCurrentValueEqualTo in interface PropertyComponent

Overrides:

isCurrentValueEqualTo in class MultivaluedPropertyComponent

Parameters:

value - an Object that was previously obtained from this component's getValue method.

Returns:

true if the specified Object is the same as the value currently being displayed in this component, false if it is not. Returning true will cause the new value to be "set" on the target propertied object.

removeButtonPressed

protected void removeButtonPressed()

Overrides:

removeButtonPressed in class MultivaluedPropertyComponent

Since:

Golden Gate

navigateButtonPressed

protected void navigateButtonPressed()

createCustomComponent

protected void createCustomComponent()