KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > pde > internal > core > ifeature > IFeatureObject


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.ifeature;
12
13 import java.io.Serializable JavaDoc;
14
15 import org.eclipse.core.runtime.CoreException;
16 import org.eclipse.core.runtime.IAdaptable;
17 import org.eclipse.pde.core.IWritable;
18 /**
19  * A base of all feature model objects.
20  */

21 public interface IFeatureObject extends IWritable, IAdaptable, Serializable JavaDoc {
22 /**
23  * A property name that will be used to notify
24  * about changes in the "label" field.
25  */

26 String JavaDoc P_LABEL = "label"; //$NON-NLS-1$
27
/**
28  * Returns the top-level feature model object.
29  * @return root feature object
30  */

31 public IFeature getFeature();
32 /**
33  * Returns the label of this feature model object'
34  * @return feature object label
35  */

36 String JavaDoc getLabel();
37 /**
38  * Returns the feature model that owns this model object.
39  *
40  * @return the feature model
41  */

42 IFeatureModel getModel();
43
44 boolean isInTheModel();
45 /**
46  * Returns the parent of this model object.
47  *
48  * @return the model object parent
49  */

50 public IFeatureObject getParent();
51 /**
52  * Sets the new label of this model object.
53  * This method may throw a CoreException
54  * if the model is not editable.
55  *
56  * @param label the new label
57  */

58 void setLabel(String JavaDoc label) throws CoreException;
59 /**
60  * Returns the translated label of this feature model object'
61  * @return feature object translated label
62  */

63 public String JavaDoc getTranslatableLabel();
64 }
65
66
Popular Tags