blob: 7adfc7558c0fa3db1ab97d412e0b86a9848e4d17 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2010, 2017 BestSolution.at and others.
* 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:
* Tom Schindl <tom.schindl@bestsolution.at> - initial API and implementation
* Lars Vogel <Lars.Vogel@gmail.com> - Ongoing maintenance
* Steven Spungin <steven@spungin.tv> - Bug 424730, Bug 437951
* Olivier Prouvost <olivier@opcoach.com> - Bug 472658
******************************************************************************/
package org.eclipse.e4.tools.emf.ui.internal.common.component;
import java.util.ArrayList;
import java.util.List;
import javax.inject.Inject;
import org.eclipse.core.databinding.UpdateValueStrategy;
import org.eclipse.core.databinding.conversion.Converter;
import org.eclipse.core.databinding.observable.list.IObservableList;
import org.eclipse.core.databinding.observable.list.WritableList;
import org.eclipse.core.databinding.observable.value.IObservableValue;
import org.eclipse.core.databinding.observable.value.WritableValue;
import org.eclipse.core.databinding.property.value.IValueProperty;
import org.eclipse.core.resources.IProject;
import org.eclipse.e4.core.contexts.IEclipseContext;
import org.eclipse.e4.core.di.annotations.Optional;
import org.eclipse.e4.tools.emf.ui.common.ImageTooltip;
import org.eclipse.e4.tools.emf.ui.common.Util;
import org.eclipse.e4.tools.emf.ui.common.component.AbstractComponentEditor;
import org.eclipse.e4.tools.emf.ui.internal.Messages;
import org.eclipse.e4.tools.emf.ui.internal.ResourceProvider;
import org.eclipse.e4.tools.emf.ui.internal.common.component.ControlFactory.TextPasteHandler;
import org.eclipse.e4.tools.emf.ui.internal.common.component.dialogs.ToolItemIconDialogEditor;
import org.eclipse.e4.tools.emf.ui.internal.common.uistructure.UIViewer;
import org.eclipse.e4.ui.model.application.impl.ApplicationPackageImpl;
import org.eclipse.e4.ui.model.application.ui.impl.UiPackageImpl;
import org.eclipse.e4.ui.model.application.ui.menu.ItemType;
import org.eclipse.e4.ui.model.application.ui.menu.MMenu;
import org.eclipse.e4.ui.model.application.ui.menu.MMenuFactory;
import org.eclipse.e4.ui.model.application.ui.menu.MToolItem;
import org.eclipse.e4.ui.model.application.ui.menu.impl.MenuPackageImpl;
import org.eclipse.emf.common.command.Command;
import org.eclipse.emf.databinding.EMFDataBindingContext;
import org.eclipse.emf.databinding.EMFProperties;
import org.eclipse.emf.databinding.FeaturePath;
import org.eclipse.emf.databinding.edit.EMFEditProperties;
import org.eclipse.emf.ecore.EClass;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.util.EcoreUtil;
import org.eclipse.emf.edit.command.SetCommand;
import org.eclipse.jface.databinding.swt.IWidgetValueProperty;
import org.eclipse.jface.databinding.swt.WidgetProperties;
import org.eclipse.jface.databinding.viewers.ViewerProperties;
import org.eclipse.jface.viewers.ArrayContentProvider;
import org.eclipse.jface.viewers.ComboViewer;
import org.eclipse.jface.viewers.LabelProvider;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.CTabFolder;
import org.eclipse.swt.custom.CTabItem;
import org.eclipse.swt.custom.StackLayout;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Text;
public abstract class ToolItemEditor extends AbstractComponentEditor {
private Composite composite;
private EMFDataBindingContext context;
private StackLayout stackLayout;
private final IValueProperty TOOL_ITEM__MENU = EMFProperties.value(MenuPackageImpl.Literals.TOOL_ITEM__MENU);
@Inject
@Optional
protected IProject project;
@Inject
IEclipseContext eclipseContext;
private Button createRemoveMenu;
public ToolItemEditor() {
super();
}
@Override
public Composite doGetEditor(Composite parent, Object object) {
if (composite == null) {
context = new EMFDataBindingContext();
if (getEditor().isModelFragment()) {
composite = new Composite(parent, SWT.NONE);
stackLayout = new StackLayout();
composite.setLayout(stackLayout);
createForm(composite, context, getMaster(), false);
createForm(composite, context, getMaster(), true);
} else {
composite = createForm(parent, context, getMaster(), false);
}
}
if (getEditor().isModelFragment()) {
Control topControl;
if (Util.isImport((EObject) object)) {
topControl = composite.getChildren()[1];
} else {
topControl = composite.getChildren()[0];
}
if (stackLayout.topControl != topControl) {
stackLayout.topControl = topControl;
composite.layout(true, true);
}
}
if (createRemoveMenu != null) {
createRemoveMenu.setSelection(((MToolItem) object).getMenu() != null);
}
getMaster().setValue(object);
enableIdGenerator(UiPackageImpl.Literals.UI_LABEL__LABEL, ApplicationPackageImpl.Literals.APPLICATION_ELEMENT__ELEMENT_ID, null);
return composite;
}
protected CTabFolder createForm(Composite parent, EMFDataBindingContext context, WritableValue master, boolean isImport) {
final CTabFolder folder = new CTabFolder(parent, SWT.BOTTOM);
final CTabItem item = new CTabItem(folder, SWT.NONE);
item.setText(Messages.ModelTooling_Common_TabDefault);
parent = createScrollableContainer(folder);
item.setControl(parent.getParent());
if (getEditor().isShowXMIId() || getEditor().isLiveModel()) {
ControlFactory.createXMIId(parent, this);
}
final IWidgetValueProperty textProp = WidgetProperties.text(SWT.Modify);
if (isImport) {
ControlFactory.createFindImport(parent, Messages, this, context);
folder.setSelection(0);
return folder;
}
ControlFactory.createTextField(parent, Messages.ModelTooling_Common_Id, master, context, textProp, EMFEditProperties.value(getEditingDomain(), ApplicationPackageImpl.Literals.APPLICATION_ELEMENT__ELEMENT_ID));
createFormSubTypeForm(parent, folder, context, master);
if (project == null) {
createUITreeInspection(folder);
}
createContributedEditorTabs(folder, context, getMaster(), MToolItem.class);
folder.setSelection(0);
return folder;
}
private void createUITreeInspection(CTabFolder folder) {
final CTabItem item = new CTabItem(folder, SWT.NONE);
item.setText(Messages.ModelTooling_Common_RuntimeWidgetTree);
final Composite container = new Composite(folder, SWT.NONE);
container.setLayout(new GridLayout());
item.setControl(container);
final UIViewer objectViewer = new UIViewer();
final TreeViewer viewer = objectViewer.createViewer(container, UiPackageImpl.Literals.UI_ELEMENT__WIDGET, getMaster(), resourcePool, Messages);
viewer.getControl().setLayoutData(new GridData(GridData.FILL_BOTH));
}
protected void createFormSubTypeForm(Composite parent, CTabFolder folder, EMFDataBindingContext context, final WritableValue master) {
final IWidgetValueProperty textProp = WidgetProperties.text(SWT.Modify);
final IWidgetValueProperty checkProp = WidgetProperties.selection();
final IWidgetValueProperty enabled = WidgetProperties.enabled();
// ------------------------------------------------------------
{
final Label l = new Label(parent, SWT.NONE);
l.setText(Messages.ToolItemEditor_Type);
l.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_END));
final ComboViewer viewer = new ComboViewer(parent);
viewer.setContentProvider(new ArrayContentProvider());
viewer.setInput(new ItemType[] { ItemType.CHECK, ItemType.PUSH, ItemType.RADIO });
final GridData gd = new GridData();
gd.horizontalSpan = 2;
viewer.getControl().setLayoutData(gd);
final IObservableValue itemTypeObs = EMFEditProperties.value(getEditingDomain(), MenuPackageImpl.Literals.ITEM__TYPE).observeDetail(master);
context.bindValue(ViewerProperties.singleSelection().observe(viewer), itemTypeObs);
}
ControlFactory.createTextField(parent, Messages.ToolItemEditor_Label, master, context, textProp, EMFEditProperties.value(getEditingDomain(), UiPackageImpl.Literals.UI_LABEL__LABEL));
ControlFactory.createTextField(parent, Messages.ModelTooling_UIElement_AccessibilityPhrase, getMaster(), context, textProp, EMFEditProperties.value(getEditingDomain(), UiPackageImpl.Literals.UI_ELEMENT__ACCESSIBILITY_PHRASE));
ControlFactory.createTextField(parent, Messages.ToolItemEditor_ToolTip, master, context, textProp, EMFEditProperties.value(getEditingDomain(), UiPackageImpl.Literals.UI_LABEL__TOOLTIP));
// ------------------------------------------------------------
{
final Label l = new Label(parent, SWT.NONE);
l.setText(Messages.ToolItemEditor_IconURI);
l.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_END));
final Text t = new Text(parent, SWT.BORDER);
TextPasteHandler.createFor(t);
t.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
context.bindValue(textProp.observe(t), EMFEditProperties.value(getEditingDomain(), UiPackageImpl.Literals.UI_LABEL__ICON_URI).observeDetail(master));
new ImageTooltip(t, Messages, this);
final Button b = new Button(parent, SWT.PUSH | SWT.FLAT);
b.setText(Messages.ModelTooling_Common_FindEllipsis);
b.setImage(createImage(ResourceProvider.IMG_Obj16_zoom));
b.setLayoutData(new GridData(GridData.FILL, GridData.CENTER, false, false));
b.addSelectionListener(new SelectionAdapter() {
@Override
public void widgetSelected(SelectionEvent e) {
final ToolItemIconDialogEditor dialog = new ToolItemIconDialogEditor(b.getShell(), eclipseContext, project, getEditingDomain(), (MToolItem) getMaster().getValue(), Messages);
dialog.open();
}
});
}
{
final Label l = new Label(parent, SWT.NONE);
l.setText(Messages.ToolItemEditor_Menu);
l.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_END));
createRemoveMenu = new Button(parent, SWT.CHECK);
createRemoveMenu.addSelectionListener(new SelectionAdapter() {
@Override
public void widgetSelected(SelectionEvent e) {
final MToolItem item = (MToolItem) getMaster().getValue();
if (item.getMenu() == null) {
addMenu();
} else {
removeMenu();
}
}
});
createRemoveMenu.setLayoutData(new GridData(GridData.BEGINNING, GridData.CENTER, false, false, 2, 1));
}
{
final Label l = new Label(parent, SWT.NONE);
l.setText(Messages.ToolItemEditor_Enabled);
l.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_END));
final Button b = new Button(parent, SWT.CHECK);
b.setLayoutData(new GridData(GridData.BEGINNING, GridData.CENTER, false, false, 2, 1));
context.bindValue(checkProp.observe(b), EMFEditProperties.value(getEditingDomain(), MenuPackageImpl.Literals.ITEM__ENABLED).observeDetail(getMaster()));
}
{
final Label l = new Label(parent, SWT.NONE);
l.setText(Messages.ToolItemEditor_Selected);
l.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_END));
final Button b = new Button(parent, SWT.CHECK);
b.setLayoutData(new GridData(GridData.BEGINNING, GridData.CENTER, false, false, 2, 1));
context.bindValue(checkProp.observe(b), EMFEditProperties.value(getEditingDomain(), MenuPackageImpl.Literals.ITEM__SELECTED).observeDetail(getMaster()));
final UpdateValueStrategy t2m = new UpdateValueStrategy();
t2m.setConverter(new Converter(boolean.class, ItemType.class) {
@Override
public Object convert(Object fromObject) {
return null;
}
});
final UpdateValueStrategy m2t = new UpdateValueStrategy();
m2t.setConverter(new Converter(ItemType.class, boolean.class) {
@Override
public Object convert(Object fromObject) {
return fromObject == ItemType.CHECK || fromObject == ItemType.RADIO;
}
});
context.bindValue(enabled.observe(b), EMFEditProperties.value(getEditingDomain(), MenuPackageImpl.Literals.ITEM__TYPE).observeDetail(getMaster()), t2m, m2t);
}
{
final Label l = new Label(parent, SWT.NONE);
l.setText(Messages.ModelTooling_UIElement_VisibleWhen);
l.setLayoutData(new GridData(GridData.HORIZONTAL_ALIGN_END));
final ComboViewer combo = new ComboViewer(parent);
combo.getControl().setLayoutData(new GridData(GridData.FILL, GridData.CENTER, true, false, 2, 1));
combo.setContentProvider(new ArrayContentProvider());
combo.setLabelProvider(new LabelProvider() {
@Override
public String getText(Object element) {
if (element instanceof EClass) {
final EClass eClass = (EClass) element;
return eClass.getName();
}
return super.getText(element);
}
});
final List<Object> list = new ArrayList<>();
list.add(Messages.ToolItemEditor_NoExpression);
list.add(UiPackageImpl.Literals.CORE_EXPRESSION);
list.add(UiPackageImpl.Literals.IMPERATIVE_EXPRESSION);
list.addAll(getEditor().getFeatureClasses(UiPackageImpl.Literals.EXPRESSION, UiPackageImpl.Literals.UI_ELEMENT__VISIBLE_WHEN));
combo.setInput(list);
context.bindValue(ViewerProperties.singleSelection().observe(combo), EMFEditProperties.value(getEditingDomain(), UiPackageImpl.Literals.UI_ELEMENT__VISIBLE_WHEN).observeDetail(getMaster()), new UpdateValueStrategy().setConverter(new EClass2EObject(Messages)), new UpdateValueStrategy().setConverter(new EObject2EClass(Messages)));
}
// ------------------------------------------------------------
createSubTypeFormElements(parent, context, master);
ControlFactory.createCheckBox(parent, Messages.ModelTooling_UIElement_ToBeRendered, getMaster(), context, WidgetProperties.selection(), EMFEditProperties.value(getEditingDomain(), UiPackageImpl.Literals.UI_ELEMENT__TO_BE_RENDERED));
ControlFactory.createCheckBox(parent, Messages.ModelTooling_UIElement_Visible, getMaster(), context, WidgetProperties.selection(), EMFEditProperties.value(getEditingDomain(), UiPackageImpl.Literals.UI_ELEMENT__VISIBLE));
final CTabItem item = new CTabItem(folder, SWT.NONE);
item.setText(Messages.ModelTooling_Common_TabSupplementary);
parent = createScrollableContainer(folder);
item.setControl(parent.getParent());
ControlFactory.createStringListWidget(parent, Messages, this, Messages.ModelTooling_ApplicationElement_Tags, ApplicationPackageImpl.Literals.APPLICATION_ELEMENT__TAGS, VERTICAL_LIST_WIDGET_INDENT);
ControlFactory.createMapProperties(parent, Messages, this, Messages.ModelTooling_Contribution_PersistedState, ApplicationPackageImpl.Literals.APPLICATION_ELEMENT__PERSISTED_STATE, VERTICAL_LIST_WIDGET_INDENT);
}
protected void createSubTypeFormElements(Composite parent, EMFDataBindingContext context, WritableValue master) {
}
void removeMenu() {
final Command cmd = SetCommand.create(getEditingDomain(), getMaster().getValue(), MenuPackageImpl.Literals.TOOL_ITEM__MENU, null);
if (cmd.canExecute()) {
getEditingDomain().getCommandStack().execute(cmd);
}
}
void addMenu() {
final MMenu menu = MMenuFactory.INSTANCE.createMenu();
setElementId(menu);
final Command cmd = SetCommand.create(getEditingDomain(), getMaster().getValue(), MenuPackageImpl.Literals.TOOL_ITEM__MENU, menu);
if (cmd.canExecute()) {
getEditingDomain().getCommandStack().execute(cmd);
}
}
@Override
public IObservableList getChildList(final Object element) {
final WritableList list = new WritableList();
final MToolItem item = (MToolItem) element;
if (item.getMenu() != null) {
list.add(0, item.getMenu());
}
TOOL_ITEM__MENU.observe(element).addValueChangeListener(event -> {
if (event.diff.getOldValue() != null) {
list.remove(event.diff.getOldValue());
if (getMaster().getValue() == element && !createRemoveMenu.isDisposed()) {
createRemoveMenu.setSelection(false);
}
}
if (event.diff.getNewValue() != null) {
list.add(0, event.diff.getNewValue());
if (getMaster().getValue() == element && !createRemoveMenu.isDisposed()) {
createRemoveMenu.setSelection(true);
}
}
});
return list;
}
@Override
public String getDetailLabel(Object element) {
final MToolItem item = (MToolItem) element;
final String l = getLocalizedLabel(item);
if (l != null && l.trim().length() > 0) {
return l;
} else if (item.getTooltip() != null && item.getTooltip().trim().length() > 0) {
return item.getTooltip();
}
return null;
}
@Override
public FeaturePath[] getLabelProperties() {
return new FeaturePath[] { FeaturePath.fromList(UiPackageImpl.Literals.UI_LABEL__LABEL),
FeaturePath.fromList(UiPackageImpl.Literals.UI_LABEL__ICON_URI),
FeaturePath.fromList(UiPackageImpl.Literals.UI_ELEMENT__TO_BE_RENDERED) };
}
static class EObject2EClass extends Converter {
private final Messages Messages;
public EObject2EClass(Messages Messages) {
super(EObject.class, EClass.class);
this.Messages = Messages;
}
@Override
public Object convert(Object fromObject) {
if (fromObject == null) {
return Messages.MenuItemEditor_NoExpression;
}
return ((EObject) fromObject).eClass();
}
}
static class EClass2EObject extends Converter {
private final Messages Messages;
public EClass2EObject(Messages Messages) {
super(EClass.class, EObject.class);
this.Messages = Messages;
}
@Override
public Object convert(Object fromObject) {
if (fromObject == null || fromObject.toString().equals(Messages.MenuItemEditor_NoExpression)) {
return null;
}
return EcoreUtil.create((EClass) fromObject);
}
}
}