ErrorModelLibraryPropertySection.java

/**
 * Copyright (c) 2004-2025 Carnegie Mellon University and others. (see Contributors file).
 * All Rights Reserved.
 *
 * NO WARRANTY. ALL MATERIAL IS FURNISHED ON AN "AS-IS" BASIS. CARNEGIE MELLON UNIVERSITY MAKES NO WARRANTIES OF ANY
 * KIND, EITHER EXPRESSED OR IMPLIED, AS TO ANY MATTER INCLUDING, BUT NOT LIMITED TO, WARRANTY OF FITNESS FOR PURPOSE
 * OR MERCHANTABILITY, EXCLUSIVITY, OR RESULTS OBTAINED FROM USE OF THE MATERIAL. CARNEGIE MELLON UNIVERSITY DOES NOT
 * MAKE ANY WARRANTY OF ANY KIND WITH RESPECT TO FREEDOM FROM PATENT, TRADEMARK, OR COPYRIGHT INFRINGEMENT.
 *
 * This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 * SPDX-License-Identifier: EPL-2.0
 *
 * Created, in part, with funding and support from the United States Government. (see Acknowledgments file).
 *
 * This program includes and/or can make use of certain third party source code, object code, documentation and other
 * files ("Third Party Software"). The Third Party Software that is used by this program is dependent upon your system
 * configuration. By using this program, You agree to comply with any and all relevant Third Party Software terms and
 * conditions contained in any such Third Party Software or separate license file distributed with such Third Party
 * Software. The parties who own the Third Party Software ("Third Party Licensors") are intended third party benefici-
 * aries to this license with respect to the terms applicable to their Third Party Software. Third Party Software li-
 * censes only apply to the Third Party Software and not any other portion of this program or this program as a whole.
 */
package org.osate.ge.errormodel.ui.properties;

import org.eclipse.core.runtime.Adapters;
import org.eclipse.jface.viewers.IFilter;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.swt.layout.FormAttachment;
import org.eclipse.swt.layout.FormData;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.views.properties.tabbed.AbstractPropertySection;
import org.eclipse.ui.views.properties.tabbed.ITabbedPropertyConstants;
import org.eclipse.ui.views.properties.tabbed.TabbedPropertySheetPage;
import org.osate.aadl2.AadlPackage;
import org.osate.ge.BusinessObjectSelection;
import org.osate.ge.errormodel.ui.viewmodels.ExtendedLibrariesModel;
import org.osate.ge.errormodel.util.ErrorModelGeUtil;
import org.osate.ge.swt.SwtUtil;
import org.osate.ge.swt.selectors.ListEditor;
import org.osate.ge.ui.PropertySectionUtil;
import org.osate.ge.ui.UiBusinessObjectSelection;
import org.osate.xtext.aadl2.errormodel.errorModel.ErrorModelLibrary;

/**
 * Property section for {@link ErrorModelLibrary} elements
 */
public class ErrorModelLibraryPropertySection extends AbstractPropertySection {
	/**
	 * Filter which determines if the property section is compatible with an object.
	 */
	public static class Filter implements IFilter {
		@Override
		public boolean select(final Object toTest) {
			// Only support this property section for packages which contain an error model library
			return PropertySectionUtil.isBoCompatible(toTest, bo -> bo instanceof AadlPackage
					&& ErrorModelGeUtil.getErrorModelLibrary((AadlPackage) bo).isPresent());
		}
	}

	private static final String WIDGET_ID_PREFIX = "org.osate.ge.errormodel.ui.properties.errorModelLibrary.";

	/**
	 * Testing ID of the list containing the extended error model libraries
	 * @see SwtUtil#getTestingId(org.eclipse.swt.widgets.Widget)
	 */
	public static final String WIDGET_ID_EXTENDED_LIBRARIES_LIST = WIDGET_ID_PREFIX + "extendedLibraries.label";

	/**
	 * Testing ID of the button for adding an error model library to the extended library list
	 * @see SwtUtil#getTestingId(org.eclipse.swt.widgets.Widget)
	 */
	public static final String WIDGET_ID_EXTENDED_LIBRARIES_ADD_BUTTON = WIDGET_ID_PREFIX + "extendedLibraries.add";

	/**
	 * Testing ID of the button which removes an error model library from the extended library list
	 * @see SwtUtil#getTestingId(org.eclipse.swt.widgets.Widget)
	 */
	public static final String WIDGET_ID_EXTENDED_LIBRARIES_REMOVE_BUTTON = WIDGET_ID_PREFIX
			+ "extendedLibraries.remove";

	private BusinessObjectSelection selectedBos;
	private final ExtendedLibrariesModel model = new ExtendedLibrariesModel(new UiBusinessObjectSelection());

	@Override
	public void createControls(final Composite parent, final TabbedPropertySheetPage aTabbedPropertySheetPage) {
		super.createControls(parent, aTabbedPropertySheetPage);
		FormData fd;

		final Composite container = getWidgetFactory().createFlatFormComposite(parent);
		PropertySectionUtil.createSectionLabel(container, getWidgetFactory(), "Extended\nError Libraries:");

		final ListEditor<ErrorModelLibrary> extendedLibrariesField = new ListEditor<>(container, model);
		extendedLibrariesField.setListTestingId(WIDGET_ID_EXTENDED_LIBRARIES_LIST);
		extendedLibrariesField.setAddButtonTestingId(WIDGET_ID_EXTENDED_LIBRARIES_ADD_BUTTON);
		extendedLibrariesField.setRemoveButtonTestingId(WIDGET_ID_EXTENDED_LIBRARIES_REMOVE_BUTTON);

		fd = new FormData();
		fd.left = new FormAttachment(0, STANDARD_LABEL_WIDTH);
		fd.top = new FormAttachment(0, ITabbedPropertyConstants.VSPACE);
		fd.width = 200;
		fd.height = 100;
		extendedLibrariesField.setLayoutData(fd);
	}

	@Override
	public void setInput(final IWorkbenchPart part, final ISelection selection) {
		super.setInput(part, selection);
		selectedBos = Adapters.adapt(selection, BusinessObjectSelection.class);
	}

	@Override
	public void refresh() {
		model.setBusinessObjectSelection(selectedBos);
	}
}