Target Explorer: Unify form page setup and content creation

3 files changed, 133 insertions, 96 deletions

diff --git a/target_explorer/plugins/org.eclipse.tcf.te.tcf.ui/src/org/eclipse/tcf/te/tcf/ui/editor/OverviewEditorPage.java b/target_explorer/plugins/org.eclipse.tcf.te.tcf.ui/src/org/eclipse/tcf/te/tcf/ui/editor/OverviewEditorPage.java
index 79c85fe7a..755d487d3 100644
--- a/target_explorer/plugins/org.eclipse.tcf.te.tcf.ui/src/org/eclipse/tcf/te/tcf/ui/editor/OverviewEditorPage.java
+++ b/target_explorer/plugins/org.eclipse.tcf.te.tcf.ui/src/org/eclipse/tcf/te/tcf/ui/editor/OverviewEditorPage.java
@@ -10,10 +10,9 @@
 package org.eclipse.tcf.te.tcf.ui.editor;

 

 import org.eclipse.core.runtime.Assert;

-import org.eclipse.jface.action.IToolBarManager;

-import org.eclipse.jface.action.Separator;

 import org.eclipse.jface.dialogs.IMessageProvider;

 import org.eclipse.swt.SWT;

+import org.eclipse.swt.graphics.Image;

 import org.eclipse.swt.layout.GridData;

 import org.eclipse.swt.widgets.Composite;

 import org.eclipse.tcf.te.tcf.ui.activator.UIPlugin;

@@ -25,12 +24,8 @@ import org.eclipse.tcf.te.tcf.ui.help.IContextHelpIds;
 import org.eclipse.tcf.te.tcf.ui.internal.ImageConsts;

 import org.eclipse.tcf.te.tcf.ui.nls.Messages;

 import org.eclipse.tcf.te.ui.forms.CustomFormToolkit;

-import org.eclipse.tcf.te.ui.forms.FormLayoutFactory;

 import org.eclipse.tcf.te.ui.jface.interfaces.IValidatingContainer;

 import org.eclipse.tcf.te.ui.views.editor.pages.AbstractCustomFormToolkitEditorPage;

-import org.eclipse.ui.IWorkbenchActionConstants;

-import org.eclipse.ui.PlatformUI;

-import org.eclipse.ui.forms.IManagedForm;

 import org.eclipse.ui.forms.widgets.ScrolledForm;

 import org.eclipse.ui.forms.widgets.TableWrapData;

 import org.eclipse.ui.forms.widgets.TableWrapLayout;

@@ -58,75 +53,34 @@ public class OverviewEditorPage extends AbstractCustomFormToolkitEditorPage impl
 	}

 

 	/* (non-Javadoc)

-	 * @see org.eclipse.ui.forms.editor.FormPage#createFormContent(org.eclipse.ui.forms.IManagedForm)

+	 * @see org.eclipse.tcf.te.ui.views.editor.pages.AbstractCustomFormToolkitEditorPage#getContextHelpId()

 	 */

 	@Override

-	protected void createFormContent(IManagedForm managedForm) {

-		super.createFormContent(managedForm);

-

-		// Configure the managed form

-		configureManagedForm(managedForm);

-

-		// Do create the content of the form now

-		doCreateFormContent(managedForm.getForm().getBody(), getFormToolkit());

-

-		// Re-arrange the controls

-		managedForm.reflow(true);

-	}

-

-	/**

-	 * Configure the managed form to be ready for usage.

-	 *

-	 * @param managedForm The managed form. Must not be <code>null</code>.

-	 */

