Skip to main content

This CGIT instance is deprecated, and repositories have been moved to Gitlab or Github. See the repository descriptions for specific locations.

summaryrefslogtreecommitdiffstats
blob: dc601de6e51f55af62c8b6803ad84b6cf488904c (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
/*******************************************************************************
 * Copyright (c) 2003, 2005 IBM Corporation and others.
 * 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:
 *     IBM Corporation - Initial API and implementation
 *******************************************************************************/
package org.eclipse.wst.server.ui.internal.editor;

import org.eclipse.ui.IEditorPart;

import org.eclipse.wst.server.core.IServerWorkingCopy;
/**
 *
 */
public interface IServerEditorPartFactory extends IOrdered {
	/**
	 * Returns the id.
	 * 
	 * @return the id
	 */
	public String getId();
	
	/**
	 * Return the displayable name.
	 * 
	 * @return the name
	 */
	public String getName();

	/**
	 * Returns true if the given server resource type (given by the
	 * id) can be opened with this editor. This result is based on
	 * the result of the types attribute.
	 * 
	 * @param id a server type id
	 * @return <code>true</code> if the type is supported
	 */
	public boolean supportsType(String id);

	/**
	 * Returns true if a given insertion id is supported.
	 * 
	 * @param id
	 * @return <code>true</code> if the insertion id is supported
	 */
	public boolean supportsInsertionId(String id);
	
	/**
	 * Returns true if this editor page should be visible with the given server.
	 * This allows (for instance) complex configuration pages to only be shown when used
	 * with non-unittest servers.
	 * 
	 * @param server a server
	 * @return <code>true</code> if the page should be visible
	 */
	public boolean shouldCreatePage(IServerWorkingCopy server);

	/**
	 * Create the editor page.
	 * 
	 * @return the editor page
	 */
	public IEditorPart createPage();
}

Back to the top