net.officefloor.eclipse.extension.managedobjectsource
Interface ManagedObjectSourceExtension<D extends Enum<D>,F extends Enum<F>,S extends ManagedObjectSource<D,F>>

All Known Implementing Classes:
ClassManagedObjectSourceExtension, FlatXmlUnmarshallerManagedObjectSourceExtension, TreeXmlMarshallerManagedObjectSourceExtension, TreeXmlUnmarshallerManagedObjectSourceExtension

public interface ManagedObjectSourceExtension<D extends Enum<D>,F extends Enum<F>,S extends ManagedObjectSource<D,F>>

Interface for extension to provide enriched ManagedObjectSource usage.

Author:
Daniel Sagenschneider
See Also:
ExtensionClasspathProvider, ExtensionOpener

Field Summary
static String EXTENSION_ID
          Extension ID.
 
Method Summary
 void createControl(org.eclipse.swt.widgets.Composite page, ManagedObjectSourceExtensionContext context)
          Populates the input page with the necessary Control instances to obtain the properties.
 Class<S> getManagedObjectSourceClass()
          Obtains the class of the ManagedObjectSource being enriched in its usage.
 String getManagedObjectSourceLabel()
          Obtains the display name.
 String getSuggestedManagedObjectSourceName(PropertyList properties)
          Obtains the suggested name of the ManagedObjectSource.
 

Field Detail

EXTENSION_ID

static final String EXTENSION_ID
Extension ID.

Method Detail

getManagedObjectSourceClass

Class<S> getManagedObjectSourceClass()
Obtains the class of the ManagedObjectSource being enriched in its usage.

Returns:
Class of the ManagedObjectSource being enriched in its usage.

getManagedObjectSourceLabel

String getManagedObjectSourceLabel()
Obtains the display name. This is a descriptive name that can be used other than the fully qualified name of the ManagedObjectSource.

Returns:
Display name.

createControl

void createControl(org.eclipse.swt.widgets.Composite page,
                   ManagedObjectSourceExtensionContext context)
Populates the input page with the necessary Control instances to obtain the properties. Also allows notifying of changes to properties via the ManagedObjectSourceExtensionContext.

Parameters:
page - Page to be setup for obtaining the properties.
context - ManagedObjectSourceExtensionContext.

getSuggestedManagedObjectSourceName

String getSuggestedManagedObjectSourceName(PropertyList properties)
Obtains the suggested name of the ManagedObjectSource.

Parameters:
properties - Populate PropertyList.
Returns:
Suggested ManagedObjectSource name or null if no suggestion.


Copyright © 2005-2013. All Rights Reserved.