001: /*******************************************************************************
002: * Copyright (c) 2004, 2006 IBM Corporation and others.
003: * All rights reserved. This program and the accompanying materials
004: * are made available under the terms of the Eclipse Public License v1.0
005: * which accompanies this distribution, and is available at
006: * http://www.eclipse.org/legal/epl-v10.html
007: *
008: * Contributors:
009: * IBM Corporation - initial API and implementation
010: *******************************************************************************/package org.eclipse.ui.branding;
011:
012: /**
013: * These constants define the set of properties that the UI expects to
014: * be available via <code>IProduct.getProperty(String)</code>.
015: *
016: * @since 3.0
017: * @see org.eclipse.core.runtime.IProduct#getProperty(String)
018: */
019: public interface IProductConstants {
020: /**
021: * The SWT application name, used to initialize the SWT Display.
022: * <p>
023: * This value is used to refer to the application in .XDefaults
024: * files on X server based window systems such as Motif.
025: * </p>
026: * <p>
027: * To obtain a human-readable name for the product, use
028: * <code>IProduct.getName()</code>.
029: * </p>
030: * @see org.eclipse.swt.widgets.Display#setAppName
031: */
032: public static final String APP_NAME = "appName"; //$NON-NLS-1$
033:
034: /**
035: * The text to show in an "about" dialog for this product.
036: * Products designed to run "headless" typically would not
037: * have such text.
038: */
039: public static final String ABOUT_TEXT = "aboutText"; //$NON-NLS-1$
040:
041: /**
042: * An image which can be shown in an "about" dialog for this
043: * product. Products designed to run "headless" typically would not
044: * have such an image.
045: * <p>
046: * The value is either a fully qualified valid URL or a path relative
047: * to the product's defining bundle.
048: * </p>
049: * <p>
050: * A full-sized product image (no larger than 500x330 pixels) is
051: * shown without the "aboutText" blurb. A half-sized product image
052: * (no larger than 250x330 pixels) is shown with the "aboutText"
053: * blurb beside it.
054: * </p>
055: */
056: public static final String ABOUT_IMAGE = "aboutImage"; //$NON-NLS-1$
057:
058: /**
059: * A file for customizing default preference
060: * values for a product. The value is interpreted as either a
061: * URL or a bundle-relative path by the runtime. This is not referenced
062: * from the workbench.
063: * <p>
064: * The contents must be the same format as a
065: * {@link java.util.Properties} file with the key/value pairs being:
066: * <pre>
067: * qualifier/key=value
068: * </pre>
069: * Where <code>qualifier</code> is typically the bundle id.
070: * </p>
071: */
072: public static final String PREFERENCE_CUSTOMIZATION = "preferenceCustomization"; //$NON-NLS-1$
073:
074: /**
075: * An image to be used as the window icon for this product (16x16).
076: * Products designed to run "headless" typically would not have such an image.
077: * <p>
078: * The value is either a fully qualified valid URL or a path relative
079: * to the product's defining bundle.
080: * </p>
081: * <p>
082: * If the <code>WINDOW_IMAGES</code> property is given, then it supercedes
083: * this one.
084: * </p>
085: * @deprecated use WINDOW_IMAGES instead (see recommendations there)
086: */
087: public static final String WINDOW_IMAGE = "windowImage"; //$NON-NLS-1$
088:
089: /**
090: * An array of one or more images to be used for this product. The
091: * expectation is that the array will contain the same image rendered
092: * at different sizes (16x16 and 32x32).
093: * Products designed to run "headless" typically would not have such images.
094: * <p>
095: * The value is a comma-separated list of paths, where each path is either
096: * a fully qualified valid URL or a path relative to the product's defining bundle.
097: * </p>
098: * <p>
099: * If this property is given, then it supercedes <code>WINDOW_IMAGE</code>.
100: * </p>
101: * <p>
102: * It is recommended that products use <code>WINDOW_IMAGES</code> rather than
103: * <code>WINDOW_IMAGE</code>, and specify both a 16x16 image and a 32x32 image,
104: * to ensure that different sizes of the image are available for different uses
105: * in the OS. For example, on Windows, the 16x16 image is used in the corner of
106: * the window and in the task tray, but the 32x32 image is used in the Alt+Tab
107: * application switcher.
108: * </p>
109: */
110: public static final String WINDOW_IMAGES = "windowImages"; //$NON-NLS-1$
111:
112: /**
113: * The product's welcome page (special XML-based format).
114: * <p>
115: * The value is either a fully qualified valid URL or a path relative
116: * to the product's defining bundle.
117: * </p>
118: * <p>
119: * Products designed to run "headless" typically would not have such
120: * a page. Use of this property is discouraged in 3.0, the new
121: * <code>org.eclipse.ui.intro</code> extension point should be used instead.
122: * </p>
123: */
124: public static final String WELCOME_PAGE = "welcomePage"; //$NON-NLS-1$
125:
126: /**
127: * The rectangle relative to the splash image's top left corner where
128: * the progress bar for reporting progress at startup should be shown.
129: * Products designed to run "headless" typically would not define this
130: * property.
131: * <p>
132: * The value is a comma-separated list of four integer values, specifying
133: * x, y, width, and height of the rectangle in pixel coordinates.
134: * </p>
135: * @since 3.2
136: * @see org.eclipse.ui.IWorkbenchPreferenceConstants#SHOW_PROGRESS_ON_STARTUP
137: */
138: public static final String STARTUP_PROGRESS_RECT = "startupProgressRect"; //$NON-NLS-1$
139:
140: /**
141: * The rectangle relative to the splash image's top left corner where
142: * messages for reporting progress at startup should be shown.
143: * Products designed to run "headless" typically would not define this
144: * property.
145: * <p>
146: * The value is a comma-separated list of four integer values, specifying
147: * x, y, width, and height of the rectangle in pixel coordinates.
148: * </p>
149: * @since 3.2
150: * @see org.eclipse.ui.IWorkbenchPreferenceConstants#SHOW_PROGRESS_ON_STARTUP
151: */
152: public static final String STARTUP_MESSAGE_RECT = "startupMessageRect"; //$NON-NLS-1$
153:
154: /**
155: * The foreground color to be used when reporting progress at startup.
156: * Products designed to run "headless" typically would not define this
157: * property.
158: * <p>
159: * The value is a six-digit hexadecimal number. The first two digits
160: * specify the red component of the color, the next two digits the
161: * green component, and the last two digits the blue component.
162: * </p>
163: * @since 3.2
164: * @see org.eclipse.ui.IWorkbenchPreferenceConstants#SHOW_PROGRESS_ON_STARTUP
165: */
166: public static final String STARTUP_FOREGROUND_COLOR = "startupForegroundColor"; //$NON-NLS-1$
167:
168: }
|