|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDataModelProvider
IDataModelProviders are used by the DataMdoelFactory to construct IDataModels.
This interface is not intended to be implemented by clients. Clients should subclass
AbstractDataModelProvider
.
Field Summary | |
---|---|
static org.eclipse.core.runtime.IStatus |
OK_STATUS
|
Fields inherited from interface org.eclipse.wst.common.frameworks.datamodel.IDataModelProperties |
---|
ALLOW_EXTENSIONS, RESTRICT_EXTENSIONS |
Method Summary | |
---|---|
void |
dispose()
|
IDataModel |
getDataModel()
Returns the backing IDataModel for this provider. |
IDataModelOperation |
getDefaultOperation()
|
java.lang.Object |
getDefaultProperty(java.lang.String propertyName)
This is where the provider should define how default properties should be computed. |
java.util.List |
getExtendedContext()
|
java.lang.String |
getID()
|
DataModelPropertyDescriptor |
getPropertyDescriptor(java.lang.String propertyName)
|
java.util.Set |
getPropertyNames()
Returns a list of property names for which this provider is responsible. |
DataModelPropertyDescriptor[] |
getValidPropertyDescriptors(java.lang.String propertyName)
|
void |
init()
Providers should perform additional initialization here. |
boolean |
isPropertyEnabled(java.lang.String propertyName)
This is where the provider should define how property enablements are computed. |
boolean |
propertySet(java.lang.String propertyName,
java.lang.Object propertyValue)
This is a special callback hook for the IDataModel provider to be notified of a setProperty() call invoked on the backing IDataModel. |
void |
setDataModel(IDataModel dataModel)
|
org.eclipse.core.runtime.IStatus |
validate(java.lang.String name)
IDataModelProviders should perform property validation here. |
Field Detail |
---|
static final org.eclipse.core.runtime.IStatus OK_STATUS
Method Detail |
---|
void setDataModel(IDataModel dataModel)
IDataModel getDataModel()
Returns the backing IDataModel for this provider.
java.util.Set getPropertyNames()
Returns a list of property names for which this provider is responsible. This method is called only once during initialization.
void init()
Providers should perform additional initialization here.
java.lang.Object getDefaultProperty(java.lang.String propertyName)
This is where the provider should define how default properties should be computed.
propertyName
- the specified property
boolean isPropertyEnabled(java.lang.String propertyName)
This is where the provider should define how property enablements are computed.
propertyName
- the specified property
true
if the property is enabled, false
otherwise.org.eclipse.core.runtime.IStatus validate(java.lang.String name)
name
-
boolean propertySet(java.lang.String propertyName, java.lang.Object propertyValue)
This is a special callback hook for the IDataModel provider to be notified of a setProperty() call invoked on the backing IDataModel. This method is called after the actual value has been stored by the IDataModel but before any general notifications are fired to its listeners. Thus this IDataModelProvider may react to updates apropriately by setting other properties, notifying default changes, notifying valid value changes, etc.
propertyName
- propertyValue
-
true
to fire a VALUE_CHG DataModelEvent.DataModelPropertyDescriptor getPropertyDescriptor(java.lang.String propertyName)
DataModelPropertyDescriptor[] getValidPropertyDescriptors(java.lang.String propertyName)
java.util.List getExtendedContext()
IDataModelOperation getDefaultOperation()
java.lang.String getID()
void dispose()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |