net.sourceforge.czt.animation.gui.design

Class FormDesign

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

net.sourceforge.czt.animation.gui.design.FormDesign

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class FormDesign
extends JFrame

Window for designing a form. This class manages the placement of beans into a form, configuration of properties, and linking of beans with events.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FormDesign.GPMouseListener Mouse listener for the glass pane.
protected class	FormDesign.HandleSet Class collecting together the eight resize handle, and one move handle belonging to a bean.
protected static class	FormDesign.StatusBar Status bar for the FormDesign window.

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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

Modifier and Type	Field and Description
protected ActionMap	actionMap The actions provided by the user interface in this window.
protected PropertyChangeListener	beanNameChangeListener
protected JPanel	beanPane The bean pane is used to contain the form being designed, and any beans (wrapped) that do not visually appear within the form.
protected EventListenerList	beanSelectedListeners
protected Object	currentBean The currently selected bean.
protected Component	currentComponent
protected net.sourceforge.czt.animation.gui.design.ToolWindow.Tool	currentTool The currently selected tool.
protected boolean	eventLinkHighlightingOverride
protected Vector<BeanLink>	eventLinks
protected Form	form The form being designed by this window.
protected JPanel	glassPane Glass pane to catch mouse events.
protected Map<Object,FormDesign.HandleSet>	handles Mapping from beans in the design to their set of handles.
protected InputMap	inputMap A map from key strokes to action keys for this window.
protected FormDesign.StatusBar	statusBar

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
FormDesign(ActionMap am, InputMap im, JMenu wm, DesignerCore dc) Creates a new Form designer.
FormDesign(Form _form, ActionMap am, InputMap im, JMenu windowMenu, DesignerCore desCore)
FormDesign(String name, ActionMap am, InputMap im, JMenu windowMenu, DesignerCore desCore)

Method Summary

Modifier and Type	Method and Description
Component	addBean(Object bean, Point location)
void	addBeanSelectedListener(BeanSelectedListener l)
void	addEventLink(Component source, Component listener, Class<?> listenerType)
Point	componentLocationInBeanPaneSpace(Component component) Uses translateCoordinateFromCSpace to give the location of a component in the beanPane's coordinate space.
protected void	fireBeanSelected(Object bean)
JPanel	getBeanPane()
BeanSelectedListener[]	getBeanSelectedListeners()
Object	getCurrentBean() Getter method for the currentBean property.
Component	getCurrentBeanComponent() Getter method for the currentComponent property.
net.sourceforge.czt.animation.gui.design.ToolWindow.Tool	getCurrentTool() Getter method for the currentTool property.
Vector<BeanLink>	getEventLinks()
Form	getForm()
Action	getRaiseAction()
Line2D	getVisualLine(BeanLink l)
static FormDesign	loadDesign(XMLDecoder decoder, ActionMap am, InputMap im, JMenu windowMenu, DesignerCore desCore)
Component	lowestComponentAt(Point p)
boolean	placementAllowed(Point location, Class<?> type)
boolean	removeBean(Component beanComponent)
void	removeBeanSelectedListener(BeanSelectedListener l)
boolean	removeCurrentBean()
void	removeEventLink(BeanLink bl)
void	removeEventLinksFrom(Object source)
void	removeEventLinksFrom(Object source, Class<?> listenerType)
void	removeEventLinksTo(Object listener)
void	removeEventLinksTo(Object listener, Class<?> listenerType)
void	removeEventLinksToFrom(Object obj)
void	saveDesign(XMLEncoder encoder)
void	setCurrentBeanComponent(Component t) Setter method for the currentBean property.
void	setCursor(Cursor cursor)
void	setEventLinkHighlightingOverride(boolean o)
protected void	setupActions(ActionMap am, InputMap im, DesignerCore desCore)
protected void	setupLayeredPanes() Sets up the layering of glassPane and beanPane.
protected void	setupMenus(JMenu window) Sets up the menu bar.
protected void	setupStatusBar() Sets up the status bar.
void	toolChanged(net.sourceforge.czt.animation.gui.design.ToolChangeEvent ev)
Point	translateCoordinateFromCSpace(Point oldPoint, Component initialCSpace) Translates a coordinate described in a coordinate space that is a descendant of this FormDesign to the same coordinate relative to the beanPane's coordinate space.
Point	translateCoordinateToCSpace(Point point, Component cSpace) Translates a coordinate relative to the beanPane's coordinate space into the same coordinate relative to the coordinate space belonging to cSpace.
void	unselectBean()

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, 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 java.awt.MenuContainer

getFont, postEvent

Field Detail

form

protected Form form

The form being designed by this window.

beanSelectedListeners

protected EventListenerList beanSelectedListeners

glassPane

protected final JPanel glassPane

Glass pane to catch mouse events. The glass pane is used to block interaction with the beans/components being placed, and to draw handles and other guides on top of the form being designed.
Note: This glass pane is not the glass pane in this frame's root window. It is part of a layered panel placed inside the contentPane. This is done because we don't want the glass pane to go over the menu bar, tool bar, status bar, etc.

eventLinkHighlightingOverride

protected boolean eventLinkHighlightingOverride

eventLinks

protected Vector<BeanLink> eventLinks

beanPane

protected JPanel beanPane

The bean pane is used to contain the form being designed, and any beans (wrapped) that do not visually appear within the form.

actionMap

protected final ActionMap actionMap

The actions provided by the user interface in this window.

inputMap

protected final InputMap inputMap

A map from key strokes to action keys for this window.

statusBar

protected final FormDesign.StatusBar statusBar

currentBean

