org.eclipse.jpt.jpa.ui.editors
Interface JpaEditorPageDefinition

public interface JpaEditorPageDefinition

A JPA editor page definition defines an editor page's:

• title image
• title text
• help ID
• content

We take advantage of the FormEditor behavior by not building the content of any particular editor page until its tab is selected. When the tab is selected we call buildContent(IManagedForm, WidgetFactory, ResourceManager, PropertyValueModel).

See Also:

ResourceUiDefinition,

Provisional API: This interface 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.

Method Summary

void	buildContent(IManagedForm form, WidgetFactory widgetFactory, ResourceManager resourceManager, PropertyValueModel<JpaStructureNode> rootStructureNodeModel) Build the page's content in the specified form, using the specified widget factory, resource manager, and JPA structure node model.
String	getHelpID() Return the page's help ID.
ImageDescriptor	getTitleImageDescriptor() Return the descriptor for the image to be displayed alongside the page's title text.
String	getTitleText() Return the text to be displayed in the page's title.

Method Detail

getTitleImageDescriptor

ImageDescriptor getTitleImageDescriptor()

Return the descriptor for the image to be displayed alongside the page's title text.

See Also:

ScrolledForm.getImage()

getTitleText

String getTitleText()

Return the text to be displayed in the page's title.

See Also:

ScrolledForm.getText()

getHelpID

String getHelpID()

Return the page's help ID. This ID will be used if the help button is invoked.

buildContent

void buildContent(IManagedForm form,
                  WidgetFactory widgetFactory,
                  ResourceManager resourceManager,
                  PropertyValueModel<JpaStructureNode> rootStructureNodeModel)

Build the page's content in the specified form, using the specified widget factory, resource manager, and JPA structure node model.