Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 67c2f3c3d718652f9ecc8794ef663db382e0c0e1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/*****************************************************************************
 * Copyright (c) 2010 CEA LIST.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *  Camille Letavernier (CEA LIST) camille.letavernier@cea.fr - Initial API and implementation
 *****************************************************************************/
package org.eclipse.papyrus.infra.widgets.editors;

import org.eclipse.swt.widgets.Composite;

/**
 * An interface for defining widgets that can return
 * some values.
 *
 * @author Camille Letavernier
 *
 */
public interface IElementSelector {

	/**
	 *
	 * @return The currently selected elements
	 */
	public Object[] getSelectedElements();

	/**
	 * Sets the elements that have already been chosen.
	 *
	 * @param elements
	 */
	public void setSelectedElements(Object[] elements);

	/**
	 *
	 * @return all displayed elements. If the widget uses a filter,
	 *         only the filtered elements should be returned
	 */
	public Object[] getAllElements();

	/**
	 * Creates the widgets to display this selector
	 *
	 * @param parent
	 */
	public void createControls(Composite parent);

	/**
	 * Handles the "newObjectCreated" event
	 *
	 * @param newObject
	 *            The object that has been created
	 */
	public void newObjectCreated(Object newObject);

	/**
	 * Clears this selector. Removes all temporary elements that
	 * may have been created.
	 */
	public void clearTemporaryElements();

	/**
	 * Adds a new listener to this selector.
	 * The selector can inform the listener that new elements have
	 * been selected
	 *
	 * @param listener
	 */
	public void addElementSelectionListener(IElementSelectionListener listener);

	/**
	 * Removes the element selection listener
	 *
	 * @param listener
	 *
	 * @see {@link #addElementSelectionListener(IElementSelectionListener)}
	 */
	public void removeElementSelectionListener(IElementSelectionListener listener);

}

Back to the top