1 /**********************************************************************
2 * Copyright (c) 2005, 2014 IBM Corporation, Ericsson
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Eclipse Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/epl-v10.html
9 * IBM - Initial API and implementation
10 * Bernd Hufmann - Updated for TMF
11 **********************************************************************/
13 package org
.eclipse
.tracecompass
.tmf
.ui
.views
.uml2sd
.core
;
15 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.uml2sd
.drawings
.IGC
;
16 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.uml2sd
.preferences
.ISDPreferences
;
17 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.uml2sd
.preferences
.SDViewPref
;
20 * The message return graph node implementation.<br>
21 * This class differs on the AsynMessage class only on the drawing line style (dashed instead of plain line).<br>
22 * Message return are generally associated to a message. This means, they are connected to the same lifelines than the
23 * associated message but in the opposite direction and for a different event occurrence.<br>
25 * WARNING: The association validity is not checked, it is not necessary to provide a valid association, not even needed
26 * to set an association to drawn a message with a message return style.<br>
29 * @see org.eclipse.tracecompass.tmf.ui.views.uml2sd.core.AsyncMessage AsyncMessage for usage example
34 public class AsyncMessageReturn
extends AsyncMessage
{
36 // ------------------------------------------------------------------------
38 // ------------------------------------------------------------------------
40 * The grahNode ID constant
42 public static final String ASYNC_MESS_RET_TAG
= "AsyncMessageRet"; //$NON-NLS-1$
44 // ------------------------------------------------------------------------
46 // ------------------------------------------------------------------------
48 * The corresponding asynchronous message.
50 protected AsyncMessage fMessage
;
52 // ------------------------------------------------------------------------
54 // ------------------------------------------------------------------------
56 * Default constructor.
58 public AsyncMessageReturn() {
59 setColorPrefId(ISDPreferences
.PREF_ASYNC_MESS_RET
);
62 // ------------------------------------------------------------------------
64 // ------------------------------------------------------------------------
67 * Set the associated message (the message it is the return).<br>
68 * Setting the association will activate the navigation in the default sequence diagram implementation to the
69 * message when the user right click on this message return.<br>
71 * @param parentMessage the message to associate
73 public void setMessage(AsyncMessage parentMessage
) {
74 fMessage
= parentMessage
;
78 * Returns the associated message (the message it is the return).<br>
80 * @return parentMessage the message to associate
82 public AsyncMessage
getMessage() {
87 public void draw(IGC context
) {
92 ISDPreferences pref
= SDViewPref
.getInstance();
94 setColorPrefId(ISDPreferences
.PREF_ASYNC_MESS_RET
);
95 int oldStyle
= context
.getLineStyle();
96 // Message return are dashed
97 context
.setLineStyle(context
.getLineDotStyle());
99 context
.setBackground(pref
.getBackGroundColor(getColorPrefId()));
100 context
.setForeground(pref
.getForeGroundColor(getColorPrefId()));
103 // restore the context
104 context
.setLineStyle(oldStyle
);
108 public String
getArrayId() {
109 return ASYNC_MESS_RET_TAG
;