| 1 | /********************************************************************** |
| 2 | * Copyright (c) 2005, 2012 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 |
| 7 | * |
| 8 | * Contributors: |
| 9 | * IBM - Initial API and implementation |
| 10 | * Bernd Hufmann - Updated for TMF |
| 11 | **********************************************************************/ |
| 12 | |
| 13 | package org.eclipse.linuxtools.tmf.ui.views.uml2sd.core; |
| 14 | |
| 15 | import org.eclipse.linuxtools.tmf.ui.views.uml2sd.drawings.IGC; |
| 16 | import org.eclipse.linuxtools.tmf.ui.views.uml2sd.preferences.ISDPreferences; |
| 17 | import org.eclipse.linuxtools.tmf.ui.views.uml2sd.preferences.SDViewPref; |
| 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 |
| 30 | * @version 1.0 |
| 31 | * @author sveyrier |
| 32 | * |
| 33 | */ |
| 34 | public class SyncMessageReturn extends SyncMessage { |
| 35 | |
| 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 | // ------------------------------------------------------------------------ |
| 47 | /** |
| 48 | * The associated message(the message it is the return). |
| 49 | */ |
| 50 | protected SyncMessage fMessage = null; |
| 51 | |
| 52 | // ------------------------------------------------------------------------ |
| 53 | // Constractors |
| 54 | // ------------------------------------------------------------------------ |
| 55 | |
| 56 | /** |
| 57 | * Default constructor |
| 58 | */ |
| 59 | public SyncMessageReturn() { |
| 60 | fPrefId = ISDPreferences.PREF_SYNC_MESS_RET; |
| 61 | } |
| 62 | |
| 63 | // ------------------------------------------------------------------------ |
| 64 | // Methods |
| 65 | // ------------------------------------------------------------------------ |
| 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) { |
| 74 | fMessage = parentMessage; |
| 75 | fMessage.setMessageReturn(this); |
| 76 | } |
| 77 | |
| 78 | /** |
| 79 | * Returns the syncMessage associated to this SyncMessageReturn |
| 80 | * |
| 81 | * @return the associated message |
| 82 | */ |
| 83 | public SyncMessage getMessage() { |
| 84 | return fMessage; |
| 85 | } |
| 86 | |
| 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 | */ |
| 91 | @Override |
| 92 | public void draw(IGC context) { |
| 93 | if (!isVisible()) { |
| 94 | return; |
| 95 | } |
| 96 | |
| 97 | ISDPreferences pref = SDViewPref.getInstance(); |
| 98 | |
| 99 | int oldStyle = context.getLineStyle(); |
| 100 | // Message return are dashed |
| 101 | context.setLineStyle(context.getLineDotStyle()); |
| 102 | // Draw it selected? |
| 103 | if (!isSelected()) { |
| 104 | context.setBackground(pref.getBackGroundColor(fPrefId)); |
| 105 | context.setForeground(pref.getForeGroundColor(fPrefId)); |
| 106 | } |
| 107 | super.draw(context); |
| 108 | // restore the context |
| 109 | context.setLineStyle(oldStyle); |
| 110 | } |
| 111 | |
| 112 | /* |
| 113 | * (non-Javadoc) |
| 114 | * @see org.eclipse.linuxtools.tmf.ui.views.uml2sd.core.SyncMessage#getArrayId() |
| 115 | */ |
| 116 | @Override |
| 117 | public String getArrayId() { |
| 118 | return SYNC_MESS_RET_TAG; |
| 119 | } |
| 120 | } |