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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/*******************************************************************************
* Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.team.internal.ccvs.ui;
import org.eclipse.core.resources.IStorage;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.Path;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.team.core.TeamException;
import org.eclipse.team.core.variants.IResourceVariant;
import org.eclipse.team.internal.ccvs.core.ICVSRemoteFile;
import org.eclipse.team.internal.ccvs.core.ICVSRepositoryLocation;
import org.eclipse.ui.IPersistableElement;
import org.eclipse.ui.IStorageEditorInput;
import org.eclipse.ui.model.IWorkbenchAdapter;
/**
* An editor input for a file in a repository.
*/
public class RemoteFileEditorInput implements IWorkbenchAdapter, IStorageEditorInput {
ICVSRemoteFile file;
IStorage storage;
/**
* Creates FileEditionEditorInput on the given file.
*/
public RemoteFileEditorInput(ICVSRemoteFile file, IProgressMonitor monitor) {
this.file = file;
try {
initializeStorage(file, monitor);
} catch (TeamException e) {
// Log and continue
CVSUIPlugin.log(e);
}
}
/**
* Initialize the strogae of this instance from the given file.
* @param file the file being displayed
* @param monitor a progress monitor
*/
protected void initializeStorage(ICVSRemoteFile file, IProgressMonitor monitor) throws TeamException {
// Cache the contents of the file for use in the editor
storage = ((IResourceVariant)file).getStorage(monitor);
}
/**
* Returns whether the editor input exists.
* <p>
* This method is primarily used to determine if an editor input should
* appear in the "File Most Recently Used" menu. An editor input will appear
* in the list until the return value of <code>exists</code> becomes
* <code>false</code> or it drops off the bottom of the list.
*
* @return <code>true</code> if the editor input exists; <code>false</code>
* otherwise
*/
public boolean exists() {
return true;
}
public boolean equals(Object o) {
if (!(o instanceof RemoteFileEditorInput)) return false;
RemoteFileEditorInput input = (RemoteFileEditorInput)o;
return file.equals(input.file);
}
/**
* Returns an object which is an instance of the given class
* associated with this object. Returns <code>null</code> if
* no such object can be found.
*
* @param adapter the adapter class to look up
* @return a object castable to the given class,
* or <code>null</code> if this object does not
* have an adapter for the given class
*/
public Object getAdapter(Class adapter) {
if (adapter == IWorkbenchAdapter.class) {
return this;
}
return null;
}
/**
* Returns the children of this object. When this object
* is displayed in a tree, the returned objects will be this
* element's children. Returns an empty array if this
* object has no children.
*
* @param object The object to get the children for.
*/
public Object[] getChildren(Object o) {
return new Object[0];
}
/**
* Returns the content type of the input. For instance, if the input
* wraps an <code>IFile</code> the content type would be derived from
* the extension or mime type. If the input wraps another object it
* may just be the object type. The content type is used for
* editor mapping.
*/
public String getContentType() {
String name = file.getName();
return name.substring(name.lastIndexOf('.')+1);
}
/**
* Returns the fully qualified path name of the input.
*/
public String getFullPath() {
//use path to make sure slashes are correct
ICVSRepositoryLocation location = file.getRepository();
IPath path = new Path(location.getRootDirectory());
path = path.setDevice(location.getHost() + Path.DEVICE_SEPARATOR);
path = path.append(file.getRepositoryRelativePath());
String fullPath;
try {
String revision = file.getRevision();
fullPath = Policy.bind("RemoteFileEditorInput.fullPathAndRevision", path.toString(), revision); //$NON-NLS-1$
} catch (TeamException e) {
CVSUIPlugin.log(e);
fullPath = path.toString();
}
return fullPath;
}
/**
* Returns the image descriptor for this input.
*
* @return the image descriptor for this input
*/
public ImageDescriptor getImageDescriptor() {
IWorkbenchAdapter fileAdapter = (IWorkbenchAdapter)file.getAdapter(IWorkbenchAdapter.class);
return fileAdapter == null ? null : fileAdapter.getImageDescriptor(file);
}
/**
* @see IWorkbenchAdapter#getImageDescriptor
*/
public ImageDescriptor getImageDescriptor(Object object) {
IWorkbenchAdapter fileAdapter = (IWorkbenchAdapter)file.getAdapter(IWorkbenchAdapter.class);
return fileAdapter == null ? null : fileAdapter.getImageDescriptor(file);
}
/**
* @see IWorkbenchAdapter#getLabel
*/
public String getLabel(Object o) {
return file.getName();
}
/**
* Returns the input name for display purposes. For instance, if
* the fully qualified input name is "a\b\MyFile.gif" the return value for
* <code>getName</code> is "MyFile.gif".
*/
public String getName() {
String name = file.getName();
try {
return Policy.bind("nameAndRevision", name, file.getRevision()); //$NON-NLS-1$
} catch (TeamException e) {
return name;
}
}
/**
* Returns the logical parent of the given object in its tree.
* Returns <code>null</code> if there is no parent, or if this object doesn't
* belong to a tree.
*
* @param object The object to get the parent for.
*/
public Object getParent(Object o) {
return null;
}
/*
* Returns an interface used to persist the object. If the editor input
* cannot be persisted this method returns <code>null</code>.
*/
public IPersistableElement getPersistable() {
//not persistable
return null;
}
/**
* Returns the underlying IStorage object.
*
* @return an IStorage object.
* @exception CoreException if this method fails
*/
public IStorage getStorage() throws CoreException {
if (storage == null) {
initializeStorage(file, new NullProgressMonitor());
}
return storage;
}
/**
* Returns the tool tip text for this editor input. This text
* is used to differentiate between two input with the same name.
* For instance, MyClass.java in folder X and MyClass.java in folder Y.
* <p>
* The format of the path will vary with each input type. For instance,
* if the editor input is of type <code>IFileEditorInput</code> this method
* should return the fully qualified resource path. For editor input of
* other types it may be different.
* </p>
* @return the tool tip text
*/
public String getToolTipText() {
return getFullPath();
}
/**
* Returns the remote CVS file shown in this editor input.
* @return the remote file handle.
*/
public ICVSRemoteFile getCVSRemoteFile() {
return file;
}
}
|
