Commit | Line | Data |
---|---|---|
73005152 | 1 | /********************************************************************** |
df0b8ff4 BH |
2 | * Copyright (c) 2005, 2006 IBM Corporation and others. |
3 | * Copyright (c) 2011, 2012 Ericsson. | |
4 | * | |
73005152 BH |
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 | |
73005152 BH |
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 org.eclipse.linuxtools.tmf.ui.views.uml2sd.drawings.IGC; | |
df0b8ff4 | 17 | import org.eclipse.linuxtools.tmf.ui.views.uml2sd.preferences.ISDPreferences; |
73005152 BH |
18 | |
19 | /** | |
20 | * The message return graph node implementation.<br> | |
21 | * This class differs on the SynMessage 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> | |
24 | * <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> | |
27 | * | |
28 | * | |
29 | * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.SyncMessage SyncMessage for usage example | |
df0b8ff4 | 30 | * @version 1.0 |
73005152 BH |
31 | * @author sveyrier |
32 | * | |
33 | */ | |
34 | public class SyncMessageReturn extends SyncMessage { | |
35 | ||
df0b8ff4 BH |
36 | // ------------------------------------------------------------------------ |
37 | // Constants | |
38 | // ------------------------------------------------------------------------ | |
39 | /** | |
40 | * The graphNode ID | |
41 | */ | |
42 | public static final String SYNC_MESS_RET_TAG = "SyncMessageRet"; //$NON-NLS-1$ | |
43 | ||
44 | // ------------------------------------------------------------------------ | |
45 | // Attributes | |
46 | // ------------------------------------------------------------------------ | |
73005152 BH |
47 | /** |
48 | * The associated message(the message it is the return). | |
49 | */ | |
eb63f5ff | 50 | protected SyncMessage fMessage = null; |
73005152 | 51 | |
df0b8ff4 BH |
52 | // ------------------------------------------------------------------------ |
53 | // Constractors | |
54 | // ------------------------------------------------------------------------ | |
55 | ||
56 | /** | |
57 | * Default constructor | |
58 | */ | |
73005152 | 59 | public SyncMessageReturn() { |
eb63f5ff | 60 | fPrefId = ISDPreferences.PREF_SYNC_MESS_RET; |
73005152 BH |
61 | } |
62 | ||
df0b8ff4 BH |
63 | // ------------------------------------------------------------------------ |
64 | // Methods | |
65 | // ------------------------------------------------------------------------ | |
73005152 BH |
66 | /** |
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> | |
70 | * | |
71 | * @param parentMessage the message to associate | |
72 | */ | |
73 | public void setMessage(SyncMessage parentMessage) { | |
eb63f5ff BH |
74 | fMessage = parentMessage; |
75 | fMessage.setMessageReturn(this); | |
73005152 BH |
76 | } |
77 | ||
78 | /** | |
79 | * Returns the syncMessage associated to this SyncMessageReturn | |
80 | * | |
81 | * @return the associated message | |
82 | */ | |
83 | public SyncMessage getMessage() { | |
eb63f5ff | 84 | return fMessage; |
73005152 BH |
85 | } |
86 | ||
df0b8ff4 BH |
87 | /* |
88 | * (non-Javadoc) | |
89 | * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.SyncMessage#draw(org.eclipse.linuxtools.tmf.ui.views.uml2sd.drawings.IGC) | |
90 | */ | |
73005152 BH |
91 | @Override |
92 | public void draw(IGC context) { | |
df0b8ff4 | 93 | if (!isVisible()) { |
73005152 | 94 | return; |
df0b8ff4 | 95 | } |
73005152 BH |
96 | int oldStyle = context.getLineStyle(); |
97 | // Message return are dashed | |
98 | context.setLineStyle(context.getLineDotStyle()); | |
df0b8ff4 | 99 | // Draw it selected? |
73005152 | 100 | if (!isSelected()) { |
eb63f5ff BH |
101 | context.setBackground(Frame.getUserPref().getBackGroundColor(fPrefId)); |
102 | context.setForeground(Frame.getUserPref().getForeGroundColor(fPrefId)); | |
73005152 BH |
103 | } |
104 | super.draw(context); | |
105 | // restore the context | |
106 | context.setLineStyle(oldStyle); | |
107 | } | |
108 | ||
df0b8ff4 BH |
109 | /* |
110 | * (non-Javadoc) | |
111 | * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.SyncMessage#getArrayId() | |
112 | */ | |
73005152 BH |
113 | @Override |
114 | public String getArrayId() { | |
115 | return SYNC_MESS_RET_TAG; | |
116 | } | |
117 | } |