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
;
23 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.uml2sd
.preferences
.SDViewPref
;
26 * Lifeline is the UML2 lifeline graphical representation.<br>
27 * Each lifeline owns a set of event occurrences. An event occurrence is the base element in UML2 to set an event in a
28 * sequence diagram.<br>
29 * Event occurrence define the drawing order of graph node along a lifeline. In this lifeline implementation, event
30 * occurrences are just integer index. The event occurrences with the same value on different lifelines will correspond
31 * the same y coordinate value.
37 public class Lifeline
extends GraphNode
{
38 // ------------------------------------------------------------------------
40 // ------------------------------------------------------------------------
44 public static final String LIFELINE_TAG
= "Lifeline"; //$NON-NLS-1$
46 // ------------------------------------------------------------------------
48 // ------------------------------------------------------------------------
50 * The lifeline position in the containing frame
52 protected int fIndexInFrame
= 0;
54 * The frame where the lifeline is drawn
56 protected Frame fFrame
= null;
58 * The current event occurrence created in the lifeline
60 protected int fEventOccurrence
= 0;
62 * The lifeline category.
64 protected int fCategory
= -1;
66 * Flag whether lifeline has time information available or not
68 protected boolean fHasTimeInfo
= false;
70 // ------------------------------------------------------------------------
72 // ------------------------------------------------------------------------
77 fPrefId
= ISDPreferences
.PREF_LIFELINE
;
80 // ------------------------------------------------------------------------
82 // ------------------------------------------------------------------------
85 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#getX()
89 return Metrics
.FRAME_H_MARGIN
+ Metrics
.LIFELINE_H_MAGIN
+ (fIndexInFrame
- 1) * Metrics
.swimmingLaneWidth();
94 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#getY()
98 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
;
103 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#getWidth()
106 public int getWidth() {
107 return Metrics
.getLifelineWidth();
112 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#getHeight()
115 public int getHeight() {
116 // Set room for two text lines
117 return Metrics
.getLifelineFontHeigth()/** 2 */
118 + 2 * Metrics
.LIFELINE_NAME_H_MARGIN
;
122 * Set the lifeline category for this lifeline.
124 * @param arrayIndex the index of the category to use
125 * @see Frame#setLifelineCategories(LifelineCategories[])
127 public void setCategory(int arrayIndex
) {
128 fCategory
= arrayIndex
;
132 * Returns the tooltip text for the lifeline. It is the combination between the category name(if any) and the
135 * @return the tooltip text
137 public String
getToolTipText() {
138 if (fCategory
>= 0) {
139 LifelineCategories
[] categories
= fFrame
.getLifelineCategories();
140 if (fCategory
< categories
.length
) {
141 return categories
[fCategory
].getName() + " " + getName(); //$NON-NLS-1$
144 return ""; //$NON-NLS-1$
148 * Returns the index of the first visible Execution Occurrence in the execution occurrence array.<br>
149 * Execution Occurrences are Y ordered in this array
151 * @return the first visible Execution Occurrence
153 public int getExecOccurrenceDrawIndex() {
157 if (fIndexes
.get(BasicExecutionOccurrence
.EXEC_OCC_TAG
) != null) {
158 return fIndexes
.get(BasicExecutionOccurrence
.EXEC_OCC_TAG
).intValue();
164 * Set the frame on which this lifeline must be drawn
169 protected void setFrame(Frame parentFrame
) {
170 fFrame
= parentFrame
;
172 fFrame
.setHasTimeInfo(true);
174 if (fFrame
.getMaxEventOccurrence() < getEventOccurrence() + 1) {
175 fFrame
.setMaxEventOccurrence(getEventOccurrence() + 1);
180 * Returns the frame which this lifeline is drawn
184 protected Frame
getFrame() {
189 * Set the lifeline position index in the containing frame
191 * @param index the lifeline X position
193 protected void setIndex(int index
) {
194 fIndexInFrame
= index
;
198 * Returns the lifeline position in de the containing frame
200 * @return the X position
202 public int getIndex() {
203 return fIndexInFrame
;
207 * Set the lifeline event occurrence to the value given in parameter This only change the current event occurrence,
208 * greater event created on this lifeline are still valid and usable. This also need to inform the frame of the
209 * operation mostly to store in the frame the greater event found in the diagram (used to determine the frame
212 * @param eventOcc the new current event occurrence
214 public void setCurrentEventOccurrence(int eventOcc
) {
215 if ((fFrame
!= null) && (fFrame
.getMaxEventOccurrence() < eventOcc
)) {
216 fFrame
.setMaxEventOccurrence(eventOcc
);
218 fEventOccurrence
= eventOcc
;
222 * Returns the last created event occurrence along the lifeline.
224 * @return the current event occurrence
226 public int getEventOccurrence() {
227 return fEventOccurrence
;
231 * Creates a new event occurrence along the lifeline.
233 * @return the new created event occurrence
235 public int getNewEventOccurrence() {
236 setCurrentEventOccurrence(fEventOccurrence
+ 1);
237 return fEventOccurrence
;
241 * Adds the execution occurrence given in parameter to the lifeline.<br>
242 * A Execution occurrence is never drawn in the frame instead it is added to a lifeline
244 * @param exec the execution occurrence to add
246 public void addExecution(BasicExecutionOccurrence exec
) {
247 exec
.setLifeline(this);
249 if ((fFrame
!= null) && (fFrame
.getMaxEventOccurrence() < exec
.fEndEventOccurrence
)) {
250 fFrame
.setMaxEventOccurrence(exec
.fEndEventOccurrence
);
255 * Set whether lifeline has time information available or not.
256 * @param value The value to set
258 protected void setTimeInfo(boolean value
) {
259 fHasTimeInfo
= value
;
260 if ((fFrame
!= null) && value
) {
261 fFrame
.setHasTimeInfo(value
);
266 * Returns true if at least one execution occurrence has time info.
268 * @return true if at least one execution occurrence has time info
270 public boolean hasTimeInfo() {
275 * Returns the list of execution occurrence on this lifeline.
277 * @return the execution occurrence list
279 public List
<GraphNode
> getExecutions() {
281 return fNodes
.get(BasicExecutionOccurrence
.EXEC_OCC_TAG
);
283 return new ArrayList
<GraphNode
>();
288 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#contains(int, int)
291 public boolean contains(int xValue
, int yValue
) {
294 int width
= getWidth();
295 int height
= getHeight();
297 if (fFrame
== null) {
300 if (GraphNode
.contains(x
, y
, width
, height
, xValue
, yValue
)) {
303 if (GraphNode
.contains(x
+ Metrics
.getLifelineWidth() / 2 - Metrics
.EXECUTION_OCCURRENCE_WIDTH
/ 2, y
+ height
, Metrics
.EXECUTION_OCCURRENCE_WIDTH
, (Metrics
.getMessageFontHeigth() + Metrics
.getMessagesSpacing()) * fFrame
.getMaxEventOccurrence()
304 + Metrics
.LIFELINE_VB_MAGIN
- 4, xValue
, yValue
)) {
308 height
= Metrics
.getLifelineFontHeigth() + 2 * Metrics
.LIFELINE_HEARDER_TEXT_V_MARGIN
;
309 int hMargin
= (Metrics
.LIFELINE_VT_MAGIN
- height
) / 2;
312 if (fFrame
.getVisibleAreaY() < y
- height
- hMargin
) {
313 if (GraphNode
.contains(x
- Metrics
.LIFELINE_SPACING
/ 2 + 1, y
- height
- hMargin
, Metrics
.swimmingLaneWidth() - 2, height
+ 1, xValue
, yValue
)) {
317 if (GraphNode
.contains(x
- Metrics
.LIFELINE_SPACING
/ 2 + 1, fFrame
.getVisibleAreaY(), Metrics
.swimmingLaneWidth() - 2, height
, xValue
, yValue
)) {
322 if (getNodeAt(xValue
, yValue
) != null) {
329 * Returns the lifeline visibility for the given visible area
331 * @param vx The x coordinate of the visible area
332 * @param vy The y coordinate of the visible area
333 * @param vwidth The width of the visible area
334 * @param vheight The height of the visible area
335 * @return true if visible false otherwise
338 public boolean isVisible(int vx
, int vy
, int vwidth
, int vheight
) {
340 int width
= getWidth();
341 if (((x
>= vx
) && (x
<= vx
+ vwidth
)) || ((x
+ width
>= vx
) && (x
<= vx
))) {
348 * Draws the name within the graphical context.
350 * @param context The graphical context.
352 protected void drawName(IGC context
) {
353 ISDPreferences pref
= SDViewPref
.getInstance();
357 int height
= Metrics
.getLifelineHeaderFontHeigth() + 2 * Metrics
.LIFELINE_HEARDER_TEXT_V_MARGIN
;
358 int hMargin
= Metrics
.LIFELINE_VT_MAGIN
/ 4;// (Metrics.LIFELINE_NAME_H_MARGIN)/2;
360 context
.setLineStyle(context
.getLineSolidStyle());
361 context
.setBackground(pref
.getBackGroundColor(ISDPreferences
.PREF_LIFELINE_HEADER
));
362 context
.setForeground(pref
.getForeGroundColor(ISDPreferences
.PREF_LIFELINE_HEADER
));
363 context
.setFont(pref
.getFont(ISDPreferences
.PREF_LIFELINE_HEADER
));
365 if (fFrame
.getVisibleAreaY() < y
- height
- hMargin
) {
366 context
.fillRectangle(x
- Metrics
.LIFELINE_SPACING
/ 2 + 1, y
- height
- hMargin
, Metrics
.swimmingLaneWidth() - 2, height
);
367 context
.drawRectangle(x
- Metrics
.LIFELINE_SPACING
/ 2 + 1, y
- height
- hMargin
, Metrics
.swimmingLaneWidth() - 2, height
);
368 context
.setForeground(pref
.getFontColor(ISDPreferences
.PREF_LIFELINE_HEADER
));
369 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);
371 context
.fillRectangle(x
- Metrics
.LIFELINE_SPACING
/ 2 + 1, fFrame
.getVisibleAreaY(), Metrics
.swimmingLaneWidth() - 2, height
);
372 context
.drawRectangle(x
- Metrics
.LIFELINE_SPACING
/ 2 + 1, fFrame
.getVisibleAreaY(), Metrics
.swimmingLaneWidth() - 2, height
);
373 context
.setForeground(pref
.getFontColor(ISDPreferences
.PREF_LIFELINE_HEADER
));
374 context
.drawTextTruncatedCentred(getName(), x
- Metrics
.LIFELINE_SPACING
/ 2 + Metrics
.LIFELINE_NAME_V_MARGIN
+ 1, fFrame
.getVisibleAreaY(), Metrics
.swimmingLaneWidth() - 2 * Metrics
.LIFELINE_NAME_V_MARGIN
- 2, height
, true);
380 * Force the lifeline to be drawn at the given coordinate
382 * @param context - the context to draw into
383 * @param x - the x coordinate
384 * @param y - the y coordinate
386 public void draw(IGC context
, int x
, int y
) {
388 ISDPreferences pref
= SDViewPref
.getInstance();
390 // Set the draw color depending if the lifeline must be selected or not
391 context
.setLineWidth(Metrics
.NORMAL_LINE_WIDTH
);
393 if (pref
.useGradienColor()) {
394 context
.setGradientColor(pref
.getBackGroundColor(ISDPreferences
.PREF_LIFELINE
));
396 context
.setBackground(pref
.getBackGroundColorSelection());
397 context
.setForeground(pref
.getForeGroundColorSelection());
399 if (pref
.useGradienColor()) {
400 context
.setGradientColor(pref
.getBackGroundColor(ISDPreferences
.PREF_LIFELINE
));
401 context
.setBackground(pref
.getBackGroundColor(ISDPreferences
.PREF_FRAME
));
403 context
.setBackground(pref
.getBackGroundColor(ISDPreferences
.PREF_LIFELINE
));
405 context
.setForeground(pref
.getForeGroundColor(ISDPreferences
.PREF_LIFELINE
));
407 // Store the lifeline coordinates to save some calls
408 int width
= getWidth();
409 int height
= getHeight();
411 // Draw the rectangle which contain the lifeline name
412 if (pref
.useGradienColor()) {
413 context
.fillGradientRectangle(x
, y
, width
, height
/ 2 - 7, true);
414 context
.fillRectangle(x
, y
+ height
/ 2 - 8, width
, +height
/ 2 - 5);
415 context
.fillGradientRectangle(x
, y
+ height
, width
, -height
/ 2 + 6, true);
417 context
.fillRectangle(x
, y
, width
, height
);
419 context
.drawRectangle(x
, y
, width
, height
);
421 if (fCategory
>= 0) {
422 LifelineCategories
[] categories
= fFrame
.getLifelineCategories();
423 if (fCategory
< categories
.length
) {
424 IImage image
= categories
[fCategory
].getImage();
426 context
.drawImage(image
, x
, y
, width
, height
);
431 // Draw the lifeline label into the rectangle
432 // The label is truncated if it cannot fit
433 IColor temp
= context
.getForeground();
434 context
.setFont(pref
.getFont(ISDPreferences
.PREF_LIFELINE
));
435 context
.setForeground(pref
.getFontColor(ISDPreferences
.PREF_LIFELINE
));
436 context
.drawTextTruncatedCentred(getName(), x
+ Metrics
.LIFELINE_NAME_V_MARGIN
, y
, Metrics
.getLifelineWidth() - 2 * Metrics
.LIFELINE_NAME_V_MARGIN
, height
, true);
438 context
.setLineStyle(context
.getLineDashStyle());
439 context
.setForeground(temp
);
440 int oldStyle
= context
.getLineStyle();
442 // Now draw the lifeline vertical line
443 // this line height depends on a stop assignment
444 // if there is no stop the line is drawn to the bottom of the frame
446 // by default set the height to reach the frame bottom
447 int dashedLineEnd
= y
+ height
+ (Metrics
.getMessageFontHeigth() + Metrics
.getMessagesSpacing()) * fFrame
.getMaxEventOccurrence() + Metrics
.LIFELINE_VB_MAGIN
;
449 * if (stop != null) { dashedLineEnd = stop.getY(); }
453 context
.setForeground(pref
.getBackGroundColorSelection());
454 context
.setLineWidth(5);
455 context
.drawLine(x
+ Metrics
.getLifelineWidth() / 2, y
+ height
, x
+ Metrics
.getLifelineWidth() / 2, dashedLineEnd
- 4);
456 context
.setForeground(pref
.getForeGroundColorSelection());
459 context
.setLineWidth(Metrics
.NORMAL_LINE_WIDTH
);
460 context
.drawLine(x
+ Metrics
.getLifelineWidth() / 2, y
+ height
, x
+ Metrics
.getLifelineWidth() / 2, dashedLineEnd
- 4);
461 context
.drawLine(x
+ Metrics
.getLifelineWidth() / 2, y
+ height
, x
+ Metrics
.getLifelineWidth() / 2, dashedLineEnd
- 4);
462 context
.setLineStyle(oldStyle
);
464 context
.setLineStyle(context
.getLineSolidStyle());
470 super.drawChildenNodes(context
);
474 * Draws the select execution occurrence region using the given color
476 * @param context the graphical context
477 * @param startEvent the region start
478 * @param nbEvent the region height
479 * @param color the color to use
481 public void highlightExecOccurrenceRegion(IGC context
, int startEvent
, int nbEvent
, IColor color
) {
482 IColor backupColor
= context
.getBackground();
483 context
.setBackground(color
);
484 int x
= getX() + Metrics
.getLifelineWidth() / 2 - Metrics
.EXECUTION_OCCURRENCE_WIDTH
/ 2;
485 int y
= getY() + getHeight() + (Metrics
.getMessageFontHeigth() + Metrics
.getMessagesSpacing()) * startEvent
;
486 int width
= Metrics
.EXECUTION_OCCURRENCE_WIDTH
;
487 int height
= ((Metrics
.getMessageFontHeigth() + Metrics
.getMessagesSpacing())) * nbEvent
;
488 context
.fillRectangle(x
, y
, width
, height
);
489 context
.setBackground(backupColor
);
494 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#draw(org.eclipse.linuxtools.tmf.ui.views.uml2sd.drawings.IGC)
497 public void draw(IGC context
) {
498 draw(context
, getX(), getY());
503 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#getArrayId()
506 public String
getArrayId() {
512 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#positiveDistanceToPoint(int, int)
515 public boolean positiveDistanceToPoint(int x
, int y
) {
516 if (getX() > x
- Metrics
.swimmingLaneWidth()) {
524 * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.GraphNode#getNodeAt(int, int)
527 public GraphNode
getNodeAt(int x
, int y
) {
530 if (getFrame() != null) {
531 vy
= getFrame().getVisibleAreaY();
532 vh
= getFrame().getVisibleAreaHeight();
536 if (getExecutions() == null) {
539 for (int i
= getExecOccurrenceDrawIndex(); i
< getExecutions().size(); i
++) {
540 GraphNode node
= getExecutions().get(i
);
541 if (node
.getHeight() < 0) {
542 if (node
.getY() + node
.getHeight() > vy
+ vh
) {
546 if (node
.getY() > vy
+ vh
) {
550 if (node
.contains(x
, y
)) {
551 GraphNode internal
= node
.getNodeAt(x
, y
);
552 if (internal
!= null) {