ss: Move plugins to Trace Compass namespace
[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / views / uml2sd / handlers / provider / ISDGraphNodeSupporter.java
CommitLineData
73005152 1/**********************************************************************
57a2a5ca 2 * Copyright (c) 2005, 2013 IBM Corporation, Ericsson
73005152
BH
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
a55887ca
AM
7 *
8 * Contributors:
c8422608
AM
9 * IBM - Initial API and implementation
10 * Bernd Hufmann - Updated for TMF
73005152 11 **********************************************************************/
c8422608 12
73005152
BH
13package org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider;
14
15/**
df0b8ff4 16 * Interface for providing a graph node supporter.
a55887ca 17 *
73005152
BH
18 * Sequence Diagram loaders which implement this class provide the actions for finding or filtering the sequence
19 * diagram. This interface also allow the implementor to set which action/feature are supported
a55887ca 20 *
df0b8ff4
BH
21 * Action provider are associated to a Sequence Diagram SDWidget calling <code>SDViewer.setSDFindProvider()</code> or
22 * <code>SDViewer.setSDFilterProvider()</code>.
a55887ca 23 *
df0b8ff4 24 * @version 1.0
73005152 25 * @author sveyrier
a55887ca 26 *
73005152 27 */
57a2a5ca 28public interface ISDGraphNodeSupporter {
73005152 29
df0b8ff4
BH
30 // ------------------------------------------------------------------------
31 // Constants
32 // ------------------------------------------------------------------------
33
34 /**
35 * Lifeline support ID
36 */
f26e290b 37 static int LIFELINE = 0;
df0b8ff4
BH
38 /**
39 * Synchronous message support ID
40 */
f26e290b 41 static int SYNCMESSAGE = 1;
df0b8ff4
BH
42 /**
43 * Synchronous message return support ID
44 */
f26e290b 45 static int SYNCMESSAGERETURN = 2;
df0b8ff4
BH
46 /**
47 * Asynchronous message support ID
48 */
f26e290b 49 static int ASYNCMESSAGE = 3;
df0b8ff4
BH
50 /**
51 * Asynchronous message return support ID
52 */
f26e290b 53 static int ASYNCMESSAGERETURN = 4;
df0b8ff4
BH
54 /**
55 * Stop support ID
56 */
f26e290b 57 static int STOP = 5;
73005152 58
df0b8ff4
BH
59 // ------------------------------------------------------------------------
60 // Methods
61 // ------------------------------------------------------------------------
62
73005152
BH
63 /**
64 * Return true to enable this options, false otherwise
a55887ca
AM
65 *
66 * @param nodeType
67 * The integer value matching the type of the node
73005152
BH
68 * @return true to enable this options, false otherwise
69 */
57a2a5ca 70 boolean isNodeSupported(int nodeType);
73005152
BH
71
72 /**
a55887ca
AM
73 * Return the name to use in dialogs Not called if isNodeSupported return
74 * false
75 *
76 * @param nodeType
77 * The integer value matching the type of the node
78 * @param loaderClassName
79 * The name of the loader class
73005152
BH
80 * @return the name to use in dialogs
81 */
57a2a5ca 82 String getNodeName(int nodeType, String loaderClassName);
73005152 83}
This page took 0.057997 seconds and 5 git commands to generate.