TooltipContributorContext.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.ui;

import java.util.Objects;

import org.eclipse.swt.widgets.Composite;
import org.osate.ge.BusinessObjectContext;

/**
 * Provides context information to {@link TooltipContributor} methods.
 * @noextend This class is not intended to be subclassed by clients.
 * @since 2.0
 */
public class TooltipContributorContext {
	private final Composite tooltip;
	private final BusinessObjectContext boc;

	/**
	 * Create a new instance.
	 * @param tooltip the SWT composite which will be displayed as the tooltip
	 * @param boc is the business object context for which to contribute tooltip information
	 */
	public TooltipContributorContext(final Composite tooltip, final BusinessObjectContext boc) {
		this.tooltip = Objects.requireNonNull(tooltip, "tooltip must not be null");
		this.boc = Objects.requireNonNull(boc, "boc must not be null");
	}

	/**
	 * Composite to which to add widgets.
	 * @return the composite to which to add widgets.
	 */
	public Composite getTooltip() {
		return tooltip;
	}

	/**
	 * Provides access to the business object context for which the tooltip contributor is being called.
	 * @return the business object context
	 */
	public BusinessObjectContext getBusinessObjectContext() {
		return boc;
	}
}