KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > update > internal > configurator > branding > IProductConstants


1 /*******************************************************************************
2  * Copyright (c) 2004, 2005 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.update.internal.configurator.branding;
12
13 /**
14  * These constants define the set of properties that the UI expects to
15  * be available via <code>IProduct.getProperty(String)</code>.
16  *
17  * @since 3.0
18  * @see org.eclipse.core.runtime.IProduct#getProperty(String)
19  */
20 public interface IProductConstants {
21     /**
22      * The application name, used to initialize the SWT Display. This
23      * value is distinct from the string displayed in the application
24      * title bar.
25      * <p>
26      * E.g., On motif, this can be used to set the name used for
27      * resource lookup.
28      * </p>
29      */
30     public static final String JavaDoc APP_NAME = "appName"; //$NON-NLS-1$
31
32     /**
33      * The text to show in an "about" dialog for this product.
34      * Products designed to run "headless" typically would not
35      * have such text.
36      */
37     public static final String JavaDoc ABOUT_TEXT = "aboutText"; //$NON-NLS-1$
38
39     /**
40      * An image which can be shown in an "about" dialog for this
41      * product. Products designed to run "headless" typically would not
42      * have such an image.
43      * <p>
44      * A full-sized product image (no larger than 500x330 pixels) is
45      * shown without the "aboutText" blurb. A half-sized product image
46      * (no larger than 250x330 pixels) is shown with the "aboutText"
47      * blurb beside it.
48      */
49     public static final String JavaDoc ABOUT_IMAGE = "aboutImage"; //$NON-NLS-1$
50
51     /**
52      * An image to be used as the window icon for this product (16x16).
53      * Products designed to run "headless" typically would not have such an image.
54      * <p>
55      * If the <code>WINDOW_IMAGES</code> property is given, then it supercedes
56      * this one.
57      * </p>
58      */
59     public static final String JavaDoc WINDOW_IMAGE = "windowImage"; //$NON-NLS-1$
60
61     /**
62      * An array of one or more images to be used for this product. The
63      * expectation is that the array will contain the same image rendered
64      * at different sizes (16x16 and 32x32).
65      * Products designed to run "headless" typically would not have such images.
66      * <p>
67      * If this property is given, then it supercedes <code>WINDOW_IMAGE</code>.
68      * </p>
69      */
70     public static final String JavaDoc WINDOW_IMAGES = "windowImages"; //$NON-NLS-1$
71 /**
72      * A URL for the products's welcome page (special XML-based format)
73      * ($nl$/ prefix to permit locale-specific translations of entire file).
74      * Products designed to run "headless" typically would not have such a page.
75      */
76     public static final String JavaDoc WELCOME_PAGE = "welcomePage"; //$NON-NLS-1$
77 }
78
Popular Tags