KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > pde > internal > core > ischema > IMetaElement


1 /*******************************************************************************
2  * Copyright (c) 2000, 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.pde.internal.core.ischema;
12
13 /**
14  * Objects that implement this interface store metadata about extension point
15  * schema elements. This metadata is stored as schema element annotation.
16  */
17 public interface IMetaElement {
18     /**
19      * Property that indicates if an element has translatable content
20      */
21     public static final String JavaDoc P_TRANSLATABLE = "translatable"; //$NON-NLS-1$
22
23     /**
24      * Property that indicates if an element is deprecated
25      */
26     public static final String JavaDoc P_DEPRECATED = "deprecated"; //$NON-NLS-1$
27
28     /**
29      * Returns a property (attribute) name whose value should be used to load
30      * element icon in the UI. For example, if icon property is set to "icon"
31      * and the element has an "icon" attribute that represents icon path
32      * relative to the plug-in, an attempt will be made to load that icon.
33      */
34     public String JavaDoc getIconProperty();
35
36     /**
37      * Returns a property (attribute) name whose value should be used to
38      * represent this element in the UI. For example, if this value is
39      * <samp>null </samp> and the name of the element is "wizard", that will be
40      * showing in the UI. However, if label property is set to "name" and the
41      * element has a "name" attribute whose value is "Import Wizard", that value
42      * will be used in the UI instead of "wizard".
43      */
44     public String JavaDoc getLabelProperty();
45     
46     /**
47      * Returns <samp>true</samp> if the element content is translatable; <samp>false</samp> otherwise.
48      */
49     public boolean hasTranslatableContent();
50
51     /**
52      * Returns <samp>true</samp> if the element is deprecated; <samp>false</samp> otherwise.
53      */
54     public boolean isDeprecated();
55 }
56
Popular Tags