01: /*******************************************************************************
02: * Copyright (c) 2000, 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.pde.internal.core.ischema;
11:
12: /**
13: * Objects that implement this interface store metadata about extension point
14: * schema elements. This metadata is stored as schema element annotation.
15: */
16: public interface IMetaElement {
17: /**
18: * Property that indicates if an element has translatable content
19: */
20: public static final String P_TRANSLATABLE = "translatable"; //$NON-NLS-1$
21:
22: /**
23: * Property that indicates if an element is deprecated
24: */
25: public static final String P_DEPRECATED = "deprecated"; //$NON-NLS-1$
26:
27: /**
28: * Returns a property (attribute) name whose value should be used to load
29: * element icon in the UI. For example, if icon property is set to "icon"
30: * and the element has an "icon" attribute that represents icon path
31: * relative to the plug-in, an attempt will be made to load that icon.
32: */
33: public String getIconProperty();
34:
35: /**
36: * Returns a property (attribute) name whose value should be used to
37: * represent this element in the UI. For example, if this value is
38: * <samp>null </samp> and the name of the element is "wizard", that will be
39: * showing in the UI. However, if label property is set to "name" and the
40: * element has a "name" attribute whose value is "Import Wizard", that value
41: * will be used in the UI instead of "wizard".
42: */
43: public String getLabelProperty();
44:
45: /**
46: * Returns <samp>true</samp> if the element content is translatable; <samp>false</samp> otherwise.
47: */
48: public boolean hasTranslatableContent();
49:
50: /**
51: * Returns <samp>true</samp> if the element is deprecated; <samp>false</samp> otherwise.
52: */
53: public boolean isDeprecated();
54: }
|