1 /**********************************************************************
2 * Copyright (c) 2005, 2008 IBM Corporation and others.
3 * Copyright (c) 2011, 2012 Ericsson.
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
11 * IBM - Initial API and implementation
12 * Bernd Hufmann - Updated for TMF
13 **********************************************************************/
14 package org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.core
;
16 import java
.util
.ArrayList
;
17 import java
.util
.List
;
19 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.drawings
.IColor
;
20 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.drawings
.IGC
;
21 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.drawings
.IImage
;
22 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.preferences
.ISDPreferences
;
25 * Lifeline is the UML2 lifeline graphical representation.<br>
26 * Each lifeline owns a set of event occurrences. An event occurrence is the base element in UML2 to set an event in a
27 * sequence diagram.<br>
28 * Event occurrence define the drawing order of graph node along a lifeline. In this lifeline implementation, event
29 * occurrences are just integer index. The event occurrences with the same value on different lifelines will correspond
30 * the same y coordinate value.
36 public class Lifeline
extends GraphNode
{
37 // ------------------------------------------------------------------------
39 // ------------------------------------------------------------------------
43 public static final String LIFELINE_TAG
= "Lifeline"; //$NON-NLS-1$
45 // ------------------------------------------------------------------------
47 // ------------------------------------------------------------------------
49 * The lifeline position in the containing frame
51 protected int indexInFrame
= 0;
53 * The frame where the lifeline is drawn
55 protected Frame frame
= null;
57 * The current event occurrence created in the lifeline
59 protected int eventOccurrence
= 0;
61 * The lifeline category.
63 protected int category
= -1;
65 * Flag whether lifeline has time information available or not
67 protected boolean hasTime
= false;
69 // ------------------------------------------------------------------------
71 // ------------------------------------------------------------------------
76 prefId
= ISDPreferences
.PREF_LIFELINE
;
79 // ------------------------------------------------------------------------
81 // ------------------------------------------------------------------------
84 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#getX()
88 return Metrics
.FRAME_H_MARGIN
+ Metrics
.LIFELINE_H_MAGIN
+ (indexInFrame
- 1) * Metrics
.swimmingLaneWidth();
93 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#getY()
97 return 2 * Metrics
.FRAME_NAME_H_MARGIN
+ Metrics
.LIFELINE_VT_MAGIN
/ 2 + Metrics
.getFrameFontHeigth() + Metrics
.getLifelineHeaderFontHeigth() + Metrics
.FRAME_V_MARGIN
+ 2 * Metrics
.LIFELINE_HEARDER_TEXT_V_MARGIN
;
102 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#getWidth()
105 public int getWidth() {
106 return Metrics
.getLifelineWidth();
111 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#getHeight()
114 public int getHeight() {
115 // Set room for two text lines
116 return Metrics
.getLifelineFontHeigth()/** 2 */
117 + 2 * Metrics
.LIFELINE_NAME_H_MARGIN
;
121 * Set the lifeline category for this lifeline.
123 * @param arrayIndex the index of the category to use
124 * @see Frame#setLifelineCategories(LifelineCategories[])
126 public void setCategory(int arrayIndex
) {
127 category
= arrayIndex
;
131 * Returns the tooltip text for the lifeline. It is the combination between the category name(if any) and the
134 * @return the tooltip text
136 public String
getToolTipText() {
138 LifelineCategories
[] categories
= frame
.getLifelineCategories();
139 if (category
< categories
.length
) {
140 return categories
[category
].getName() + " " + getName(); //$NON-NLS-1$
142 return ""; //$NON-NLS-1$
145 return ""; //$NON-NLS-1$
150 * Returns the index of the first visible Execution Occurrence in the execution occurrence array.<br>
151 * Execution Occurrences are Y ordered in this array
153 * @return the first visible Execution Occurrence
155 public int getExecOccurrenceDrawIndex() {
159 if (indexes
.get(BasicExecutionOccurrence
.EXEC_OCC_TAG
) != null) {
160 return ((Integer
) indexes
.get(BasicExecutionOccurrence
.EXEC_OCC_TAG
)).intValue();
166 * Set the frame on which this lifeline must be drawn
170 protected void setFrame(Frame parentFrame
) {
173 frame
.setHasTimeInfo(true);
175 if (frame
.getMaxEventOccurrence() < getEventOccurrence() + 1) {
176 frame
.setMaxEventOccurrence(getEventOccurrence() + 1);
181 * Returns the frame which this lifeline is drawn
185 protected Frame
getFrame() {
190 * Set the lifeline position index in the containing frame
192 * @param index the lifeline X position
194 protected void setIndex(int index
) {
195 indexInFrame
= index
;
199 * Returns the lifeline position in de the containing frame
201 * @return the X position
203 public int getIndex() {
208 * Set the lifeline event occurrence to the value given in parameter This only change the current event occurrence,
209 * greater event created on this lifeline are still valid and usable. This also need to inform the frame of the
210 * operation mostly to store in the frame the greater event found in the diagram (used to determine the frame
213 * @param eventOcc the new current event occurrence
215 public void setCurrentEventOccurrence(int eventOcc
) {
216 if ((frame
!= null) && (frame
.getMaxEventOccurrence() < eventOcc
)) {
217 frame
.setMaxEventOccurrence(eventOcc
);
219 eventOccurrence
= eventOcc
;
223 * Returns the last created event occurrence along the lifeline.
225 * @return the current event occurrence
227 public int getEventOccurrence() {
228 return eventOccurrence
;
232 * Creates a new event occurrence along the lifeline.
234 * @return the new created event occurrence
236 public int getNewEventOccurrence() {
237 setCurrentEventOccurrence(eventOccurrence
+ 1);
238 return eventOccurrence
;
242 * Adds the execution occurrence given in parameter to the lifeline.<br>
243 * A Execution occurrence is never drawn in the frame instead it is added to a lifeline
245 * @param exec the execution occurrence to add
247 public void addExecution(BasicExecutionOccurrence exec
) {
248 exec
.setLifeline(this);
250 if ((frame
!= null) && (frame
.getMaxEventOccurrence() < exec
.endEventOccurrence
)) {
251 frame
.setMaxEventOccurrence(exec
.endEventOccurrence
);
256 * Set whether lifeline has time information available or not.
257 * @param value The value to set
259 protected void setTimeInfo(boolean value
) {
261 if ((frame
!= null) && (value
== true)) {
262 frame
.setHasTimeInfo(value
);
267 * Returns true if at least one execution occurrence has time info.
269 * @return true if at least one execution occurrence has time info
271 public boolean hasTimeInfo() {
276 * Returns the list of execution occurrence on this lifeline.
278 * @return the execution occurrence list
280 public List
<GraphNode
> getExecutions() {
282 return (List
<GraphNode
>) nodes
.get(BasicExecutionOccurrence
.EXEC_OCC_TAG
);
284 return new ArrayList
<GraphNode
>();
289 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#contains(int, int)
292 public boolean contains(int _x
, int _y
) {
295 int width
= getWidth();
296 int height
= getHeight();
301 if (Frame
.contains(x
, y
, width
, height
, _x
, _y
)) {
304 if (Frame
.contains(x
+ Metrics
.getLifelineWidth() / 2 - Metrics
.EXECUTION_OCCURRENCE_WIDTH
/ 2, y
+ height
, Metrics
.EXECUTION_OCCURRENCE_WIDTH
, (Metrics
.getMessageFontHeigth() + Metrics
.getMessagesSpacing()) * frame
.getMaxEventOccurrence()
305 + Metrics
.LIFELINE_VB_MAGIN
- 4, _x
, _y
)) {
309 height
= Metrics
.getLifelineFontHeigth() + 2 * Metrics
.LIFELINE_HEARDER_TEXT_V_MARGIN
;
310 int hMargin
= (Metrics
.LIFELINE_VT_MAGIN
- height
) / 2;
313 if (frame
.getVisibleAreaY() < y
- height
- hMargin
) {
314 if (Frame
.contains(x
- Metrics
.LIFELINE_SPACING
/ 2 + 1, y
- height
- hMargin
, Metrics
.swimmingLaneWidth() - 2, height
+ 1, _x
, _y
)) {
318 if (Frame
.contains(x
- Metrics
.LIFELINE_SPACING
/ 2 + 1, frame
.getVisibleAreaY(), Metrics
.swimmingLaneWidth() - 2, height
, _x
, _y
)) {
323 if (getNodeAt(_x
, _y
) != null) {
330 * Returns the lifeline visibility for the given visible area
332 * @param vx The x coordinate of the visible area
333 * @param vy The y coordinate of the visible area
334 * @param vwidth The width of the visible area
335 * @param vheight The height of the visible area
336 * @return true if visible false otherwise
339 public boolean isVisible(int vx
, int vy
, int vwidth
, int vheight
) {
341 int width
= getWidth();
342 if (((x
>= vx
) && (x
<= vx
+ vwidth
)) || ((x
+ width
>= vx
) && (x
<= vx
))) {
349 * Draws the name within the graphical context.
351 * @param context The graphical context.
353 protected void drawName(IGC context
) {
356 int height
= Metrics
.getLifelineHeaderFontHeigth() + 2 * Metrics
.LIFELINE_HEARDER_TEXT_V_MARGIN
;
357 int hMargin
= Metrics
.LIFELINE_VT_MAGIN
/ 4;// (Metrics.LIFELINE_NAME_H_MARGIN)/2;
359 context
.setLineStyle(context
.getLineSolidStyle());
360 context
.setBackground(Frame
.getUserPref().getBackGroundColor(ISDPreferences
.PREF_LIFELINE_HEADER
));
361 context
.setForeground(Frame
.getUserPref().getForeGroundColor(ISDPreferences
.PREF_LIFELINE_HEADER
));
362 context
.setFont(Frame
.getUserPref().getFont(ISDPreferences
.PREF_LIFELINE_HEADER
));
364 if (frame
.getVisibleAreaY() < y
- height
- hMargin
) {
365 context
.fillRectangle(x
- Metrics
.LIFELINE_SPACING
/ 2 + 1, y
- height
- hMargin
, Metrics
.swimmingLaneWidth() - 2, height
);
366 context
.drawRectangle(x
- Metrics
.LIFELINE_SPACING
/ 2 + 1, y
- height
- hMargin
, Metrics
.swimmingLaneWidth() - 2, height
);
367 context
.setForeground(Frame
.getUserPref().getFontColor(ISDPreferences
.PREF_LIFELINE_HEADER
));
368 context
.drawTextTruncatedCentred(getName(), x
+ Metrics
.LIFELINE_NAME_V_MARGIN
- Metrics
.LIFELINE_SPACING
/ 2 + 1, y
- height
- hMargin
, Metrics
.swimmingLaneWidth() - 2 * Metrics
.LIFELINE_NAME_V_MARGIN
- 2, height
, true);
370 context
.fillRectangle(x
- Metrics
.LIFELINE_SPACING
/ 2 + 1, frame
.getVisibleAreaY(), Metrics
.swimmingLaneWidth() - 2, height
);
371 context
.drawRectangle(x
- Metrics
.LIFELINE_SPACING
/ 2 + 1, frame
.getVisibleAreaY(), Metrics
.swimmingLaneWidth() - 2, height
);
372 context
.setForeground(Frame
.getUserPref().getFontColor(ISDPreferences
.PREF_LIFELINE_HEADER
));
373 context
.drawTextTruncatedCentred(getName(), x
- Metrics
.LIFELINE_SPACING
/ 2 + Metrics
.LIFELINE_NAME_V_MARGIN
+ 1, frame
.getVisibleAreaY(), Metrics
.swimmingLaneWidth() - 2 * Metrics
.LIFELINE_NAME_V_MARGIN
- 2, height
, true);
379 * Force the lifeline to be drawn at the given coordinate
381 * @param context - the context to draw into
382 * @param x - the x coordinate
383 * @param y - the y coordinate
385 public void draw(IGC context
, int x
, int y
) {
386 // Set the draw color depending if the lifeline must be selected or not
387 context
.setLineWidth(Metrics
.NORMAL_LINE_WIDTH
);
389 if (Frame
.getUserPref().useGradienColor()) {
390 context
.setGradientColor(Frame
.getUserPref().getBackGroundColor(ISDPreferences
.PREF_LIFELINE
));
392 context
.setBackground(Frame
.getUserPref().getBackGroundColorSelection());
393 context
.setForeground(Frame
.getUserPref().getForeGroundColorSelection());
395 if (Frame
.getUserPref().useGradienColor()) {
396 context
.setGradientColor(Frame
.getUserPref().getBackGroundColor(ISDPreferences
.PREF_LIFELINE
));
397 context
.setBackground(Frame
.getUserPref().getBackGroundColor(ISDPreferences
.PREF_FRAME
));
399 context
.setBackground(Frame
.getUserPref().getBackGroundColor(ISDPreferences
.PREF_LIFELINE
));
401 context
.setForeground(Frame
.getUserPref().getForeGroundColor(ISDPreferences
.PREF_LIFELINE
));
403 // Store the lifeline coordinates to save some calls
404 int width
= getWidth();
405 int height
= getHeight();
407 // Draw the rectangle which contain the lifeline name
408 if (Frame
.getUserPref().useGradienColor()) {
409 context
.fillGradientRectangle(x
, y
, width
, height
/ 2 - 7, true);
410 context
.fillRectangle(x
, y
+ height
/ 2 - 8, width
, +height
/ 2 - 5);
411 context
.fillGradientRectangle(x
, y
+ height
, width
, -height
/ 2 + 6, true);
413 context
.fillRectangle(x
, y
, width
, height
);
415 context
.drawRectangle(x
, y
, width
, height
);
418 LifelineCategories
[] categories
= frame
.getLifelineCategories();
419 if (category
< categories
.length
) {
420 IImage image
= categories
[category
].getImage();
422 context
.drawImage(image
, x
, y
, width
, height
);
427 // Draw the lifeline label into the rectangle
428 // The label is truncated if it cannot fit
429 IColor temp
= context
.getForeground();
430 context
.setFont(Frame
.getUserPref().getFont(ISDPreferences
.PREF_LIFELINE
));
431 context
.setForeground(Frame
.getUserPref().getFontColor(ISDPreferences
.PREF_LIFELINE
));
432 context
.drawTextTruncatedCentred(getName(), x
+ Metrics
.LIFELINE_NAME_V_MARGIN
, y
, Metrics
.getLifelineWidth() - 2 * Metrics
.LIFELINE_NAME_V_MARGIN
, height
, true);
434 context
.setLineStyle(context
.getLineDashStyle());
435 context
.setForeground(temp
);
436 int oldStyle
= context
.getLineStyle();
438 // Now draw the lifeline vertical line
439 // this line height depends on a stop assignment
440 // if there is no stop the line is drawn to the bottom of the frame
442 // by default set the height to reach the frame bottom
443 int dashedLineEnd
= y
+ height
+ (Metrics
.getMessageFontHeigth() + Metrics
.getMessagesSpacing()) * frame
.getMaxEventOccurrence() + Metrics
.LIFELINE_VB_MAGIN
;
445 * if (stop != null) { dashedLineEnd = stop.getY(); }
449 context
.setForeground(Frame
.getUserPref().getBackGroundColorSelection());
450 context
.setLineWidth(5);
451 context
.drawLine(x
+ Metrics
.getLifelineWidth() / 2, y
+ height
, x
+ Metrics
.getLifelineWidth() / 2, dashedLineEnd
- 4);
452 context
.setForeground(Frame
.getUserPref().getForeGroundColorSelection());
455 context
.setLineWidth(Metrics
.NORMAL_LINE_WIDTH
);
456 context
.drawLine(x
+ Metrics
.getLifelineWidth() / 2, y
+ height
, x
+ Metrics
.getLifelineWidth() / 2, dashedLineEnd
- 4);
457 context
.drawLine(x
+ Metrics
.getLifelineWidth() / 2, y
+ height
, x
+ Metrics
.getLifelineWidth() / 2, dashedLineEnd
- 4);
458 context
.setLineStyle(oldStyle
);
460 context
.setLineStyle(context
.getLineSolidStyle());
466 super.drawChildenNodes(context
);
470 * Draws the select execution occurrence region using the given color
472 * @param context the graphical context
473 * @param startEvent the region start
474 * @param nbEvent the region height
475 * @param color the color to use
477 public void highlightExecOccurrenceRegion(IGC context
, int startEvent
, int nbEvent
, IColor color
) {
478 IColor backupColor
= context
.getBackground();
479 context
.setBackground(color
);
480 int x
= getX() + Metrics
.getLifelineWidth() / 2 - Metrics
.EXECUTION_OCCURRENCE_WIDTH
/ 2;
481 int y
= getY() + getHeight() + (Metrics
.getMessageFontHeigth() + Metrics
.getMessagesSpacing()) * startEvent
;
482 int width
= Metrics
.EXECUTION_OCCURRENCE_WIDTH
;
483 int height
= ((Metrics
.getMessageFontHeigth() + Metrics
.getMessagesSpacing())) * nbEvent
;
484 context
.fillRectangle(x
, y
, width
, height
);
485 context
.setBackground(backupColor
);
490 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#draw(org.eclipse.linuxtools.tmf.ui.views.uml2sd.drawings.IGC)
493 public void draw(IGC context
) {
494 draw(context
, getX(), getY());
499 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#getArrayId()
502 public String
getArrayId() {
508 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#positiveDistanceToPoint(int, int)
511 public boolean positiveDistanceToPoint(int x
, int y
) {
512 if (getX() > x
- Metrics
.swimmingLaneWidth())
519 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#getNodeAt(int, int)
522 public GraphNode
getNodeAt(int x
, int y
) {
525 if (getFrame() != null) {
526 vy
= getFrame().getVisibleAreaY();
527 vh
= getFrame().getVisibleAreaHeight();
531 if (getExecutions() == null) {
534 for (int i
= getExecOccurrenceDrawIndex(); i
< getExecutions().size(); i
++) {
535 GraphNode node
= (GraphNode
) getExecutions().get(i
);
536 if (node
.getHeight() < 0) {
537 if (node
.getY() + node
.getHeight() > vy
+ vh
) {
541 if (node
.getY() > vy
+ vh
) {
545 if (node
.contains(x
, y
)) {
546 GraphNode internal
= node
.getNodeAt(x
, y
);
547 if (internal
!= null) {