protected Object currentBean

The currently selected bean.

currentComponent

protected Component currentComponent

beanNameChangeListener

protected PropertyChangeListener beanNameChangeListener

currentTool

protected net.sourceforge.czt.animation.gui.design.ToolWindow.Tool currentTool

The currently selected tool. It is a BeanInfo describing the bean type to place.

handles

protected Map<Object,FormDesign.HandleSet> handles

Mapping from beans in the design to their set of handles.

Constructor Detail

FormDesign

public FormDesign(ActionMap am,
                  InputMap im,
                  JMenu wm,
                  DesignerCore dc)

Creates a new Form designer.

FormDesign

public FormDesign(String name,
                  ActionMap am,
                  InputMap im,
                  JMenu windowMenu,
                  DesignerCore desCore)

FormDesign

public FormDesign(Form _form,
                  ActionMap am,
                  InputMap im,
                  JMenu windowMenu,
                  DesignerCore desCore)

Method Detail

addBeanSelectedListener

public void addBeanSelectedListener(BeanSelectedListener l)

removeBeanSelectedListener

public void removeBeanSelectedListener(BeanSelectedListener l)

getBeanSelectedListeners

public BeanSelectedListener[] getBeanSelectedListeners()

fireBeanSelected

protected void fireBeanSelected(Object bean)

getForm

public Form getForm()

setEventLinkHighlightingOverride

public void setEventLinkHighlightingOverride(boolean o)

getVisualLine

public Line2D getVisualLine(BeanLink l)

getEventLinks

public Vector<BeanLink> getEventLinks()

addEventLink

public void addEventLink(Component source,
                         Component listener,
                         Class<?> listenerType)

removeEventLink

public void removeEventLink(BeanLink bl)

removeEventLinksToFrom

public void removeEventLinksToFrom(Object obj)

removeEventLinksTo

public void removeEventLinksTo(Object listener)

removeEventLinksFrom

public void removeEventLinksFrom(Object source)

removeEventLinksTo

public void removeEventLinksTo(Object listener,
                               Class<?> listenerType)

removeEventLinksFrom

public void removeEventLinksFrom(Object source,
                                 Class<?> listenerType)

getRaiseAction

public Action getRaiseAction()

getBeanPane

public JPanel getBeanPane()

unselectBean

public void unselectBean()

setCurrentBeanComponent

public void setCurrentBeanComponent(Component t)

Setter method for the currentBean property. Sets the currentBean property, makes the resize handles visible for only the current bean.

getCurrentBean

public Object getCurrentBean()

Getter method for the currentBean property.

placementAllowed

public final boolean placementAllowed(Point location,
                                      Class<?> type)

addBean

public Component addBean(Object bean,
                         Point location)
                  throws BeanOutOfBoundsException

Returns:

the component associated with the created bean.

Throws:

BeanOutOfBoundsException

removeCurrentBean

public boolean removeCurrentBean()

removeBean

public boolean removeBean(Component beanComponent)

getCurrentBeanComponent

public Component getCurrentBeanComponent()

Getter method for the currentComponent property. The currentComponent property is equal to the currentBean property if the currentBean is a Component, otherwise it is a BeanWrapper wrapping the currentBean.

See Also:

BeanWrapper

toolChanged

public void toolChanged(net.sourceforge.czt.animation.gui.design.ToolChangeEvent ev)

getCurrentTool

public net.sourceforge.czt.animation.gui.design.ToolWindow.Tool getCurrentTool()

Getter method for the currentTool property.

setupActions

protected void setupActions(ActionMap am,
                            InputMap im,
                            DesignerCore desCore)

setupLayeredPanes

protected void setupLayeredPanes()

Sets up the layering of glassPane and beanPane. Called once only from the constructor.

setupMenus

protected void setupMenus(JMenu window)

Sets up the menu bar. Called once only from the constructor.

setupStatusBar

protected void setupStatusBar()

Sets up the status bar. Called once only from the constructor.

loadDesign

public static FormDesign loadDesign(XMLDecoder decoder,
                                    ActionMap am,
                                    InputMap im,
                                    JMenu windowMenu,
                                    DesignerCore desCore)

saveDesign

public void saveDesign(XMLEncoder encoder)

translateCoordinateFromCSpace

public Point translateCoordinateFromCSpace(Point oldPoint,
                                           Component initialCSpace)

Translates a coordinate described in a coordinate space that is a descendant of this FormDesign to the same coordinate relative to the beanPane's coordinate space.

Parameters:

oldPoint - the coordinate to translate.

initialCSpace - container with coordinate space to which point is relative.

Returns:

the transformed coordinate. null if initialCSpace is not a descendant of beanPane.

componentLocationInBeanPaneSpace

public Point componentLocationInBeanPaneSpace(Component component)

Uses translateCoordinateFromCSpace to give the location of a component in the beanPane's coordinate space.

Parameters:

component - the component whose location will be found.

Returns:

the location of the component in the beanPane's coordinate space.

translateCoordinateToCSpace

public Point translateCoordinateToCSpace(Point point,
                                         Component cSpace)

Translates a coordinate relative to the beanPane's coordinate space into the same coordinate relative to the coordinate space belonging to cSpace.

Parameters:

point - the coordinate to translate.

cSpace - container with coordinate space to which point will be translated.

Returns:

the transformed coordinate. null if cSpace is not a descendant of beanPane. NOTE: The coordinate may lay outside the bounds of the container.

setCursor

public void setCursor(Cursor cursor)

Overrides:

setCursor in class Window

lowestComponentAt

public Component lowestComponentAt(Point p)