IProductConstants


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.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 SWT application name, used to initialize the SWT Display.
23       * <p>  
24       * This value is used to refer to the application in .XDefaults
25       * files on X server based window systems such as Motif.
26       * </p>
27       * <p>
28       * To obtain a human-readable name for the product, use
29       * <code>IProduct.getName()</code>.
30       * </p>
31       * @see org.eclipse.swt.widgets.Display#setAppName
32       */
33      public static final String   APP_NAME = "appName"; //$NON-NLS-1$
34  
35      /**
36       * The text to show in an "about" dialog for this product.
37       * Products designed to run "headless" typically would not
38       * have such text.
39       */
40      public static final String   ABOUT_TEXT = "aboutText"; //$NON-NLS-1$
41  
42      /**
43       * An image which can be shown in an "about" dialog for this
44       * product. Products designed to run "headless" typically would not 
45       * have such an image.
46       * <p>
47       * The value is either a fully qualified valid URL or a path relative 
48       * to the product's defining bundle.
49       * </p> 
50       * <p>
51       * A full-sized product image (no larger than 500x330 pixels) is
52       * shown without the "aboutText" blurb.  A half-sized product image
53       * (no larger than 250x330 pixels) is shown with the "aboutText"
54       * blurb beside it.
55       * </p>
56       */
57      public static final String   ABOUT_IMAGE = "aboutImage"; //$NON-NLS-1$
58  
59      /**
60       * A file for customizing default preference
61       * values for a product. The value is interpreted as either a 
62       * URL or a bundle-relative path by the runtime. This is not referenced
63       * from the workbench.
64       * <p>
65       * The contents must be the same format as a 
66       * {@link java.util.Properties} file with the key/value pairs being:
67       * <pre>
68       * qualifier/key=value
69       * </pre>
70       * Where <code>qualifier</code> is typically the bundle id.
71       * </p>
72       */
73      public static final String   PREFERENCE_CUSTOMIZATION = "preferenceCustomization"; //$NON-NLS-1$
74  
75      /**
76       * An image to be used as the window icon for this product (16x16).  
77       * Products designed to run "headless" typically would not have such an image.
78       * <p>
79       * The value is either a fully qualified valid URL or a path relative 
80       * to the product's defining bundle.
81       * </p> 
82       * <p>
83       * If the <code>WINDOW_IMAGES</code> property is given, then it supercedes
84       * this one.
85       * </p>
86       * @deprecated use WINDOW_IMAGES instead (see recommendations there)
87       */
88      public static final String   WINDOW_IMAGE = "windowImage"; //$NON-NLS-1$
89  
90      /**
91       * An array of one or more images to be used for this product.  The
92       * expectation is that the array will contain the same image rendered
93       * at different sizes (16x16 and 32x32).  
94       * Products designed to run "headless" typically would not have such images.
95       * <p>
96       * The value is a comma-separated list of paths, where each path is either 
97       * a fully qualified valid URL or a path relative to the product's defining bundle.
98       * </p> 
99       * <p>
100      * If this property is given, then it supercedes <code>WINDOW_IMAGE</code>.
101      * </p>
102      * <p>
103      * It is recommended that products use <code>WINDOW_IMAGES</code> rather than
104      * <code>WINDOW_IMAGE</code>, and specify both a 16x16 image and a 32x32 image,
105      * to ensure that different sizes of the image are available for different uses
106      * in the OS.  For example, on Windows, the 16x16 image is used in the corner of
107      * the window and in the task tray, but the 32x32 image is used in the Alt+Tab
108      * application switcher.
109      * </p>
110      */
111     public static final String   WINDOW_IMAGES = "windowImages"; //$NON-NLS-1$
112 
113     /**
114      * The product's welcome page (special XML-based format).
115      * <p>
116      * The value is either a fully qualified valid URL or a path relative 
117      * to the product's defining bundle.
118      * </p> 
119      * <p>
120      * Products designed to run "headless" typically would not have such
121      * a page. Use of this property is discouraged in 3.0, the new
122      * <code>org.eclipse.ui.intro</code> extension point should be used instead.
123      * </p>
124      */
125     public static final String   WELCOME_PAGE = "welcomePage"; //$NON-NLS-1$
126 
127     /**
128      * The rectangle relative to the splash image's top left corner where
129      * the progress bar for reporting progress at startup should be shown.  
130      * Products designed to run "headless" typically would not define this
131      * property.
132      * <p>
133      * The value is a comma-separated list of four integer values, specifying
134      * x, y, width, and height of the rectangle in pixel coordinates.
135      * </p>
136      * @since 3.2
137      * @see org.eclipse.ui.IWorkbenchPreferenceConstants#SHOW_PROGRESS_ON_STARTUP
138      */
139     public static final String   STARTUP_PROGRESS_RECT = "startupProgressRect"; //$NON-NLS-1$
140 
141     /**
142      * The rectangle relative to the splash image's top left corner where
143      * messages for reporting progress at startup should be shown.  
144      * Products designed to run "headless" typically would not define this
145      * property.
146      * <p>
147      * The value is a comma-separated list of four integer values, specifying
148      * x, y, width, and height of the rectangle in pixel coordinates.
149      * </p> 
150      * @since 3.2
151      * @see org.eclipse.ui.IWorkbenchPreferenceConstants#SHOW_PROGRESS_ON_STARTUP
152      */
153     public static final String   STARTUP_MESSAGE_RECT = "startupMessageRect"; //$NON-NLS-1$
154 
155     /**
156      * The foreground color to be used when reporting progress at startup.  
157      * Products designed to run "headless" typically would not define this
158      * property.
159      * <p>
160      * The value is a six-digit hexadecimal number. The first two digits
161      * specify the red component of the color, the next two digits the
162      * green component, and the last two digits the blue component.
163      * </p> 
164      * @since 3.2
165      * @see org.eclipse.ui.IWorkbenchPreferenceConstants#SHOW_PROGRESS_ON_STARTUP
166      */
167     public static final String   STARTUP_FOREGROUND_COLOR = "startupForegroundColor"; //$NON-NLS-1$
168 
169 }
170
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags