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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/*******************************************************************************
* Copyright (c) 2007, 2011 Dakshinamurthy Karra, IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Dakshinamurthy Karra (Jalian Systems) - Templates View - https://bugs.eclipse.org/bugs/show_bug.cgi?id=69581
* Piotr Maj <pm@jcake.com> - no access to template store and current selection - https://bugs.eclipse.org/bugs/show_bug.cgi?id=296439
*******************************************************************************/
package org.eclipse.ui.texteditor.templates;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.Platform;
import org.eclipse.jface.text.templates.persistence.TemplatePersistenceData;
import org.eclipse.jface.text.templates.persistence.TemplateStore;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.part.IPage;
import org.eclipse.ui.part.MessagePage;
import org.eclipse.ui.part.PageBook;
import org.eclipse.ui.part.PageBookView;
import org.eclipse.ui.texteditor.IAbstractTextEditorHelpContextIds;
/**
* The Templates view.hosts {@link ITemplatesPage}s that shows the templates for
* the currently active editor part.
* <p>
* When this view notices an editor being activated, it uses the Eclipse adapter
* mechanism to get its {@link ITemplatesPage}. Hence, editors that want to
* provide a templates page need to provide such an adapter:
* </p>
*
* <pre>
* Object getAdapter() {
* ...
* if (ITemplatesPage.class.equals(required)) {
* if (fTemplatesPage == null)
* fTemplatesPage= new JavaTemplatesPage(this);
* return fTemplatesPage;
* }
* }
* ...
* }
* </pre>
* <p>
* <strong>Note:</strong> This plug-in does not contribute this view. Clients
* that want to use this view must check whether it is available and if not,
* contribute this view via extension point using the specified view Id
* {@link #ID}:
* </p>
*
* <pre>
* <extension
* point="org.eclipse.ui.views">
* <view
* name="%templatesViewName"
* icon="$nl$/icons/full/eview16/templates.png"
* category="org.eclipse.ui"
* class="org.eclipse.ui.texteditor.templates.TemplatesView"
* id="org.eclipse.ui.texteditor.TemplatesView">
* </view>
* </extension>
* </pre>
*
* The <code>templates.png</code> icon can be copied from this plug-in.
* <p>
* If the editor supports a templates page, the editor instantiates and
* configures the page, and returns it. This page is then added to this
* Templates view and immediately made the current page (the Templates view
* needs not to be visible). If the editor does not support a templates page,
* the Templates view shows a special default page which makes it clear to the
* user that no templates are available. When the Templates view notices a
* different editor being activated, it flips to the editor's corresponding
* templates page. When the templates view notices an editor being closed, it
* may destroy the editor's corresponding templates page.
* </p>
* <p>
* This class is not intended to be instantiated or subclassed by clients.
* </p>
*
* @since 3.4
* @noinstantiate This class is not intended to be instantiated by clients.
*/
public final class TemplatesView extends PageBookView {
/**
* The id for this view.
* <p>
* <strong>Note:</strong> Only this id is allowed when contributing
* this view via extension point.</p>
*/
public static final String ID= "org.eclipse.ui.texteditor.TemplatesView"; //$NON-NLS-1$
/**
* Creates a templates view.
*/
public TemplatesView() {
}
@Override
protected IPage createDefaultPage(PageBook book) {
MessagePage page= new MessagePage();
initPage(page);
page.createControl(book);
page.setMessage(TemplatesMessages.TemplatesView_no_templates);
return page;
}
@Override
public void createPartControl(Composite parent) {
super.createPartControl(parent);
Assert.isTrue(ID.equals(getViewSite().getId())); // prevent from contributing this view under a different ID
PlatformUI.getWorkbench().getHelpSystem().setHelp(getPageBook(), IAbstractTextEditorHelpContextIds.TEMPLATES_VIEW);
}
@Override
protected PageRec doCreatePage(IWorkbenchPart part) {
// Try to get template page.
ITemplatesPage page= part.getAdapter(ITemplatesPage.class);
if (page == null)
page= Platform.getAdapterManager().getAdapter(part, ITemplatesPage.class);
if (page == null)
return null; // There is no template page
initPage(page);
page.createControl(getPageBook());
return new PageRec(part, page);
}
@Override
protected void doDestroyPage(IWorkbenchPart part, PageRec rec) {
ITemplatesPage page= (ITemplatesPage)rec.page;
page.dispose();
rec.dispose();
}
@Override
protected IWorkbenchPart getBootstrapPart() {
IWorkbenchPage page= getSite().getPage();
if (page != null)
return page.getActiveEditor();
return null;
}
@Override
protected boolean isImportant(IWorkbenchPart part) {
//We only care about editors
return (part instanceof IEditorPart);
}
@Override
public void partBroughtToTop(IWorkbenchPart part) {
partActivated(part);
}
/**
* Returns the template store of the current page.
*
* @return the template store, or <code>null</code> if the current page does not provide that
* information
* @since 3.6
*/
public TemplateStore getTemplateStore() {
IPage currentPage= getCurrentPage();
if (currentPage instanceof ITemplatesPageExtension)
return ((ITemplatesPageExtension)currentPage).getTemplateStore();
return null;
}
/**
* Returns the currently selected templates.
*
* @return array of selected templates, or <code>null</code> if the current page does not
* provide that information
* @since 3.6
*/
public TemplatePersistenceData[] getSelectedTemplates() {
IPage currentPage= getCurrentPage();
if (currentPage instanceof ITemplatesPageExtension)
return ((ITemplatesPageExtension)currentPage).getSelectedTemplates();
return null;
}
}
|
