Coverage Report

Coverage Report - org.argouml.uml.ui.UMLChangeDispatch

Classes in this File

Line Coverage

Branch Coverage

Complexity

UMLChangeDispatch

72%

24/33

50%

9/18

2.833

 /* $Id: UMLChangeDispatch.java 17881 2010-01-12 21:09:28Z linus $
  *****************************************************************************
  * Copyright (c) 2009 Contributors - see below
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  *    linus
  *****************************************************************************
  *
  * Some portions of this file was previously release using the BSD License:
  */
 
 // Copyright (c) 1996-2007 The Regents of the University of California. All
 // Rights Reserved. Permission to use, copy, modify, and distribute this
 // software and its documentation without fee, and without a written
 // agreement is hereby granted, provided that the above copyright notice
 // and this paragraph appear in all copies.  This software program and
 // documentation are copyrighted by The Regents of the University of
 // California. The software program and documentation are supplied "AS
 // IS", without any accompanying services from The Regents. The Regents
 // does not warrant that the operation of the program will be
 // uninterrupted or error-free. The end-user understands that the program
 // was developed for research purposes and is advised not to rely
 // exclusively on the program for any reason.  IN NO EVENT SHALL THE
 // UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
 // SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
 // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
 // SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
 // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
 // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
 // CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
 // UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 
 package org.argouml.uml.ui;
 
 import java.awt.Component;
 import java.awt.Container;
 
 /**
  * This class is used to dispatch a UML model change event (which may
  * occur on a non-UI) thread) to user interface components.  The class
  * is created in response to a UML Model change event being captured by a
  * UMLUserInterfaceContainer and then is passed as an argument to
  * InvokeLater to be run on the user interface thread.<p>
  *
  * This class is updated to cope with changes to the targetchanged
  * mechanism.
  */
 public class UMLChangeDispatch implements Runnable, UMLUserInterfaceComponent {
     private int eventType;
     private Container container;
 
     /**
      * The target of the proppanel that constructs this umlchangedispatch.
      */
     private Object target;
 
     /**
      * Dispatch a target changed event
      */
     public static final int TARGET_CHANGED_ADD = -1;
 
 
     /**
      * Dispatch a target changed event.
      */
     public static final int TARGET_CHANGED = 0;
     /**
      * Dispatch a target reasserted event.
      */
     public static final int TARGET_REASSERTED = 7;
 
     /**
      * Creates a UMLChangeDispatch.  eventType is overriden if a call to
      * one of the event functions is called.
      *
      * @param uic user interface container to which changes are dispatched.
      * @param et -1 will add event listener to new target, 0 for default.
      */
     public UMLChangeDispatch(Container uic, int et) {
         synchronized (uic) {
             container = uic;
             eventType = et;
             if (uic instanceof PropPanel) {
                     target = ((PropPanel) uic).getTarget();
             }
         }
     }
 
     /*
      * @see org.argouml.uml.ui.UMLUserInterfaceComponent#targetChanged()
      */
     public void targetChanged() {
         eventType = 0;
     }
     
     /*
      * @see org.argouml.uml.ui.UMLUserInterfaceComponent#targetReasserted()
      */
     public void targetReasserted() {
         eventType = 7;
     }
 
     /**
      * Called by InvokeLater on user interface thread.  Dispatches
      * event to all contained objects implementing
      * UMLUserInterfaceComponent.  If event == TARGET_CHANGED_ADD, adds change
      * listener to new target on completion of dispatch.
      */
     public void run() {
         if (target != null) {
             synchronizedDispatch(container);
         } else {
             dispatch(container);
         }
     }
 
     /**
      * Iterates through all children of this container.  If a child
      * is another container then calls dispatch recursively, if
      * a child supports UMLUserInterfaceComponent then calls the
      * appropriate method.
      *
      * @param theAWTContainer AWT container
      */
     private void dispatch(Container theAWTContainer) {
 
         int count = theAWTContainer.getComponentCount();
         Component component;
         for (int i = 0; i < count; i++) {
             component = theAWTContainer.getComponent(i);
             if (component instanceof Container) {
                 dispatch((Container) component);
             }
             if (component instanceof UMLUserInterfaceComponent
                     && component.isVisible()) {
 
                 switch(eventType) {
                 case TARGET_CHANGED_ADD:
                 case TARGET_CHANGED:
                     ((UMLUserInterfaceComponent) component).targetChanged();
                     break;
 
                 case TARGET_REASSERTED:
                     ((UMLUserInterfaceComponent) component).targetReasserted();
                     break;
                 }
             }
         }
     }
 
     private void synchronizedDispatch(Container cont) {
         if (target == null) {
             throw new IllegalStateException("Target may not be null in "
                                             + "synchronized dispatch");
         }
         synchronized (target) {
             dispatch(cont);
         }
     }
 }

