OsgiDetailsSectionPart.java

/*******************************************************************************
 *  Copyright (c) 2012 - 2013 GoPivotal, Inc.
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  which accompanies this distribution, and is available at
 *  http://www.eclipse.org/legal/epl-v10.html
 *
 *  Contributors:
 *      GoPivotal, Inc. - initial API and implementation
 *******************************************************************************/
package org.springframework.ide.eclipse.osgi.ui.editor;

import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.forms.widgets.FormToolkit;
import org.eclipse.wst.xml.core.internal.provisional.document.IDOMElement;
import org.springframework.ide.eclipse.config.core.contentassist.providers.BeanReferenceContentProposalProvider;
import org.springframework.ide.eclipse.config.core.contentassist.providers.ClassContentProposalProvider;
import org.springframework.ide.eclipse.config.core.schemas.OsgiSchemaConstants;
import org.springframework.ide.eclipse.config.ui.editors.AbstractConfigEditor;
import org.springframework.ide.eclipse.config.ui.editors.SpringConfigDetailsSectionPart;
import org.springframework.ide.eclipse.config.ui.hyperlinks.XmlBackedHyperlinkProvider;
import org.springframework.ide.eclipse.config.ui.widgets.HyperlinkedTextAttribute;
import org.springframework.ide.eclipse.config.ui.widgets.TextAttribute;
import org.springframework.ide.eclipse.config.ui.widgets.TextAttributeProposalAdapter;
import org.springframework.ide.eclipse.osgi.ui.editor.contentassist.osgi.ReferenceIdContentProposalProvider;
import org.springframework.ide.eclipse.osgi.ui.editor.contentassist.osgi.RegistrationMethodContentProposalProvider;
import org.springframework.ide.eclipse.osgi.ui.editor.hyperlink.osgi.RegistrationMethodHyperlinkProvider;

/**
 * @author Leo Dos Santos
 */
@SuppressWarnings("restriction")
public class OsgiDetailsSectionPart extends SpringConfigDetailsSectionPart {
	
	private FormToolkit toolkit;

	public OsgiDetailsSectionPart(AbstractConfigEditor editor, IDOMElement input, Composite parent, FormToolkit toolkit) {
		super(editor, input, parent, toolkit);
		this.toolkit = toolkit;
	}

	@Override
	protected boolean addCustomAttribute(Composite client, String attr, boolean required) {
		// OsgiContentAssistProcessor and OsgiHyperlinkDetector
		String elem = getInput().getLocalName();
		if (OsgiSchemaConstants.ATTR_DEPENDS_ON.equals(attr) || OsgiSchemaConstants.ATTR_REF.equals(attr)) {
			TextAttribute attrControl = createBeanAttribute(client, attr, required);
			addWidget(attrControl);
			addAdapter(new TextAttributeProposalAdapter(attrControl, new BeanReferenceContentProposalProvider(
					getInput(), attr, true)));
			return true;
		}
		if (OsgiSchemaConstants.ATTR_INTERFACE.equals(attr)) {
			TextAttribute attrControl = createClassAttribute(client, attr, true, required);
			addWidget(attrControl);
			addAdapter(new TextAttributeProposalAdapter(attrControl, new ClassContentProposalProvider(getInput(), attr)));
			return true;
		}
		if (OsgiSchemaConstants.ATTR_REGISTRATION_METHOD.equals(attr)
				|| OsgiSchemaConstants.ATTR_UNREGISTRATION_METHOD.equals(attr)) {
			TextAttribute attrControl = createRegistrationMethodAttribute(client, attr, required);
			addWidget(attrControl);
			addAdapter(new TextAttributeProposalAdapter(attrControl, new RegistrationMethodContentProposalProvider(
					getInput(), attr)));
			return true;
		}
		if (OsgiSchemaConstants.ELEM_REFERENCE.equals(elem) && OsgiSchemaConstants.ATTR_ID.equals(attr)) {
			TextAttribute attrControl = createTextAttribute(client, attr, required);
			addWidget(attrControl);
			addAdapter(new TextAttributeProposalAdapter(attrControl, new ReferenceIdContentProposalProvider(getInput(),
					attr)));
			return true;
		}
		return super.addCustomAttribute(client, attr, required);
	}

	/**
	 * Creates a {@link HyperlinkedTextAttribute} widget set for displaying an
	 * attribute that refers to a Java method. Clicking the hyperlink will open
	 * the class file at the method displayed in the text field.
	 * 
	 * @param client the parent composite
	 * @param attr the attribute name
	 * @param required denotes whether this is a required field
	 * @return {@link HyperlinkedTextAttribute} widget set
	 */
	protected HyperlinkedTextAttribute createRegistrationMethodAttribute(Composite client, String attr, boolean required) {
		HyperlinkedTextAttribute linkAttr = new XmlBackedHyperlinkTextAttribute(client, toolkit, attr, required) {
			public void openHyperlink() {
				XmlBackedHyperlinkProvider provider = new RegistrationMethodHyperlinkProvider(getConfigEditor()
						.getTextViewer(), getInput(), attr);
				provider.open(text.getText());
			}
		};
		linkAttr.createAttribute(2);
		return linkAttr;
	}
	
}