org.eclipse.jpt.jpa.ui
Interface JpaWorkbench

public interface JpaWorkbench

The Dali JPA state corresponding to an Eclipse workbench.

To retrieve the JPA workbench corresponding to an Eclipse workbench:

     IWorkbench workbench = PlatformUI.getWorkbench();
     // even though IWorkbench extends IAdaptable, it does not delegate to the
     // Platform adapter manager; so registered adapter factories are *not* used... :-(
     // JpaWorkbench jpaWorkbench = (JpaWorkbench) workbench.getAdapter(JpaWorkbench.class);
     JpaWorkbench jpaWorkbench = PlatformTools.getAdapter(workbench, JpaWorkbench.class);
 

See org.eclipse.jpt.jpa.ui/plugin.xml:org.eclipse.core.runtime.adapters.

Not intended to be implemented by clients.

Provisional API: This class is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:

3.3

Method Summary

ResourceManager	buildLocalResourceManager() Return a new "local" resource manager.
JpaPlatformUiManager	getJpaPlatformUiManager() Return the manager for the workbench's JPA platform UIs.
JpaWorkspace	getJpaWorkspace() Return the workbench's JPA workspace.
ResourceManager	getResourceManager(Control control) Return the resource manager associated with the specified control.
IWorkbench	getWorkbench() Return the corresponding Eclipse workbench.

Method Detail

getWorkbench

IWorkbench getWorkbench()

Return the corresponding Eclipse workbench.

getJpaWorkspace

JpaWorkspace getJpaWorkspace()

Return the workbench's JPA workspace.

getJpaPlatformUiManager

JpaPlatformUiManager getJpaPlatformUiManager()

Return the manager for the workbench's JPA platform UIs.

buildLocalResourceManager

ResourceManager buildLocalResourceManager()

Return a new "local" resource manager. The resource manager's parent will be the JPA workbench's resource manager, allowing any resources to be shared across the JPA workbench. The client must dispose the resource manager as appropriate.

See Also:

getResourceManager(Control), JptUIPlugin.buildImageDescriptor(String)

getResourceManager

ResourceManager getResourceManager(Control control)

Return the resource manager associated with the specified control. The control's resource manager's parent will be the JPA workbench's resource manager, allowing any resources to be shared across the JPA workbench. The returned resource manager will dispose itself when the specified control is disposed, freeing the client from the obligation of disposing the manager.

See Also:

buildLocalResourceManager(), LocalResourceManager.LocalResourceManager(ResourceManager, Control), JptUIPlugin.buildImageDescriptor(String), Widget.getData(String)