| /******************************************************************************* |
| * Copyright (c) 2017 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.sirius.ui.editor.internal.pages; |
| |
| import java.net.MalformedURLException; |
| import java.net.URL; |
| import java.text.MessageFormat; |
| import java.util.stream.Collectors; |
| |
| import org.eclipse.core.runtime.IProgressMonitor; |
| import org.eclipse.emf.transaction.RecordingCommand; |
| import org.eclipse.jface.layout.GridLayoutFactory; |
| import org.eclipse.sirius.business.api.session.Session; |
| import org.eclipse.sirius.business.api.session.SessionListener; |
| import org.eclipse.sirius.business.api.session.SessionStatus; |
| import org.eclipse.sirius.ui.editor.Messages; |
| import org.eclipse.sirius.ui.editor.SessionEditor; |
| import org.eclipse.sirius.ui.editor.SessionEditorPlugin; |
| import org.eclipse.sirius.ui.editor.internal.graphicalcomponents.GraphicalRepresentationHandler; |
| import org.eclipse.sirius.ui.editor.internal.graphicalcomponents.GraphicalSemanticModelsHandler; |
| import org.eclipse.swt.SWT; |
| import org.eclipse.swt.layout.GridData; |
| import org.eclipse.swt.widgets.Composite; |
| import org.eclipse.ui.PartInitException; |
| import org.eclipse.ui.PlatformUI; |
| import org.eclipse.ui.forms.IManagedForm; |
| import org.eclipse.ui.forms.editor.FormPage; |
| import org.eclipse.ui.forms.events.HyperlinkEvent; |
| import org.eclipse.ui.forms.events.IHyperlinkListener; |
| import org.eclipse.ui.forms.widgets.FormText; |
| import org.eclipse.ui.forms.widgets.FormToolkit; |
| import org.eclipse.ui.forms.widgets.ScrolledForm; |
| import org.eclipse.ui.forms.widgets.Section; |
| |
| /** |
| * Class used to create the main page of the session editor which describe |
| * Viewpoints used, model and representations. |
| * |
| * @author jmallet |
| * @author <a href="mailto:pierre.guilet@obeo.fr">Pierre Guilet</a> |
| * |
| */ |
| public class DefaultSessionEditorPage extends FormPage implements SessionListener { |
| |
| /** |
| * The page's unique id. |
| */ |
| private static final String PAGE_ID = "org.eclipse.sirius.ui.editor.DefaultSessionEditorPage"; //$NON-NLS-1$ |
| |
| /** |
| * Delimiter used to separate text part for the page title. |
| */ |
| private static final String DELIMITER = "/"; //$NON-NLS-1$ |
| |
| /** |
| * Session to describe and edit. |
| */ |
| private Session session; |
| |
| /** |
| * Label used to provides information regarding editor's context. |
| */ |
| private FormText informativeLabel; |
| |
| /** |
| * This graphical component provides a viewer showing all semantic models |
| * loaded in the given session. |
| */ |
| private GraphicalSemanticModelsHandler graphicalModelingHandler; |
| |
| /** |
| * The graphical component providing a viewer showing all representations |
| * belonging to the given session under corresponding viewpoints objects |
| */ |
| private GraphicalRepresentationHandler graphicalRepresentationHandler; |
| |
| /** |
| * Constructor. |
| * |
| * @param editor |
| * the editor. |
| * @param theSession |
| * the session. |
| */ |
| public DefaultSessionEditorPage(SessionEditor editor, Session theSession) { |
| super(editor, PAGE_ID, Messages.UI_SessionEditor_default_page_tab_label); |
| this.session = theSession; |
| } |
| |
| @Override |
| protected void createFormContent(final IManagedForm managedForm) { |
| super.createFormContent(managedForm); |
| |
| final ScrolledForm scrolledForm = managedForm.getForm(); |
| FormToolkit toolkit = managedForm.getToolkit(); |
| |
| int sessionUriSegmentSize = session.getSessionResource().getURI().segmentsList().size(); |
| scrolledForm.setText(MessageFormat.format(Messages.UI_SessionEditor_header_title, |
| session.getSessionResource().getURI().segmentsList().subList(1, sessionUriSegmentSize).stream().collect(Collectors.joining(DELIMITER)))); // $NON-NLS-1$ |
| toolkit.decorateFormHeading(scrolledForm.getForm()); |
| |
| Composite body = managedForm.getForm().getBody(); |
| body.setLayout(GridLayoutFactory.swtDefaults().create()); |
| |
| informativeLabel = toolkit.createFormText(body, false); |
| informativeLabel.setText( |
| "<form><p>This editor is a work in progress, currently in alpha state. See <a href='https://wiki.eclipse.org/Sirius/SessionEditor'>the wiki</a> for more details and how to provide feedback.</p></form>", //$NON-NLS-1$ |
| true, true); |
| informativeLabel.addHyperlinkListener(new IHyperlinkListener() { |
| |
| @Override |
| public void linkExited(HyperlinkEvent e) { |
| } |
| |
| @Override |
| public void linkEntered(HyperlinkEvent e) { |
| } |
| |
| @Override |
| public void linkActivated(HyperlinkEvent e) { |
| try { |
| PlatformUI.getWorkbench().getBrowserSupport().getExternalBrowser().openURL(new URL(e.getHref().toString())); |
| } catch (PartInitException | MalformedURLException ex) { |
| SessionEditorPlugin.getPlugin().error("An error occured while opening the external web browser.", ex); //$NON-NLS-1$ |
| } |
| } |
| }); |
| informativeLabel.setForeground(body.getDisplay().getSystemColor(SWT.COLOR_RED)); |
| |
| Composite subBody = toolkit.createComposite(body); |
| subBody.setLayout(GridLayoutFactory.swtDefaults().numColumns(2).equalWidth(false).create()); |
| subBody.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true)); |
| |
| createModelsControl(toolkit, subBody); |
| |
| Composite rightComposite = toolkit.createComposite(subBody); |
| rightComposite.setLayout(GridLayoutFactory.swtDefaults().margins(5, 0).create()); |
| rightComposite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true)); |
| |
| createRepresentationsControl(toolkit, rightComposite); |
| |
| session.addListener(this); |
| |
| // needed when opening editor from explorer views or scrollbar is not |
| // visible if needed. |
| scrolledForm.reflow(true); |
| } |
| |
| /** |
| * Create the control allowing to view the semantic models of the session. |
| * |
| * @param toolkit |
| * the tool allowing to create form UI component. |
| * @param subBody |
| * the composite containing the viewpoint selection control. |
| */ |
| protected void createModelsControl(FormToolkit toolkit, Composite subBody) { |
| Section modelSection = toolkit.createSection(subBody, Section.DESCRIPTION | Section.TITLE_BAR); |
| modelSection.setLayout(GridLayoutFactory.swtDefaults().create()); |
| modelSection.setLayoutData(new GridData(SWT.FILL, SWT.FILL, false, false)); |
| |
| modelSection.setText(Messages.UI_SessionEditor_models_title); |
| |
| Composite modelSectionClient = toolkit.createComposite(modelSection, SWT.NONE); |
| modelSectionClient.setLayout(GridLayoutFactory.swtDefaults().numColumns(2).create()); |
| modelSectionClient.setLayoutData(new GridData(SWT.FILL, SWT.FILL, false, false)); |
| modelSection.setClient(modelSectionClient); |
| |
| graphicalModelingHandler = new GraphicalSemanticModelsHandler(session, toolkit); |
| graphicalModelingHandler.createControl(modelSectionClient); |
| getSite().setSelectionProvider(graphicalModelingHandler.getTreeViewer()); |
| |
| } |
| |
| /** |
| * Create the control allowing to view/create/remove representations of the |
| * session. |
| * |
| * @param toolkit |
| * the tool allowing to create form UI component. |
| * @param rightComposite |
| * the composite containing the viewpoint selection control. |
| */ |
| protected void createRepresentationsControl(FormToolkit toolkit, Composite rightComposite) { |
| Section representationSection = toolkit.createSection(rightComposite, Section.DESCRIPTION | Section.TITLE_BAR); |
| representationSection.setLayout(GridLayoutFactory.swtDefaults().create()); |
| representationSection.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true)); |
| representationSection.setText(MessageFormat.format(Messages.UI_SessionEditor_representation_title, new Object[0])); // $NON-NLS-1$ |
| |
| Composite representationSectionClient = toolkit.createComposite(representationSection, SWT.NONE); |
| representationSectionClient.setLayout(GridLayoutFactory.swtDefaults().numColumns(2).create()); |
| representationSectionClient.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true)); |
| representationSection.setClient(representationSectionClient); |
| |
| graphicalRepresentationHandler = new GraphicalRepresentationHandler(session, toolkit); |
| graphicalRepresentationHandler.createControl(representationSectionClient); |
| |
| } |
| |
| @Override |
| public void doSave(IProgressMonitor monitor) { |
| if (session != null) { |
| session.getTransactionalEditingDomain().getCommandStack().execute(new RecordingCommand(session.getTransactionalEditingDomain()) { |
| @Override |
| protected void doExecute() { |
| session.save(monitor); |
| } |
| }); |
| } |
| } |
| |
| @Override |
| public boolean isDirty() { |
| return session != null && session.getStatus() == SessionStatus.DIRTY; |
| } |
| |
| @Override |
| public void notify(int changeKind) { |
| switch (changeKind) { |
| case SessionListener.SYNC: |
| PlatformUI.getWorkbench().getDisplay().syncExec(new Runnable() { |
| @Override |
| public void run() { |
| getManagedForm().commit(true); |
| getManagedForm().dirtyStateChanged(); |
| } |
| }); |
| break; |
| case SessionListener.DIRTY: |
| PlatformUI.getWorkbench().getDisplay().syncExec(new Runnable() { |
| @Override |
| public void run() { |
| getManagedForm().dirtyStateChanged(); |
| } |
| }); |
| break; |
| default: |
| break; |
| } |
| } |
| |
| @Override |
| public void dispose() { |
| super.dispose(); |
| if (session != null) { |
| session.removeListener(this); |
| session = null; |
| } |
| if (graphicalModelingHandler != null) { |
| graphicalModelingHandler.dispose(); |
| graphicalModelingHandler = null; |
| } |
| if (graphicalRepresentationHandler != null) { |
| graphicalRepresentationHandler.dispose(); |
| graphicalRepresentationHandler = null; |
| } |
| } |
| |
| } |
