/*******************************************************************************
* Copyright (c) 2008, 2012 Obeo.
* 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:
* Obeo - initial API and implementation
*******************************************************************************/
package org.eclipse.emf.eef.views.parts.forms;
// Start of user code for imports
import org.eclipse.emf.eef.runtime.api.component.IPropertiesEditionComponent;
import org.eclipse.emf.eef.runtime.api.notify.IPropertiesEditionEvent;
import org.eclipse.emf.eef.runtime.api.parts.IFormPropertiesEditionPart;
import org.eclipse.emf.eef.runtime.impl.notify.PropertiesEditionEvent;
import org.eclipse.emf.eef.runtime.part.impl.SectionPropertiesEditingPart;
import org.eclipse.emf.eef.runtime.ui.parts.PartComposer;
import org.eclipse.emf.eef.runtime.ui.parts.sequence.BindingCompositionSequence;
import org.eclipse.emf.eef.runtime.ui.parts.sequence.CompositionSequence;
import org.eclipse.emf.eef.runtime.ui.utils.EditingUtils;
import org.eclipse.emf.eef.runtime.ui.widgets.FormUtils;
import org.eclipse.emf.eef.views.parts.DocumentationPropertiesEditionPart;
import org.eclipse.emf.eef.views.parts.ViewsViewsRepository;
import org.eclipse.emf.eef.views.providers.ViewsMessages;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.FocusAdapter;
import org.eclipse.swt.events.FocusEvent;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Text;
import org.eclipse.ui.forms.widgets.Form;
import org.eclipse.ui.forms.widgets.FormToolkit;
import org.eclipse.ui.forms.widgets.ScrolledForm;
import org.eclipse.ui.forms.widgets.Section;
import org.eclipse.ui.views.properties.tabbed.ISection;
// End of user code
/**
* @author <a href="mailto:nathalie.lepine@obeo.fr">Nathalie Lepine</a>
*
*/
public class DocumentationPropertiesEditionPartForm extends SectionPropertiesEditingPart implements IFormPropertiesEditionPart, DocumentationPropertiesEditionPart {
protected Text documentation;
/**
* For {@link ISection} use only.
*/
public DocumentationPropertiesEditionPartForm() { super(); }
/**
* Default constructor
* @param editionComponent the {@link IPropertiesEditionComponent} that manage this part
*
*/
public DocumentationPropertiesEditionPartForm(IPropertiesEditionComponent editionComponent) {
super(editionComponent);
}
/**
* {@inheritDoc}
*
* @see org.eclipse.emf.eef.runtime.api.parts.IFormPropertiesEditionPart#
* createFigure(org.eclipse.swt.widgets.Composite, org.eclipse.ui.forms.widgets.FormToolkit)
*
*/
public Composite createFigure(final Composite parent, final FormToolkit widgetFactory) {
ScrolledForm scrolledForm = widgetFactory.createScrolledForm(parent);
Form form = scrolledForm.getForm();
view = form.getBody();
GridLayout layout = new GridLayout();
layout.numColumns = 3;
view.setLayout(layout);
createControls(widgetFactory, view);
return scrolledForm;
}
/**
* {@inheritDoc}
*
* @see org.eclipse.emf.eef.runtime.api.parts.IFormPropertiesEditionPart#
* createControls(org.eclipse.ui.forms.widgets.FormToolkit, org.eclipse.swt.widgets.Composite)
*
*/
public void createControls(final FormToolkit widgetFactory, Composite view) {
CompositionSequence documentationStep = new BindingCompositionSequence(propertiesEditionComponent);
documentationStep
.addStep(ViewsViewsRepository.Documentation.Documentation_.class)
.addStep(ViewsViewsRepository.Documentation.Documentation_.documentation__);
composer = new PartComposer(documentationStep) {
@Override
public Composite addToPart(Composite parent, Object key) {
if (key == ViewsViewsRepository.Documentation.Documentation_.class) {
return createDocumentationGroup(widgetFactory, parent);
}
if (key == ViewsViewsRepository.Documentation.Documentation_.documentation__) {
return createDocumentationTextarea(widgetFactory, parent);
}
return parent;
}
};
composer.compose(view);
}
/**
*
*/
protected Composite createDocumentationGroup(FormToolkit widgetFactory, final Composite parent) {
Section documentationSection = widgetFactory.createSection(parent, Section.TITLE_BAR | Section.TWISTIE | Section.EXPANDED);
documentationSection.setText(ViewsMessages.DocumentationPropertiesEditionPart_DocumentationGroupLabel);
GridData documentationSectionData = new GridData(GridData.FILL_HORIZONTAL);
documentationSectionData.horizontalSpan = 3;
documentationSection.setLayoutData(documentationSectionData);
Composite documentationGroup = widgetFactory.createComposite(documentationSection);
GridLayout documentationGroupLayout = new GridLayout();
documentationGroupLayout.numColumns = 3;
documentationGroup.setLayout(documentationGroupLayout);
documentationSection.setClient(documentationGroup);
return documentationGroup;
}
protected Composite createDocumentationTextarea(FormToolkit widgetFactory, Composite parent) {
Label documentationLabel = createDescription(parent, ViewsViewsRepository.Documentation.Documentation_.documentation__, ViewsMessages.DocumentationPropertiesEditionPart_DocumentationLabel);
GridData documentationLabelData = new GridData(GridData.FILL_HORIZONTAL);
documentationLabelData.horizontalSpan = 3;
documentationLabel.setLayoutData(documentationLabelData);
documentation = widgetFactory.createText(parent, "", SWT.BORDER | SWT.WRAP | SWT.MULTI | SWT.V_SCROLL); //$NON-NLS-1$
GridData documentationData = new GridData(GridData.FILL_HORIZONTAL);
documentationData.horizontalSpan = 2;
documentationData.heightHint = 80;
documentationData.widthHint = 200;
documentation.setLayoutData(documentationData);
documentation.addFocusListener(new FocusAdapter() {
/**
* {@inheritDoc}
*
* @see org.eclipse.swt.events.FocusAdapter#focusLost(org.eclipse.swt.events.FocusEvent)
*
*/
public void focusLost(FocusEvent e) {
if (propertiesEditionComponent != null) {
propertiesEditionComponent.firePropertiesChanged(new PropertiesEditionEvent(
DocumentationPropertiesEditionPartForm.this,
ViewsViewsRepository.Documentation.Documentation_.documentation__,
PropertiesEditionEvent.COMMIT, PropertiesEditionEvent.SET, null, documentation.getText()));
propertiesEditionComponent
.firePropertiesChanged(new PropertiesEditionEvent(
DocumentationPropertiesEditionPartForm.this,
ViewsViewsRepository.Documentation.Documentation_.documentation__,
PropertiesEditionEvent.FOCUS_CHANGED, PropertiesEditionEvent.FOCUS_LOST,
null, documentation.getText()));
}
}
/**
* @see org.eclipse.swt.events.FocusAdapter#focusGained(org.eclipse.swt.events.FocusEvent)
*/
@Override
public void focusGained(FocusEvent e) {
if (propertiesEditionComponent != null) {
propertiesEditionComponent
.firePropertiesChanged(new PropertiesEditionEvent(
DocumentationPropertiesEditionPartForm.this,
null,
PropertiesEditionEvent.FOCUS_CHANGED, PropertiesEditionEvent.FOCUS_GAINED,
null, null));
}
}
});
EditingUtils.setID(documentation, ViewsViewsRepository.Documentation.Documentation_.documentation__);
EditingUtils.setEEFtype(documentation, "eef::Textarea"); //$NON-NLS-1$
FormUtils.createHelpButton(widgetFactory, parent, propertiesEditionComponent.getHelpContent(ViewsViewsRepository.Documentation.Documentation_.documentation__, ViewsViewsRepository.FORM_KIND), null); //$NON-NLS-1$
// Start of user code for createDocumentationTextArea
// End of user code
return parent;
}
/**
* {@inheritDoc}
*
* @see org.eclipse.emf.eef.runtime.api.notify.IPropertiesEditionListener#firePropertiesChanged(org.eclipse.emf.eef.runtime.api.notify.IPropertiesEditionEvent)
*
*/
public void firePropertiesChanged(IPropertiesEditionEvent event) {
// Start of user code for tab synchronization
// Nothing to do
// End of user code
}
/**
* {@inheritDoc}
*
* @see org.eclipse.emf.eef.views.parts.DocumentationPropertiesEditionPart#getDocumentation()
*
*/
public String getDocumentation() {
return documentation.getText();
}
/**
* {@inheritDoc}
*
* @see org.eclipse.emf.eef.views.parts.DocumentationPropertiesEditionPart#setDocumentation(String newValue)
*
*/
public void setDocumentation(String newValue) {
if (newValue != null) {
documentation.setText(newValue);
} else {
documentation.setText(""); //$NON-NLS-1$
}
boolean eefElementEditorReadOnlyState = isReadOnly(ViewsViewsRepository.Documentation.Documentation_.documentation__);
if (eefElementEditorReadOnlyState && documentation.isEnabled()) {
documentation.setEnabled(false);
documentation.setBackground(documentation.getDisplay().getSystemColor(SWT.COLOR_WIDGET_BACKGROUND));
documentation.setToolTipText(ViewsMessages.Documentation_ReadOnly);
} else if (!eefElementEditorReadOnlyState && !documentation.isEnabled()) {
documentation.setEnabled(true);
}
}
/**
* {@inheritDoc}
*
* @see org.eclipse.emf.eef.runtime.api.parts.IPropertiesEditionPart#getTitle()
*
*/
public String getTitle() {
return ViewsMessages.Documentation_Part_Title;
}
// Start of user code additional methods
// End of user code
}