01: /*******************************************************************************
02: * Copyright (c) 2004, 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.ui.internal.intro;
11:
12: import org.eclipse.core.runtime.CoreException;
13: import org.eclipse.jface.resource.ImageDescriptor;
14: import org.eclipse.ui.intro.IIntroPart;
15:
16: /**
17: * Describes an introduction extension.
18: *
19: * @since 3.0
20: */
21: public interface IIntroDescriptor {
22:
23: /**
24: * Creates an instance of the intro part defined in the descriptor.
25: */
26: IIntroPart createIntro() throws CoreException;
27:
28: /**
29: * Returns the part id.
30: *
31: * @return the id of the part
32: */
33: public String getId();
34:
35: /**
36: * Returns the descriptor of the image for this part.
37: *
38: * @return the descriptor of the image to display next to this part
39: */
40: public ImageDescriptor getImageDescriptor();
41:
42: /**
43: * Return the label override string for this part.
44: *
45: * @return the label override string or <code>null</code> if one has not
46: * been specified
47: * @since 3.2
48: */
49: public String getLabelOverride();
50: }
|