com.altair.hwm.toolkit.property
Class HWMCustomPropEditor

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.altair.hwm.toolkit.property.HWMCustomPropEditor

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class HWMCustomPropEditor
extends javax.swing.JPanel
implements java.beans.PropertyChangeListener, java.awt.event.ActionListener

Title: HWMCustomPropEditor

Description: This class acts as the container for custom bean property editors. It will draw a rectangle and allow the custom editor to draw its value, but when the user clicks on this rectangle, a dialog is shown which will allow the user to change values. The custom editor should fire prop change event whenever a property is changed. This prop change event is trapped by this class and propogated to the Bean prop panel class as a HWMPropertChangedEvt event. The bean prop panel will then let the bean know. This is 'cause I did not want each of the editors holding a reference to the bean object.

Company: Altair Engineering, Inc.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JComponent.AccessibleJComponent

Field Summary

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, 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 java.awt.image.ImageObserver

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

Constructor Summary

HWMCustomPropEditor(java.beans.PropertyDescriptor propDesc, java.beans.PropertyEditor propEditor)
Constructor

Method Summary

void	actionPerformed(java.awt.event.ActionEvent actionEvt) The ActionListener method which will wait for the user to click on the Close button and will close the dialog
void	AddHWMPropertyEditorChangeListener(HWMPropertyEditorChangeListener hwmPropEdChangeListener) Observers can add themselves to the list of listeners via this method.
void	OnDialogClose() Called when the dialog is closed either via the "close" button or thru the sys menu close.
void	OnMouseClicked(java.awt.Point ptLocation) This is called whenever the user clicks the mouse btn.
void	paint(java.awt.Graphics graphics) Override the paint method to allow the custom bean editor to draw itself
void	propertyChange(java.beans.PropertyChangeEvent propChangeEvt) Fired when the property is changed in the custom editor.
void	RemoveHWMPropertyEditorChangeListener(HWMPropertyEditorChangeListener hwmPropEdChangeListener) Observers can remove themselves from the list of listeners via this method.
void	UpdateView(java.beans.PropertyDescriptor propDesc, java.beans.PropertyEditor propEditor) When the user clicks on someother instance of the same bean class, the bean prop panel will call this method to update the prop editor

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, 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, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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, remove, removeComponentListener, removeFocusListener, 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HWMCustomPropEditor

public HWMCustomPropEditor(java.beans.PropertyDescriptor propDesc,
                           java.beans.PropertyEditor propEditor)

Constructor

Parameters:

propDesc - The property descriptor for the property

propEditor - The bean's custom property editor object

frmParent - The parent frame for the dialog that hosts the custom editor

Method Detail

OnDialogClose

public void OnDialogClose()

Called when the dialog is closed either via the "close" button or thru the sys menu close. Also update the bean with the changed properties

UpdateView

public void UpdateView(java.beans.PropertyDescriptor propDesc,
                       java.beans.PropertyEditor propEditor)

When the user clicks on someother instance of the same bean class, the bean prop panel will call this method to update the prop editor

Parameters:

propDesc - The bean's property descriptor object.

propEditor - The bean's property editor object.

paint

public void paint(java.awt.Graphics graphics)

Override the paint method to allow the custom bean editor to draw itself

Overrides:

paint in class javax.swing.JComponent

Parameters:

graphics - The graphics object for this component

OnMouseClicked

public void OnMouseClicked(java.awt.Point ptLocation)

This is called whenever the user clicks the mouse btn. A dialog will be displayed to show the custom property editor

Parameters:

ptLocation - The location of the mouse cursor

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent actionEvt)

The ActionListener method which will wait for the user to click on the Close button and will close the dialog

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

actionEvt - See ActionListener in Java help

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent propChangeEvt)

Fired when the property is changed in the custom editor. This may also include more code if tomorrow we need to reflect the changes done to the bean in the prop panel. Fire the propertyChanged event.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

propChangeEvt - See PropertyChangeListener in Java help

AddHWMPropertyEditorChangeListener

public void AddHWMPropertyEditorChangeListener(HWMPropertyEditorChangeListener hwmPropEdChangeListener)

Observers can add themselves to the list of listeners via this method.

Parameters:

hwmPropEdChangeListener - The listener object to add.

RemoveHWMPropertyEditorChangeListener

public void RemoveHWMPropertyEditorChangeListener(HWMPropertyEditorChangeListener hwmPropEdChangeListener)

Observers can remove themselves from the list of listeners via this method.

Parameters:

hwmPropEdChangeListener - The listener object to remove.