blob: 1ae6b592b8cce72b08c7b1fcd547e2698bd745ca (
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
|
/*****************************************************************************
* Copyright (c) 2009 - 2015 CEA LIST & LIFL
*
* 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:
* Cedric Dumoulin Cedric.dumoulin@lifl.fr - Initial API and implementation
* Camille Letavernier (CEA LIST) - camille.letavernier@cea.fr - Bug 476625
*****************************************************************************/
package org.eclipse.papyrus.infra.core.sasheditor.di.contentprovider;
import java.util.Collections;
import java.util.Map;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.papyrus.infra.core.sasheditor.contentprovider.IPageManager;
import org.eclipse.papyrus.infra.core.sasheditor.contentprovider.IPageModel;
/**
* Factory used to create IPageModel from an object identifying a page.
* IPageModel are objects used by the Sash Windows to create a page.
*
* @author cedric dumoulin
*/
public interface IPageModelFactory {
/**
* Generic EditorID that represents the default editor associated to any page identifier
*/
String DEFAULT_EDITOR = IPageManager.class.getCanonicalName() + ".Default";
/**
* Create the IPageModel for the pageIdentifier. The pageIdentifier is the object passed to
* the {@link IPageManager#addEditor(EObject)}.
* This factory method is called by the Sash Windows whenever it needs to create a page. The identifier
* is found in the sash model.
*
* @param pageIdentifier
* The identifier identifying the page to create.
* @return
*/
public IPageModel createIPageModel(Object pageIdentifier);
/**
* @see org.eclipse.papyrus.infra.core.sasheditor.di.contentprovider.IPageModelFactory#createIPageModel(java.lang.Object)
*
* @param pageIdentifier
* @return
*/
default IPageModel createIPageModel(Object pageIdentifier, String favoriteEditorID) {
return createIPageModel(pageIdentifier);
}
/**
* Finds the EditorIDs that can open the given pageIdentifier. This list is a hint
*
* The exact behavior is implementation-specific; this method shouldn't be used
* to determine whether a page identifier can actually be opened.
*
* Implementations may return a list containing the {@link IPageManager#DEFAULT_EDITOR} ID,
* and the list might be incomplete (i.e. editors not listed might
* still be able to open the given pageIdentifier)
*
* @param pageIdentifier
* @return A map of (ID -> Label) of the editors that can open the given page
*
* @see {@link IPageManager#DEFAULT_EDITOR}
*/
default Map<String, String> getEditorIDsFor(Object pageIdentifier) {
return Collections.singletonMap(DEFAULT_EDITOR, "Default editor");
}
}
|
