org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/core/GraphNode.java

   1 /**********************************************************************
   2  * Copyright (c) 2005, 2008 IBM Corporation and others.
   3  * Copyright (c) 2011, 2012 Ericsson.
   4  *
   5  * All rights reserved.   This program and the accompanying materials
   6  * are made available under the terms of the Eclipse Public License v1.0
   7  * which accompanies this distribution, and is available at
   8  * http://www.eclipse.org/legal/epl-v10.html
   9  *
  10  * Contributors:
  11  * IBM - Initial API and implementation
  12  * Bernd Hufmann - Updated for TMF
  13  **********************************************************************/
  14 package org.eclipse.linuxtools.tmf.ui.views.uml2sd.core;
  15
  16 import java.util.ArrayList;
  17 import java.util.Arrays;
  18 import java.util.Comparator;
  19 import java.util.HashMap;
  20 import java.util.Iterator;
  21 import java.util.List;
  22 import java.util.Map;
  23
  24 import org.eclipse.linuxtools.internal.tmf.ui.TmfUiTracer;
  25 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.drawings.IGC;
  26 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.preferences.ISDPreferences;
  27 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.preferences.SDViewPref;
  28
  29 /**
  30  * The base class used for all UML2 graph nodes displayed in the Sequence Diagram SDWidget.
  31  *
  32  * @author sveyrier
  33  * @version 1.0
  34  */
  35 public abstract class GraphNode {
  36
  37     // ------------------------------------------------------------------------
  38     // Attributes
  39     // ------------------------------------------------------------------------
  40     /**
  41      * The start event occurrence.
  42      */
  43     protected int fStartEventOccurrence = 0;
  44     /**
  45      * The event event occurrence.
  46      */
  47     protected int fEndEventOccurrence = 0;
  48     /**
  49      * Preference ColorId to use to draw font
  50      */
  51     public String fPrefId = ISDPreferences.PREF_SYNC_MESS;
  52     /**
  53      * The selection state of the graph node.
  54      */
  55     protected boolean fSelected = false;
  56     /**
  57      * The focus state of the graph node.
  58      */
  59     protected boolean fFocused = false;
  60     /**
  61      * Flag to indicate whether node has children or not.
  62      */
  63     protected boolean fHasChilden = false;
  64     /**
  65      * The graph node name used to label the graph node in the View.
  66      */
  67     protected String fName = ""; //$NON-NLS-1$
  68     /**
  69      * A map from node name to graph node.
  70      */
  71     protected Map<String, List<GraphNode>> fNodes;
  72     /**
  73      * A map from node name to graph node for forward sorting
  74      */
  75     protected Map<String, List<GraphNode>> fForwardNodes;
  76     /**
  77      * A map from node name to graph node for backwards sorting.
  78      */
  79     protected Map<String, List<GraphNode>> fBackwardNodes;
  80     /**
  81      * A map from node name to index.
  82      */
  83     protected Map<String, Integer> fIndexes;
  84     /**
  85      * A map from node name to index for forwards sorting.
  86      */
  87     protected Map<String, Boolean> fForwardSort;
  88     /**
  89      * A map from node name to index for forwards sorting.
  90      */
  91     protected Map<String, Boolean> fBackwardSort;
  92
  93     // ------------------------------------------------------------------------
  94     // Methods
  95     // ------------------------------------------------------------------------
  96
  97     /**
  98      * Reset the internal index of the first visible GraphNode for each ordered GraphNode lists
  99      */
 100     public void resetIndex() {
 101         if (!fHasChilden) {
 102             return;
 103         }
 104
 105         Iterator<String> it = fIndexes.keySet().iterator();
 106         while (it.hasNext()) {
 107             String nodeType = it.next();
 108             fIndexes.put(nodeType, Integer.valueOf(0));
 109         }
 110     }
 111
 112     /**
 113      * Add a GraphNode into the receiver
 114      *
 115      * @param nodeToAdd the node to add
 116      */
 117     public void addNode(GraphNode nodeToAdd) {
 118         if (!fHasChilden) {
 119             fNodes = new HashMap<String, List<GraphNode>>(2);
 120             fForwardNodes = new HashMap<String, List<GraphNode>>(2);
 121             fBackwardNodes = new HashMap<String, List<GraphNode>>(2);
 122             fIndexes = new HashMap<String, Integer>(2);
 123             fBackwardSort = new HashMap<String, Boolean>(2);
 124             fForwardSort = new HashMap<String, Boolean>(2);
 125             fHasChilden = true;
 126         }
 127
 128         // Nothing to add
 129         if (nodeToAdd == null) {
 130             return;
 131         }
 132
 133         if (fNodes.get(nodeToAdd.getArrayId()) == null) {
 134             fNodes.put(nodeToAdd.getArrayId(), new ArrayList<GraphNode>(1));
 135             fIndexes.put(nodeToAdd.getArrayId(), Integer.valueOf(0));
 136             fForwardNodes.put(nodeToAdd.getArrayId(), new ArrayList<GraphNode>(1));
 137             fForwardSort.put(nodeToAdd.getArrayId(), Boolean.FALSE);
 138             if (nodeToAdd.getBackComparator() != null) {
 139                 fBackwardNodes.put(nodeToAdd.getArrayId(), new ArrayList<GraphNode>(1));
 140                 fBackwardSort.put(nodeToAdd.getArrayId(), Boolean.FALSE);
 141             }
 142         }
 143
 144         List<GraphNode> fNodeList = (List<GraphNode>) fForwardNodes.get(nodeToAdd.getArrayId());
 145         List<GraphNode> bNodeList = null;
 146         if (fBackwardNodes != null) {
 147             bNodeList = (List<GraphNode>) fBackwardNodes.get(nodeToAdd.getArrayId());
 148         }
 149         if (fNodeList != null && fNodeList.size() > 0) {
 150             // check if the nodes are added y ordered
 151             // if not, tag the list to sort it later (during draw)
 152             GraphNode node = (GraphNode) fNodeList.get(fNodeList.size() - 1);
 153             Comparator<GraphNode> fcomp = nodeToAdd.getComparator();
 154             Comparator<GraphNode> bcomp = nodeToAdd.getBackComparator();
 155             if ((fcomp != null) && (fcomp.compare(node, nodeToAdd) > 0)) {
 156                 fForwardSort.put(nodeToAdd.getArrayId(), Boolean.TRUE);
 157             }
 158             if ((bcomp != null) && (bcomp.compare(node, nodeToAdd) > 0)) {
 159                 fBackwardSort.put(nodeToAdd.getArrayId(), Boolean.TRUE);
 160             }
 161         }
 162
 163         if (fNodeList == null) {
 164             fNodeList = new ArrayList<GraphNode>();
 165         }
 166
 167         fNodeList.add(nodeToAdd);
 168         fNodes.put(nodeToAdd.getArrayId(), fNodeList);
 169         fForwardNodes.put(nodeToAdd.getArrayId(), fNodeList);
 170         if (nodeToAdd.getBackComparator() != null) {
 171             bNodeList.add(nodeToAdd);
 172             fBackwardNodes.put(nodeToAdd.getArrayId(), bNodeList);
 173         }
 174     }
 175
 176     /**
 177      * Set the graph node name.<br>
 178      * It is the name display in the view to label the graph node.
 179      *
 180      * @param nodeName the name to set
 181      */
 182     public void setName(String nodeName) {
 183         fName = nodeName;
 184     }
 185
 186     /**
 187      * Returns the graph node name.<br>
 188      * It is the name display in the view to label the graph node.
 189      *
 190      * @return the graph node name
 191      */
 192     public String getName() {
 193         return fName;
 194     }
 195
 196     /**
 197      * Tags the the graph node has selected.<br>
 198      * WARNING: This method is only used to draw the graph node using the system selection colors. <br>
 199      * To use the complete SDViewer selection mechanism (selection management, notification, etc..) see SDWidget class
 200      *
 201      * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.SDWidget#addSelection(GraphNode)
 202      * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.SDWidget#removeSelection(GraphNode)
 203      * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.SDWidget#clearSelection()
 204      * @param selection - true to set selected, false to set unselected
 205      */
 206     public void setSelected(boolean selection) {
 207         fSelected = selection;
 208     }
 209
 210     /**
 211      * Tags the the graph node as focused.<br>
 212      * WARNING: This method is only used to draw the graph node using the system focus style. <br>
 213      * To use the complete SDViewer focus mechanism see SDWidget class
 214      *
 215      * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.SDWidget#addSelection(GraphNode)
 216      * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.SDWidget#removeSelection(GraphNode)
 217      * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.SDWidget#clearSelection()
 218      * @param focus - true to set focued, false otherwise
 219      */
 220     public void setFocused(boolean focus) {
 221         fFocused = focus;
 222     }
 223
 224     /**
 225      * Returns true if the graph node is selected, false otherwise.<br>
 226      * The returned value is used to highlight the graph node in the View.
 227      *
 228      * @return true if selected, false otherwise
 229      */
 230     public boolean isSelected() {
 231         return fSelected;
 232     }
 233
 234     /**
 235      * Returns true if the graph node is focused, false otherwise.<br>
 236      * The returned value is used to highlight the graph node in the View.
 237      *
 238      * @return true if focused, false otherwise
 239      */
 240     public boolean hasFocus() {
 241         return fFocused;
 242     }
 243
 244     /**
 245      * Returns true if the graph node contains the point given in parameter,
 246      * return false otherwise.
 247      *
 248      * @param x
 249      *            the x coordinate of the point to test containment
 250      * @param y
 251      *            the y coordinate of the point to test containment
 252      * @return true if contained, false otherwise
 253      */
 254     abstract public boolean contains(int x, int y);
 255
 256     /**
 257      * Returns the x coordinate of the graph node
 258      *
 259      * @return the x coordinate
 260      */
 261     abstract public int getX();
 262
 263     /**
 264      * Returns the y coordinate of the graph node
 265      *
 266      * @return the y coordinate
 267      */
 268     abstract public int getY();
 269
 270     /**
 271      * Returns the graph node height
 272      *
 273      * @return the graph node height
 274      */
 275     abstract public int getHeight();
 276
 277     /**
 278      * Returns the graph node width
 279      *
 280      * @return the graph node width
 281      */
 282     abstract public int getWidth();
 283
 284     /**
 285      * Draws the graph node in the given context
 286      *
 287      * @param context the graphical context to draw in
 288      */
 289     abstract protected void draw(IGC context);
 290
 291     /**
 292      * Returns the GraphNode visibility for the given visible area. Wrong
 293      * visibility calculation, may strongly impact drawing performance
 294      *
 295      * @param x
 296      *            The X coordinate
 297      * @param y
 298      *            The Y coordinate
 299      * @param width
 300      *            The width of the area
 301      * @param height
 302      *            The height of the area
 303      * @return true if visible, false otherwise
 304      */
 305     public boolean isVisible(int x, int y, int width, int height) {
 306         return true;
 307     }
 308
 309     /**
 310      * Return a comparator to sort the GraphNode of the same type This
 311      * comparator is used to order the GraphNode array of the given node type.
 312      * (see getArrayId).
 313      *
 314      * @return the comparator
 315      */
 316     public Comparator<GraphNode> getComparator() {
 317         return null;
 318     }
 319
 320     /**
 321      * If needed, return a different comparator to backward scan the GraphNode
 322      * array
 323      *
 324      * @return the backward comparator or null if not needed
 325      */
 326     public Comparator<GraphNode> getBackComparator() {
 327         return null;
 328     }
 329
 330     /**
 331      * Compare two graphNodes
 332      *
 333      * @param node
 334      *            the node to compare to
 335      * @return true if equal false otherwise
 336      */
 337     public boolean isSameAs(GraphNode node) {
 338         return false;
 339     }
 340
 341     /**
 342      * Return the node type for all class instances. This id is used to store the same nodes kind in the same ordered
 343      * array.
 344      *
 345      * @return the node type identifier
 346      */
 347     abstract public String getArrayId();
 348
 349     /**
 350      * Return true if the distance from the GraphNode to the given point is positive
 351      *
 352      * @param x the point x coordinate
 353      * @param y the point y coordinate
 354      * @return true if positive false otherwise
 355      */
 356     public boolean positiveDistanceToPoint(int x, int y) {
 357         return false;
 358     }
 359
 360     /**
 361      * Returns the graph node which contains the point given in parameter WARNING: Only graph nodes in the current
 362      * visible area can be returned
 363      *
 364      * @param x the x coordinate of the point to test
 365      * @param y the y coordinate of the point to test
 366      * @return the graph node containing the point given in parameter, null otherwise
 367      */
 368     public GraphNode getNodeAt(int x, int y) {
 369         GraphNode toReturn = null;
 370
 371         if (!fHasChilden) {
 372             return null;
 373         }
 374
 375         Iterator<String> it = fNodes.keySet().iterator();
 376         GraphNode node = null;
 377         while (it.hasNext()) {
 378             Object nodeType = it.next();
 379             List<GraphNode> list = (List<GraphNode>) fNodes.get(nodeType);
 380             int index = ((Integer) fIndexes.get(nodeType)).intValue();
 381             node = getNodeFromListAt(x, y, list, index);
 382             if (toReturn == null) {
 383                 toReturn = node;
 384             }
 385             if (node != null) {
 386                 GraphNode internalNode = node.getNodeAt(x, y);
 387                 if (internalNode != null) {
 388                     return internalNode;
 389                 } else if (Math.abs(node.getWidth()) < Math.abs(toReturn.getWidth()) || Math.abs(node.getHeight()) < Math.abs(toReturn.getHeight())) {
 390                     toReturn = node;
 391                 }
 392             }
 393         }
 394         return toReturn;
 395     }
 396
 397     /**
 398      * Gets node list from node A to node B
 399
 400      * @param from A from node
 401      * @param to A to node
 402      * @return the list of nodes
 403      */
 404     public List<GraphNode> getNodeList(GraphNode from, GraphNode to) {
 405         List<GraphNode> result = new ArrayList<GraphNode>();
 406
 407         if (from != null) {
 408             result.add(from);
 409         } else if (to != null) {
 410             result.add(to);
 411         }
 412
 413         if ((from == null) || (to == null)) {
 414             return result;
 415         }
 416
 417         if (from == to) {
 418             return result;
 419         }
 420
 421         int startX = Math.min(from.getX(), Math.min(to.getX(), Math.min(from.getX() + from.getWidth(), to.getX() + to.getWidth())));
 422         int endX = Math.max(from.getX(), Math.max(to.getX(), Math.max(from.getX() + from.getWidth(), to.getX() + to.getWidth())));
 423         int startY = Math.min(from.getY(), Math.min(to.getY(), Math.min(from.getY() + from.getHeight(), to.getY() + to.getHeight())));
 424         int endY = Math.max(from.getY(), Math.max(to.getY(), Math.max(from.getY() + from.getHeight(), to.getY() + to.getHeight())));
 425
 426         if (!fHasChilden) {
 427             return result;
 428         }
 429
 430         Iterator<String> it = fNodes.keySet().iterator();
 431         while (it.hasNext()) {
 432             Object nodeType = it.next();
 433             List<GraphNode> nodesList = (List<GraphNode>) fNodes.get(nodeType);
 434             if (nodesList == null || nodesList.isEmpty()) {
 435                 return null;
 436             }
 437             for (int i = 0; i < nodesList.size(); i++) {
 438                 GraphNode node = (GraphNode) nodesList.get(i);
 439                 int nw = node.getWidth();
 440                 int nh = node.getHeight();
 441                 int nx = node.getX();
 442                 int ny = node.getY();
 443                 if (contains(startX, startY, endX - startX, endY - startY, nx + 1, ny + 1) && contains(startX, startY, endX - startX, endY - startY, nx + nw - 2, ny + nh - 2)) {
 444                     result.add(node);
 445                 }
 446                 result.addAll(node.getNodeList(from, to));
 447             }
 448         }
 449
 450         if (!result.contains(to)) {
 451             result.add(to);
 452         }
 453         return result;
 454     }
 455
 456     /**
 457      * Returns the graph node which contains the point given in parameter for the given graph node list and starting the
 458      * iteration at the given index<br>
 459      * WARNING: Only graph nodes with smaller coordinates than the current visible area can be returned.<br>
 460      *
 461      * @param x the x coordinate of the point to test
 462      * @param y the y coordinate of the point to test
 463      * @param list the list to search in
 464      * @param fromIndex list browsing starting point
 465      * @return the graph node containing the point given in parameter, null otherwise
 466      */
 467     protected GraphNode getNodeFromListAt(int x, int y, List<GraphNode> list, int fromIndex) {
 468         if (list == null) {
 469             return null;
 470         }
 471         for (int i = fromIndex; i < list.size(); i++) {
 472             GraphNode node = (GraphNode) list.get(i);
 473             if (node.contains(x, y)) {
 474                 return node;
 475             }
 476         }
 477         return null;
 478     }
 479
 480     /**
 481      * Returns the start event occurrence attached to this graphNode.
 482      *
 483      * @return the start event occurrence attached to the graphNode
 484      */
 485     public int getStartOccurrence() {
 486         return fStartEventOccurrence;
 487     }
 488
 489     /**
 490      * Returns the end event occurrence attached to this graphNode
 491      *
 492      * @return the start event occurrence attached to the graphNode
 493      */
 494     public int getEndOccurrence() {
 495         return fEndEventOccurrence;
 496     }
 497
 498     /**
 499      * Computes the index of the first visible GraphNode for each ordered graph node lists depending on the visible area
 500      * given in parameter
 501      *
 502      * @param x visible area top left corner x coordinate
 503      * @param y visible area top left corner y coordinate
 504      * @param width visible area width
 505      * @param height visible area height
 506      */
 507     public void updateIndex(int x, int y, int width, int height) {
 508         if (!fHasChilden) {
 509             return;
 510         }
 511         if(TmfUiTracer.isIndexTraced()) {
 512             TmfUiTracer.traceIndex("*****************************\n"); //$NON-NLS-1$
 513             TmfUiTracer.traceIndex("Visible area position in virtual screen (x,y)= " + x + " " + y + "\n\n"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
 514         }
 515
 516         Iterator<String> it = fNodes.keySet().iterator();
 517         while (it.hasNext()) {
 518             String nodeType = it.next();
 519             int direction = 1;
 520             int drawIndex = ((Integer) fIndexes.get(nodeType)).intValue();
 521             /*
 522              * if (x==0) { drawIndex = 0; indexes.put(nodeType,new Integer(drawIndex)); }
 523              */
 524             if ((fNodes.get(nodeType) != null) && (((List<GraphNode>) fNodes.get(nodeType)).size() > 1)) {
 525                 if (((GraphNode) ((List<GraphNode>) fNodes.get(nodeType)).get(drawIndex)).positiveDistanceToPoint(x, y)) {
 526                     direction = -1;
 527                 }
 528
 529                 if (drawIndex == 0) {
 530                     direction = 1;
 531                 }
 532
 533                 if ((direction == -1) && (fBackwardNodes.get(nodeType) != null)) {
 534                     GraphNode currentNode = (GraphNode) ((List<GraphNode>) fNodes.get(nodeType)).get(drawIndex);
 535                     drawIndex = Arrays.binarySearch(((List<GraphNode>) fBackwardNodes.get(nodeType)).toArray(new GraphNode[((List<GraphNode>) fBackwardNodes.get(nodeType)).size()]),
 536                             ((List<GraphNode>) fNodes.get(nodeType)).get(drawIndex), currentNode.getBackComparator());
 537                     fNodes.put(nodeType, (List<GraphNode>) fBackwardNodes.get(nodeType));
 538                     if (drawIndex < 0) {
 539                         drawIndex = 0;
 540                         direction = 1;
 541                     } else {
 542                         fNodes.put(nodeType, (List<GraphNode>) fBackwardNodes.get(nodeType));
 543                     }
 544                 }
 545                 GraphNode prev = null;
 546
 547                 for (int i = drawIndex; i < ((List<GraphNode>) fNodes.get(nodeType)).size() && i >= 0; i = i + direction) {
 548                     drawIndex = i;
 549                     fIndexes.put(nodeType, Integer.valueOf(i));
 550
 551                     GraphNode currentNode = (GraphNode) ((List<GraphNode>) fNodes.get(nodeType)).get(i);
 552
 553                     if (prev == null) {
 554                         prev = currentNode;
 555                     }
 556
 557                     Comparator<GraphNode> comp = currentNode.getComparator();
 558                     Map<String, Boolean> sort = fForwardSort;
 559
 560                     if ((direction == -1) && (currentNode.getBackComparator() != null)) {
 561                         comp = currentNode.getBackComparator();
 562                         sort = fBackwardSort;
 563                     }
 564
 565                     if (i < ((List<GraphNode>) fNodes.get(nodeType)).size() - 1) {
 566                         GraphNode next = (GraphNode) ((List<GraphNode>) fNodes.get(nodeType)).get(i + 1);
 567
 568                         if ((comp != null) && (comp.compare(currentNode, next) > 0)) {
 569                             sort.put(nodeType, Boolean.TRUE);
 570                         }
 571                     }
 572                     if (direction == 1) {
 573                         if (((GraphNode) ((List<GraphNode>) fNodes.get(nodeType)).get(i)).positiveDistanceToPoint(x, y)) {
 574                             break;
 575                         }
 576                     } else {
 577                         if (currentNode.getBackComparator() == null) {
 578                             if // (currentNode.isVisible(x,y,width,height)
 579                             (!currentNode.positiveDistanceToPoint(x, y)) {
 580                                 break;
 581                             }
 582                         } else {
 583                             if (currentNode.isVisible(x, y, width, height) && !currentNode.positiveDistanceToPoint(x, y)) {
 584                                 if ((comp != null) && (comp.compare(currentNode, prev) <= 0)) {
 585                                     break;
 586                                 }
 587                             } else if ((comp != null) && (comp.compare(currentNode, prev) <= 0)) {
 588                                 prev = currentNode;
 589                             }
 590                         }
 591                     }
 592                 }
 593
 594                 fNodes.put(nodeType, fForwardNodes.get(nodeType));
 595                 if ((fBackwardNodes.get(nodeType) != null) && (direction == -1)) {
 596                     // nodes.put(nodeType,fnodes.get(nodeType));
 597                     int index = ((Integer) fIndexes.get(nodeType)).intValue();
 598                     List<GraphNode> list = (List<GraphNode>) fNodes.get(nodeType);
 599                     List<GraphNode> backList = (List<GraphNode>) fBackwardNodes.get(nodeType);
 600                     GraphNode currentNode = (GraphNode) (backList.get(index));
 601                     if (index > 0) {
 602                         index = Arrays.binarySearch(list.toArray(new GraphNode[list.size()]), backList.get(index), currentNode.getComparator());
 603                         if (index < 0) {
 604                             index = 0;
 605                         }
 606                         fIndexes.put(nodeType, Integer.valueOf(index));
 607                     }
 608                 }
 609
 610                 for (int i = drawIndex; i < ((List<GraphNode>) fNodes.get(nodeType)).size() && i >= 0; i++) {
 611                     GraphNode toDraw = (GraphNode) ((List<GraphNode>) fNodes.get(nodeType)).get(i);
 612                     toDraw.updateIndex(x, y, width, height);
 613                     if (!toDraw.isVisible(x, y, width, height)) {
 614                         break;
 615                     }
 616                 }
 617             }
 618             if (TmfUiTracer.isIndexTraced()) {
 619                 TmfUiTracer.traceIndex("First drawn " + nodeType + " index = " + drawIndex + "\n"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
 620                 TmfUiTracer.traceIndex(nodeType + " found in " + 0 + " iterations\n"); //$NON-NLS-1$ //$NON-NLS-2$
 621             }
 622         }
 623
 624         if (TmfUiTracer.isIndexTraced()) {
 625             TmfUiTracer.traceIndex("*****************************\n"); //$NON-NLS-1$
 626         }
 627     }
 628
 629     /**
 630      * Draws the children nodes on the given context.<br>
 631      * This method start width GraphNodes ordering if needed.<br>
 632      * After, depending on the visible area, only visible GraphNodes are drawn.<br>
 633      *
 634      * @param context the context to draw to
 635      * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#draw(IGC)
 636      */
 637     protected void drawChildenNodes(IGC context) {
 638
 639         if (!fHasChilden) {
 640             return;
 641         }
 642         // If the nodes have not been added ordered, the array is ordered
 643         Iterator<String> it = fForwardSort.keySet().iterator();
 644         while (it.hasNext()) {
 645             String nodeType = it.next();
 646             boolean sort = ((Boolean) fForwardSort.get(nodeType)).booleanValue();
 647             if (sort) {
 648                 GraphNode[] temp = ((List<GraphNode>) fForwardNodes.get(nodeType)).toArray(new GraphNode[((List<GraphNode>)fForwardNodes.get(nodeType)).size()]);
 649                 GraphNode node = (GraphNode) ((List<GraphNode>) fNodes.get(nodeType)).get(0);
 650                 Arrays.sort(temp, node.getComparator());
 651                 fForwardSort.put(nodeType, Boolean.FALSE);
 652                 fNodes.put(nodeType, Arrays.asList(temp));
 653                 fForwardNodes.put(nodeType, Arrays.asList(temp));
 654                 if (TmfUiTracer.isSortingTraced()) {
 655                     TmfUiTracer.traceSorting(nodeType + " array sorted\n"); //$NON-NLS-1$
 656                 }
 657             }
 658         }
 659
 660         Iterator<String> it2 = fBackwardSort.keySet().iterator();
 661         while (it2.hasNext()) {
 662             String nodeType = it2.next();
 663             boolean sort = ((Boolean) fBackwardSort.get(nodeType)).booleanValue();
 664             if (sort) {
 665                 GraphNode[] temp = ((List<GraphNode>) fBackwardNodes.get(nodeType)).toArray(new GraphNode[((List<GraphNode>) fBackwardNodes.get(nodeType)).size()]);
 666                 GraphNode node = (GraphNode) ((List<GraphNode>) fNodes.get(nodeType)).get(0);
 667                 Arrays.sort(temp, node.getBackComparator());
 668                 fBackwardSort.put(nodeType, Boolean.FALSE);
 669                 fBackwardNodes.put(nodeType, Arrays.asList(temp));
 670                 if (TmfUiTracer.isSortingTraced()) {
 671                     TmfUiTracer.traceSorting(nodeType + " back array sorted\n"); //$NON-NLS-1$
 672                 }
 673             }
 674         }
 675
 676         if (TmfUiTracer.isDisplayTraced()) {
 677             TmfUiTracer.traceDisplay("*****************************\n"); //$NON-NLS-1$
 678         }
 679
 680         int arrayStep = 1;
 681         if ((Metrics.getMessageFontHeigth() + Metrics.MESSAGES_NAME_SPACING * 2) * context.getZoom() < Metrics.MESSAGE_SIGNIFICANT_VSPACING) {
 682             arrayStep = Math.round(Metrics.MESSAGE_SIGNIFICANT_VSPACING / ((Metrics.getMessageFontHeigth() + Metrics.MESSAGES_NAME_SPACING * 2) * context.getZoom()));
 683         }
 684
 685         int count = 0;
 686         Iterator<String> it3 = fForwardSort.keySet().iterator();
 687         while (it3.hasNext()) {
 688             count = 0;
 689             Object nodeType = it3.next();
 690             GraphNode node = (GraphNode) ((List<GraphNode>) fNodes.get(nodeType)).get(0);
 691             context.setFont(SDViewPref.getInstance().getFont(node.fPrefId));
 692             int index = ((Integer) fIndexes.get(nodeType)).intValue();
 693             count = drawNodes(context, (List<GraphNode>) fNodes.get(nodeType), index, arrayStep);
 694             if (TmfUiTracer.isDisplayTraced()) {
 695                 TmfUiTracer.traceDisplay(count + " " + nodeType + " drawn, starting from index " + index + "\r\n"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
 696             }
 697         }
 698         if (TmfUiTracer.isDisplayTraced()) {
 699             TmfUiTracer.traceDisplay("*****************************\n"); //$NON-NLS-1$
 700         }
 701
 702     }
 703
 704     /**
 705      * Draw the GraphNode stored in the given list, starting at index startIndex with the given step
 706      *
 707      * @param context the context to draw to
 708      * @param list the GraphNodes list
 709      * @param startIndex the start index
 710      * @param step the step to browse the list
 711      * @return the number of GraphNodes drawn
 712      */
 713     protected int drawNodes(IGC context, List<GraphNode> list, int startIndex, int step) {
 714         if (!fHasChilden) {
 715             return 0;
 716         }
 717
 718         GraphNode last = null;
 719         int nodesCount = 0;
 720         if (list.size() < 0) {
 721             return 0;
 722         }
 723
 724         GraphNode node = (GraphNode) list.get(0);
 725         context.setFont(SDViewPref.getInstance().getFont(node.fPrefId));
 726         Comparator<GraphNode> comparator = node.getComparator();
 727         for (int i = startIndex; i < list.size(); i = i + step) {
 728             GraphNode toDraw = (GraphNode) list.get(i);
 729             if (i < list.size() - 1) {
 730                 GraphNode next = (GraphNode) list.get(i + 1);
 731                 if ((comparator != null) && (comparator.compare(toDraw, next) > 0)) {
 732                     fForwardSort.put(next.getArrayId(), Boolean.TRUE);
 733                 }
 734             }
 735             int cx = context.getContentsX();
 736             int cy = context.getContentsY();
 737             int cw = context.getVisibleWidth();
 738             int ch = context.getVisibleHeight();
 739             // The arrays should be ordered, no needs to continue for this one
 740             if (!toDraw.isVisible(cx, cy, cw, ch) && toDraw.positiveDistanceToPoint(cx + cw, cy + ch)) {
 741                 break;
 742             }
 743             // ***Common*** nodes visibility
 744             if ((!toDraw.isSameAs(last) || toDraw.isSelected()) && (toDraw.isVisible(context.getContentsX(), context.getContentsY(), context.getVisibleWidth(), context.getVisibleHeight()))) {
 745                 nodesCount++;
 746
 747                 toDraw.draw(context);
 748                 if (hasFocus()) {
 749                     toDraw.drawFocus(context);
 750                 }
 751             }
 752             last = toDraw;
 753         }
 754         return nodesCount;
 755     }
 756
 757     /**
 758      * Draws the focus within the graphical context.
 759      *
 760      * @param context
 761      *            The context
 762      */
 763     public void drawFocus(IGC context) {
 764         context.drawFocus(getX(), getY(), getWidth(), getHeight());
 765     }
 766
 767     /**
 768      * Determine if the given point (px,py) is contained in the rectangle (x,y,width,height)
 769      *
 770      * @param x the rectangle x coordinate
 771      * @param y the rectangle y coordinate
 772      * @param width the rectangle width
 773      * @param height the rectangle height
 774      * @param px the x coordinate of the point to test
 775      * @param py the y coordinate of the point to test
 776      * @return true if contained false otherwise
 777      */
 778     public static boolean contains(int x, int y, int width, int height, int px, int py) {
 779         int locX = x;
 780         int locY = y;
 781         int locWidth = width;
 782         int locHeight = height;
 783
 784         if (width < 0) {
 785             locX = locX + width;
 786             locWidth = -locWidth;
 787         }
 788
 789         if (height < 0) {
 790             locY = locY + height;
 791             locHeight = -locHeight;
 792         }
 793         return (px >= locX) && (py >= locY) && ((px - locX) <= locWidth) && ((py - locY) <= locHeight);
 794     }
 795 }