KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > internal > intro > IIntroDescriptor


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