-	protected void configureManagedForm(IManagedForm managedForm) {

-		Assert.isNotNull(managedForm);

-

-		// Configure main layout

-		Composite body = managedForm.getForm().getBody();

-		body.setLayout(FormLayoutFactory.createFormGridLayout(false, 1));

-

-		// Set context help id

-		PlatformUI.getWorkbench().getHelpSystem().setHelp(managedForm.getForm(), IContextHelpIds.OVERVIEW_EDITOR_PAGE);

-

-		// Decorate the form header

-		getFormToolkit().getFormToolkit().decorateFormHeading(managedForm.getForm().getForm());

-		// And set the header text and image

-		managedForm.getForm().getForm().setText(getFormTitle());

-		managedForm.getForm().getForm().setImage(UIPlugin.getImage(ImageConsts.PEER));

-

-		// Add the toolbar items which will appear in the form header

-		IToolBarManager manager = managedForm.getForm().getForm().getToolBarManager();

-		createToolbarContributionItems(manager);

-		manager.add(new Separator(IWorkbenchActionConstants.MB_ADDITIONS));

-		manager.update(true);

+	protected String getContextHelpId() {

+	    return IContextHelpIds.OVERVIEW_EDITOR_PAGE;

 	}

 

-	/**

-	 * Returns the form title to set to the top form header.

-	 *

-	 * @return The form title.

+	/* (non-Javadoc)

+	 * @see org.eclipse.tcf.te.ui.views.editor.pages.AbstractCustomFormToolkitEditorPage#getFormTitle()

 	 */

-	protected String getFormTitle() {

+	@Override

+    protected String getFormTitle() {

 		return Messages.OverviewEditorPage_title;

 	}

 

-	/**

-	 * Create the toolbar contribution items.

-	 *

-	 * @param manager The toolbar manager. Must not be <code>null</code>.

+	/* (non-Javadoc)

+	 * @see org.eclipse.tcf.te.ui.views.editor.pages.AbstractCustomFormToolkitEditorPage#getFormImage()

 	 */

-	protected void createToolbarContributionItems(IToolBarManager manager) {

-		Assert.isNotNull(manager);

+	@Override

+	protected Image getFormImage() {

+	    return UIPlugin.getImage(ImageConsts.PEER);

 	}

 

-	/**

-	 * Do create the managed form content.

-	 *

-	 * @param parent The parent composite. Must not be <code>null</code>

-	 * @param toolkit The {@link CustomFormToolkit} instance. Must not be <code>null</code>.

+	/* (non-Javadoc)

+	 * @see org.eclipse.tcf.te.ui.views.editor.pages.AbstractCustomFormToolkitEditorPage#doCreateFormContent(org.eclipse.swt.widgets.Composite, org.eclipse.tcf.te.ui.forms.CustomFormToolkit)

 	 */

-	protected void doCreateFormContent(Composite parent, CustomFormToolkit toolkit) {

+	@Override

+    protected void doCreateFormContent(Composite parent, CustomFormToolkit toolkit) {

 		Assert.isNotNull(parent);

 		Assert.isNotNull(toolkit);

 

diff --git a/target_explorer/plugins/org.eclipse.tcf.te.ui.views/src/org/eclipse/tcf/te/ui/views/editor/pages/AbstractCustomFormToolkitEditorPage.java b/target_explorer/plugins/org.eclipse.tcf.te.ui.views/src/org/eclipse/tcf/te/ui/views/editor/pages/AbstractCustomFormToolkitEditorPage.java
index 510baa13f..8a0ba6509 100644
--- a/target_explorer/plugins/org.eclipse.tcf.te.ui.views/src/org/eclipse/tcf/te/ui/views/editor/pages/AbstractCustomFormToolkitEditorPage.java
+++ b/target_explorer/plugins/org.eclipse.tcf.te.ui.views/src/org/eclipse/tcf/te/ui/views/editor/pages/AbstractCustomFormToolkitEditorPage.java
@@ -10,14 +10,23 @@
 package org.eclipse.tcf.te.ui.views.editor.pages;

 

 import org.eclipse.core.runtime.Assert;

+import org.eclipse.jface.action.IToolBarManager;

+import org.eclipse.jface.action.Separator;

+import org.eclipse.jface.action.ToolBarManager;

+import org.eclipse.swt.graphics.Image;

+import org.eclipse.swt.widgets.Composite;

 import org.eclipse.tcf.te.ui.forms.CustomFormToolkit;

+import org.eclipse.tcf.te.ui.forms.FormLayoutFactory;

+import org.eclipse.ui.IWorkbenchActionConstants;

+import org.eclipse.ui.PlatformUI;

 import org.eclipse.ui.forms.IManagedForm;

+import org.eclipse.ui.menus.IMenuService;

 

 /**

  * Abstract details editor page implementation managing

  *                  an custom form toolkit instance.

  */

-public class AbstractCustomFormToolkitEditorPage extends AbstractEditorPage {

+public abstract class AbstractCustomFormToolkitEditorPage extends AbstractEditorPage {

 	// Reference to the form toolkit instance

 	private CustomFormToolkit toolkit = null;

 

@@ -40,6 +49,15 @@ public class AbstractCustomFormToolkitEditorPage extends AbstractEditorPage {
 	}

 

 	/* (non-Javadoc)

+	 * @see org.eclipse.ui.forms.editor.FormPage#dispose()

+	 */

+	@Override

+	public void dispose() {

+		if (toolkit != null) { toolkit.dispose(); toolkit = null; }

+		super.dispose();

+	}

+

+	/* (non-Javadoc)

 	 * @see org.eclipse.ui.forms.editor.FormPage#createFormContent(org.eclipse.ui.forms.IManagedForm)

 	 */

 	@Override

@@ -50,14 +68,96 @@ public class AbstractCustomFormToolkitEditorPage extends AbstractEditorPage {
 

 		// Create the toolkit instance

 		toolkit = new CustomFormToolkit(managedForm.getToolkit());

+

+		// Configure the managed form

+		configureManagedForm(managedForm);

+

+		// Do create the content of the form now

+		doCreateFormContent(managedForm.getForm().getBody(), getFormToolkit());

+

+		// Re-arrange the controls

+		managedForm.reflow(true);

 	}

 

-	/* (non-Javadoc)

-	 * @see org.eclipse.ui.forms.editor.FormPage#dispose()

+	/**

+	 * Configure the managed form to be ready for usage.

+	 *

+	 * @param managedForm The managed form. Must not be <code>null</code>.

 	 */

-	@Override

-	public void dispose() {

-		if (toolkit != null) { toolkit.dispose(); toolkit = null; }

-		super.dispose();

+	protected void configureManagedForm(IManagedForm managedForm) {

+		Assert.isNotNull(managedForm);

+

+		// Configure main layout

+		Composite body = managedForm.getForm().getBody();

+		body.setLayout(FormLayoutFactory.createFormGridLayout(false, 1));

+

+		// Set context help id

+		if (getContextHelpId() != null) {

+			PlatformUI.getWorkbench().getHelpSystem().setHelp(managedForm.getForm(), getContextHelpId());

+		}

+

+		// Decorate the form header

+		getFormToolkit().getFormToolkit().decorateFormHeading(managedForm.getForm().getForm());

+		// And set the header text and image

+		if (getFormTitle() != null) managedForm.getForm().getForm().setText(getFormTitle());

+		managedForm.getForm().getForm().setImage(getFormImage());

+

+		// Add the toolbar items which will appear in the form header

+		IToolBarManager manager = managedForm.getForm().getForm().getToolBarManager();

+		// Create fixed toolbar contribution items

+		createToolbarContributionItems(manager);

+		// Add the default "additions" separator

+		manager.add(new Separator(IWorkbenchActionConstants.MB_ADDITIONS));

+		// Get the menu service and populate contributed toolbar actions

+		IMenuService service = (IMenuService) getSite().getService(IMenuService.class);

+		if (service != null) {

+			service.populateContributionManager((ToolBarManager)manager, "toolbar:" + getId()); //$NON-NLS-1$

+		}

+		// Trigger an update of the toolbar widget

+		manager.update(true);

 	}

+

+	/**

+	 * Returns the context help id to associate with the page form.

+	 *

+	 * @return The context help id.

+	 */

+	protected String getContextHelpId() {

+		return null;

+	}

+

+	/**

+	 * Returns the form title to set to the top form header.

+	 *

+	 * @return The form title.

+	 */

+	protected String getFormTitle() {

+		return null;

+	}

+

+	/**

+	 * Returns the image to be set to the top form header.

+	 *

+	 * @return The image or <code>null</code> to use no image.

+	 */

+	protected Image getFormImage() {

+		return null;

+	}

+

+	/**

+	 * Create the toolbar contribution items.

+	 *

+	 * @param manager The toolbar manager. Must not be <code>null</code>.

+	 */

+	protected void createToolbarContributionItems(IToolBarManager manager) {

+		Assert.isNotNull(manager);

+	}

+

+	/**

+	 * Do create the managed form content.

+	 *

+	 * @param parent The parent composite. Must not be <code>null</code>

+	 * @param toolkit The {@link CustomFormToolkit} instance. Must not be <code>null</code>.

+	 */

+	protected abstract void doCreateFormContent(Composite parent, CustomFormToolkit toolkit);

 }

diff --git a/target_explorer/plugins/org.eclipse.tcf.te.ui.views/src/org/eclipse/tcf/te/ui/views/editor/pages/TreeViewerExplorerEditorPage.java b/target_explorer/plugins/org.eclipse.tcf.te.ui.views/src/org/eclipse/tcf/te/ui/views/editor/pages/TreeViewerExplorerEditorPage.java
index 43cfc8555..cf36542e4 100644
--- a/target_explorer/plugins/org.eclipse.tcf.te.ui.views/src/org/eclipse/tcf/te/ui/views/editor/pages/TreeViewerExplorerEditorPage.java
+++ b/target_explorer/plugins/org.eclipse.tcf.te.ui.views/src/org/eclipse/tcf/te/ui/views/editor/pages/TreeViewerExplorerEditorPage.java
@@ -39,34 +39,19 @@ public class TreeViewerExplorerEditorPage extends AbstractCustomFormToolkitEdito
 	}
 
 	/* (non-Javadoc)
-	 * @see org.eclipse.ui.forms.editor.FormPage#createFormContent(org.eclipse.ui.forms.IManagedForm)
+	 * @see org.eclipse.tcf.te.ui.views.editor.pages.AbstractEditorPage#setInitializationData(org.eclipse.core.runtime.IConfigurationElement, java.lang.String, java.lang.Object)
 	 */
 	@Override
-	protected void createFormContent(IManagedForm managedForm) {
-		super.createFormContent(managedForm);
-
-		// Configure the managed form
-		configureManagedForm(managedForm);
-
-		// Do create the content of the form now
-		doCreateFormContent(managedForm.getForm().getBody(), getFormToolkit());
-
-		// Re-arrange the controls
-		managedForm.reflow(true);
-	}
-
-	@Override
     public void setInitializationData(IConfigurationElement config, String propertyName, Object data) {
 	    super.setInitializationData(config, propertyName, data);
 		viewerId = data != null ? data.toString() : null;
     }
 
-	/**
-	 * Configure the managed form to be ready for usage.
-	 *
-	 * @param managedForm The managed form. Must be not <code>null</code>.
+	/* (non-Javadoc)
+	 * @see org.eclipse.tcf.te.ui.views.editor.pages.AbstractCustomFormToolkitEditorPage#configureManagedForm(org.eclipse.ui.forms.IManagedForm)
 	 */
-	protected void configureManagedForm(IManagedForm managedForm) {
+	@Override
+    protected void configureManagedForm(IManagedForm managedForm) {
 		Assert.isNotNull(managedForm);
 
 		// Configure main layout
@@ -77,13 +62,11 @@ public class TreeViewerExplorerEditorPage extends AbstractCustomFormToolkitEdito
 		body.setLayoutData(new TableWrapData(TableWrapData.FILL_GRAB));
 	}
 
-	/**
-	 * Do create the managed form content.
-	 *
-	 * @param parent The parent composite. Must be not <code>null</code>
-	 * @param toolkit The {@link CustomFormToolkit} instance. Must be not <code>null</code>.
+	/* (non-Javadoc)
+	 * @see org.eclipse.tcf.te.ui.views.editor.pages.AbstractCustomFormToolkitEditorPage#doCreateFormContent(org.eclipse.swt.widgets.Composite, org.eclipse.tcf.te.ui.forms.CustomFormToolkit)
 	 */
-	protected void doCreateFormContent(Composite parent, CustomFormToolkit toolkit) {
+	@Override
+    protected void doCreateFormContent(Composite parent, CustomFormToolkit toolkit) {
 		Assert.isNotNull(parent);
 		Assert.isNotNull(toolkit);