templates.presentation
Class EventLinksDialog

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Dialog
                  extended by javax.swing.JDialog
                      extended by ides.api.utilities.EscapeDialog
                          extended by templates.presentation.EventLinksDialog
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class EventLinksDialog
extends ides.api.utilities.EscapeDialog

The UI dialog which allows the linking of events between components in a template design.

Author:
Lenko Grigorov
See Also:
Serialized Form

Nested Class Summary
protected static class EventLinksDialog.EntityRenderer
          Class used to render the icons of the Entitys which contain the TemplateComponents whose events are linked.
 
Nested classes/interfaces inherited from class javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Nested classes/interfaces inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType
 
Nested classes/interfaces inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
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
protected static TemplateEditableCanvas canvas
          The canvas which contains the connector between the TemplateComponents whose events are linked.
protected static java.awt.event.WindowListener commitOnFocusLost
          Handler of focus for the main window of IDES.
protected static Connector connector
          The Connector between the TemplateComponents whose events are linked.
protected static boolean isLeftLeft
          Set to true if the "left" Entity linked by the Connector appears to the left of the "right" Entity; otherwise set to false.
protected static javax.swing.JButton leftAdd
          Button to add new events to the event list for the left Entity.
protected static javax.swing.JPanel leftIcon
          The UI element displaying the icon of the left Entity linked by the Connector.
protected static javax.swing.JTextField leftName
          Field to type event names for the left Entity.
protected static EventLinker linker
          The UI element which handles the event linking.
protected static javax.swing.JPanel linkerPanel
          The UI element displaying the event links.
protected static javax.swing.JButton rightAdd
          Button to add new events to the event list for the right Entity.
protected static javax.swing.JPanel rightIcon
          The UI element displaying the icon of the right Entity linked by the Connector.
protected static javax.swing.JTextField rightName
          Field to type event names for the right Entity.
 
Fields inherited from class ides.api.utilities.EscapeDialog
escapeListener
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Dialog
DEFAULT_MODALITY_TYPE
 
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, EXIT_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Method Summary
 java.lang.Object clone()
           
 void commitAndClose()
          Commit the changes to the event links made by the user and close the dialog.
protected static EventLinksDialog instance()
          Access the singleton instance of the assign events dialog.
 void onEscapeEvent()
          Called to cancel the changes made to the linking of events (e.g., when the user presses the Esc key).
static void showAndAssign(TemplateEditableCanvas canvas, Connector connector)
          Show the assign events dialog to let the user link events between the TemplateComponents contained by the Entitys connected by the given Connector.
 
Methods inherited from class ides.api.utilities.EscapeDialog
bindEscapeListener
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
 
Methods inherited from class java.awt.Dialog
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, show, toBack
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, 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, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, 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, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, 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, isOpaque, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

connector

protected static Connector connector
The Connector between the TemplateComponents whose events are linked.


canvas

protected static TemplateEditableCanvas canvas
The canvas which contains the connector between the TemplateComponents whose events are linked.


commitOnFocusLost

protected static java.awt.event.WindowListener commitOnFocusLost
Handler of focus for the main window of IDES. When the user clicks outside the event linking dialog (i.e., the main window gets activated), commit the changes and close.


leftIcon

protected static javax.swing.JPanel leftIcon
The UI element displaying the icon of the left Entity linked by the Connector.


rightIcon

protected static javax.swing.JPanel rightIcon
The UI element displaying the icon of the right Entity linked by the Connector.


linkerPanel

protected static javax.swing.JPanel linkerPanel
The UI element displaying the event links.


linker

protected static EventLinker linker
The UI element which handles the event linking.


leftName

protected static javax.swing.JTextField leftName
Field to type event names for the left Entity.


leftAdd

protected static javax.swing.JButton leftAdd
Button to add new events to the event list for the left Entity.


rightName

protected static javax.swing.JTextField rightName
Field to type event names for the right Entity.


rightAdd

protected static javax.swing.JButton rightAdd
Button to add new events to the event list for the right Entity.


isLeftLeft

protected static boolean isLeftLeft
Set to true if the "left" Entity linked by the Connector appears to the left of the "right" Entity; otherwise set to false.

Method Detail

instance

protected static EventLinksDialog instance()
Access the singleton instance of the assign events dialog.

Returns:
the singleton instance of the assign events dialog

clone

public java.lang.Object clone()
Overrides:
clone in class java.lang.Object
Throws:
java.lang.RuntimeException - cloning is not allowed

onEscapeEvent

public void onEscapeEvent()
Called to cancel the changes made to the linking of events (e.g., when the user presses the Esc key).

Overrides:
onEscapeEvent in class ides.api.utilities.EscapeDialog

commitAndClose

public void commitAndClose()
Commit the changes to the event links made by the user and close the dialog.


showAndAssign

public static void showAndAssign(TemplateEditableCanvas canvas,
                                 Connector connector)
Show the assign events dialog to let the user link events between the TemplateComponents contained by the Entitys connected by the given Connector.

Parameters:
canvas - the canvas which contains the given connector
connector - the Connector connecting the Entitys which contain the TemplateComponents whose events the user will be linking