1		/* $Id: UMLChangeDispatch.java 17881 2010-01-12 21:09:28Z linus $
2		*****************************************************************************
3		* Copyright (c) 2009 Contributors - see below
4		* All rights reserved. This program and the accompanying materials
5		* are made available under the terms of the Eclipse Public License v1.0
6		* which accompanies this distribution, and is available at
7		* http://www.eclipse.org/legal/epl-v10.html
8		*
9		* Contributors:
10		* linus
11		*****************************************************************************
12		*
13		* Some portions of this file was previously release using the BSD License:
14		*/
15
16		// Copyright (c) 1996-2007 The Regents of the University of California. All
17		// Rights Reserved. Permission to use, copy, modify, and distribute this
18		// software and its documentation without fee, and without a written
19		// agreement is hereby granted, provided that the above copyright notice
20		// and this paragraph appear in all copies. This software program and
21		// documentation are copyrighted by The Regents of the University of
22		// California. The software program and documentation are supplied "AS
23		// IS", without any accompanying services from The Regents. The Regents
24		// does not warrant that the operation of the program will be
25		// uninterrupted or error-free. The end-user understands that the program
26		// was developed for research purposes and is advised not to rely
27		// exclusively on the program for any reason. IN NO EVENT SHALL THE
28		// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
29		// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
30		// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
31		// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
32		// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
33		// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
34		// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
35		// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
36		// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
37		// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
38
39		package org.argouml.uml.ui;
40
41		import java.awt.Component;
42		import java.awt.Container;
43
44		/**
45		* This class is used to dispatch a UML model change event (which may
46		* occur on a non-UI) thread) to user interface components. The class
47		* is created in response to a UML Model change event being captured by a
48		* UMLUserInterfaceContainer and then is passed as an argument to
49		* InvokeLater to be run on the user interface thread.<p>
50		*
51		* This class is updated to cope with changes to the targetchanged
52		* mechanism.
53		*/
54		public class UMLChangeDispatch implements Runnable, UMLUserInterfaceComponent {
55		private int eventType;
56		private Container container;
57
58		/**
59		* The target of the proppanel that constructs this umlchangedispatch.
60		*/
61		private Object target;
62
63		/**
64		* Dispatch a target changed event
65		*/
66		public static final int TARGET_CHANGED_ADD = -1;
67
68
69		/**
70		* Dispatch a target changed event.
71		*/
72		public static final int TARGET_CHANGED = 0;
73		/**
74		* Dispatch a target reasserted event.
75		*/
76		public static final int TARGET_REASSERTED = 7;
77
78		/**
79		* Creates a UMLChangeDispatch. eventType is overriden if a call to
80		* one of the event functions is called.
81		*
82		* @param uic user interface container to which changes are dispatched.
83		* @param et -1 will add event listener to new target, 0 for default.
84		*/
85	4723	public UMLChangeDispatch(Container uic, int et) {
86	4723	synchronized (uic) {
87	4723	container = uic;
88	4723	eventType = et;
89	4723	if (uic instanceof PropPanel) {
90	4723	target = ((PropPanel) uic).getTarget();
91		}
92	4723	}
93	4723	}
94
95		/*
96		* @see org.argouml.uml.ui.UMLUserInterfaceComponent#targetChanged()
97		*/
98		public void targetChanged() {
99	0	eventType = 0;
100	0	}
101
102		/*
103		* @see org.argouml.uml.ui.UMLUserInterfaceComponent#targetReasserted()
104		*/
105		public void targetReasserted() {
106	0	eventType = 7;
107	0	}
108
109		/**
110		* Called by InvokeLater on user interface thread. Dispatches
111		* event to all contained objects implementing
112		* UMLUserInterfaceComponent. If event == TARGET_CHANGED_ADD, adds change
113		* listener to new target on completion of dispatch.
114		*/
115		public void run() {
116	4723	if (target != null) {
117	4464	synchronizedDispatch(container);
118		} else {
119	259	dispatch(container);
120		}
121	4723	}
122
123		/**
124		* Iterates through all children of this container. If a child
125		* is another container then calls dispatch recursively, if
126		* a child supports UMLUserInterfaceComponent then calls the
127		* appropriate method.
128		*
129		* @param theAWTContainer AWT container
130		*/
131		private void dispatch(Container theAWTContainer) {
132
133	80291	int count = theAWTContainer.getComponentCount();
134		Component component;
135	155859	for (int i = 0; i < count; i++) {
136	75568	component = theAWTContainer.getComponent(i);
137	75568	if (component instanceof Container) {
138	75568	dispatch((Container) component);
139		}
140	75568	if (component instanceof UMLUserInterfaceComponent
141		&& component.isVisible()) {
142
143	0	switch(eventType) {
144		case TARGET_CHANGED_ADD:
145		case TARGET_CHANGED:
146	0	((UMLUserInterfaceComponent) component).targetChanged();
147	0	break;
148
149		case TARGET_REASSERTED:
150	0	((UMLUserInterfaceComponent) component).targetReasserted();
151		break;
152		}
153		}
154		}
155	80291	}
156
157		private void synchronizedDispatch(Container cont) {
158	4464	if (target == null) {
159	0	throw new IllegalStateException("Target may not be null in "
160		+ "synchronized dispatch");
161		}
162	4464	synchronized (target) {
163	4464	dispatch(cont);
164	4464	}
165	4464	}
166		}