IBundleGroupConstants


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>IBundleGroup.getProperty(String)</code>.
16   * 
17   * @since 3.0
18   * @see org.eclipse.core.runtime.IBundleGroup#getProperty(String)
19   */
20  public interface IBundleGroupConstants {
21  
22      /**
23       * The text to show in an "about features" dialog.
24       */
25      public static final String   ABOUT_TEXT = "aboutText"; //$NON-NLS-1$
26  
27      /**
28       * An image which can be shown in an "about features" dialog (32x32).
29       * <p>
30       * The value is a fully qualified valid URL.
31       * </p> 
32       */
33      public static final String   FEATURE_IMAGE = "featureImage"; //$NON-NLS-1$
34  
35      /**
36       * A help reference for the feature's tips and tricks page (optional).
37       */
38      public static final String   TIPS_AND_TRICKS_HREF = "tipsAndTricksHref"; //$NON-NLS-1$
39  
40      /**
41       * The feature's welcome page (special XML-based format).
42       * <p>
43       * The value is a fully qualified valid URL.
44       * </p> 
45       * Products designed to run "headless" typically would not have such a page.
46       */
47      public static final String   WELCOME_PAGE = "welcomePage"; //$NON-NLS-1$
48  
49      /**
50       * The id of a perspective in which to show the welcome page
51       * (optional).
52       */
53      public static final String   WELCOME_PERSPECTIVE = "welcomePerspective"; //$NON-NLS-1$
54  
55      /**
56       * The URL of the license page for the feature (optional).
57       * <p>
58       * The value is a fully qualified valid URL.
59       * </p> 
60       */
61      public static final String   LICENSE_HREF = "licenseHref"; //$NON-NLS-1$
62  }
63
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags