com.altair.hwm.toolkit.beans
Class HWMBeanWrapper

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.altair.hwm.toolkit.beans.HWMBeanWrapper

All Implemented Interfaces:

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

public class HWMBeanWrapper
extends javax.swing.JPanel

Title: HWMBeanWrapper

Description: This is the panel that will wrap the bean in design mode. This will enable to provide the drag/drop/resize functionality. It will also allow the binding popup to display, when user right clicks on the bean's wrapper.

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

static int	BORDER_SIZE The size of the border
static int	GRAB_HANDLE_SIZE The size for the grab handles

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

HWMBeanWrapper(HWMBeanInstance hwmBeanInstance, java.awt.Color colSelected, java.awt.Color colUnselected)
Constructor

Method Summary

void	AddListenersForResizeMove(javax.swing.event.MouseInputListener mouseIPListener) Adds the lone listener object that will handle move or resize as a listener
void	AddToolkitEventListener(HWMToolkitEventListener toolkitListener) Add a toolkit event listener
HWMBeanInstance	GetBeanInstance() Returns the HWMBeanInstance object that represents the bean which this wrapper encapsulated.
javax.swing.JPanel	getTransparentPanel() Panel that covers the bean and intercepts events
boolean	IsSelected() Returns a flag signifying if this wrapper is selected or not
boolean	IsTransparentPanelVisible() Gets the visiblity of the tranparent pane
void	OnContorlKeyDown()
void	PositionBeanInPage() Positions bean based on its location and size.
void	RemoveToolkitEventListener(HWMToolkitEventListener toolkitListener) Remove a property change listener
void	SetSelected(boolean bSelected) Selects this wrapper.
void	setSize(int nWidth, int nHeight)
void	SetTransparentPanelVisible(boolean bVisible) Sets the visibility of the transparent pane
java.lang.String	toString() String representation of this class

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, paint, 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, show, show, size, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

BORDER_SIZE

public static final int BORDER_SIZE

The size of the border

See Also:

Constant Field Values

GRAB_HANDLE_SIZE

public static final int GRAB_HANDLE_SIZE

The size for the grab handles

See Also:

Constant Field Values

Constructor Detail

HWMBeanWrapper

public HWMBeanWrapper(HWMBeanInstance hwmBeanInstance,
                      java.awt.Color colSelected,
                      java.awt.Color colUnselected)

Constructor

Parameters:

hwmBeanInstance - The HWMBeanInstance object for the bean that this wrapper encapsulates

colSelected - The color to use for the border when this wrapper is selected

colUnselected - The color to use for the border when this wrapper is not selected

Method Detail

OnContorlKeyDown

public void OnContorlKeyDown()

GetBeanInstance

public HWMBeanInstance GetBeanInstance()

Returns the HWMBeanInstance object that represents the bean which this wrapper encapsulated.

Returns:

HWMBeanInstance The HWMBeanInstance object which this wrapper encapsulates

SetSelected

public void SetSelected(boolean bSelected)

Selects this wrapper. Changes the border for the wrapper.

Parameters:

bSelected - If true - selects the wrapper else sets the border to unselected one

IsSelected

public boolean IsSelected()

Returns a flag signifying if this wrapper is selected or not

Returns:

boolean true if selected else false

PositionBeanInPage

public void PositionBeanInPage()

Positions bean based on its location and size.

toString

public java.lang.String toString()

String representation of this class

Overrides:

toString in class java.awt.Component

Returns:

String The string representation of this class

AddListenersForResizeMove

public void AddListenersForResizeMove(javax.swing.event.MouseInputListener mouseIPListener)

Adds the lone listener object that will handle move or resize as a listener

SetTransparentPanelVisible

public void SetTransparentPanelVisible(boolean bVisible)

Sets the visibility of the transparent pane

Parameters:

bVisible -

IsTransparentPanelVisible

public boolean IsTransparentPanelVisible()

Gets the visiblity of the tranparent pane

Returns:

boolean

AddToolkitEventListener

public void AddToolkitEventListener(HWMToolkitEventListener toolkitListener)

Add a toolkit event listener

Parameters:

The - toolkit event listener object

RemoveToolkitEventListener

public void RemoveToolkitEventListener(HWMToolkitEventListener toolkitListener)

Remove a property change listener

Parameters:

The - toolkit event listener object

setSize

public void setSize(int nWidth,
                    int nHeight)

Overrides:

setSize in class java.awt.Component

getTransparentPanel

public javax.swing.JPanel getTransparentPanel()

Panel that covers the bean and intercepts events