org.eclipse.osbp.ecview.core.common/src/org/eclipse/osbp/ecview/core/common/editpart/IDialogEditpart.java

/**
 * Copyright (c) 2011, 2015 - Lunifera GmbH (Gross Enzersdorf, Austria), Loetz GmbH&Co.KG (69115 Heidelberg, Germany)
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0 
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *         Florian Pirchner - Initial implementation
 */
package org.eclipse.osbp.ecview.core.common.editpart;

import org.eclipse.osbp.ecview.core.common.editpart.binding.IBindableEndpointEditpart;
import org.eclipse.osbp.ecview.core.common.presentation.IDialogPresentation;
import org.eclipse.osbp.ecview.core.common.presentation.IWidgetPresentation;

// TODO: Auto-generated Javadoc
/**
 * The abstraction for a dialog.
 */
public interface IDialogEditpart extends IElementEditpart, IEmbeddableParent {

	/**
	 * Returns the parent of this dialog.<br>
	 * Will be <code>null</code> for the layout that is attached to the view as
	 * content.
	 * 
	 * @return editpart The parent editpart
	 */
	IViewEditpart getParent();

	/**
	 * Returns the view edit part of this dialog edit part.<br>
	 * May be <code>null</code> as far as this element and no of its parents are
	 * attached to a view.
	 * 
	 * @return editpart The view editpart
	 */
	IViewEditpart getView();

	/**
	 * Returns the widget presentation for the dialog.
	 * 
	 * @param <A>
	 *            An instance of {@link IWidgetPresentation}
	 * @return presentation The presentation of that dialog used to render the
	 *         UI.
	 */
	<A extends IDialogPresentation<?>> A getPresentation();

	/**
	 * Requests rendering of the current editpart. This method will forward the
	 * request to the parent if available and the parent will handle the steps
	 * required to render the editpart properly.
	 */
	void requestRender();

	/**
	 * This method is called by the parent presentation to render the contents
	 * of the editpart.
	 * 
	 * @param parentWidget
	 *            - The parent widget the new widget will be placed on.
	 * @return newWidget - without adding it to the parentWidget.
	 */
	Object render(Object parentWidget);

	/**
	 * Requests unrendering of the current editpart. This method will forward
	 * the request to the parent if available and the parent will handle the
	 * steps required to unrender the editpart properly.
	 */
	void requestUnrender();

	/**
	 * This method is called by the parent editpart and tells the current
	 * editpart, that it should unrender its presentation now.
	 */
	void unrender();

	/**
	 * Returns true, if the editparts presentation is rendered.
	 *
	 * @return true, if is rendered
	 */
	boolean isRendered();

	/**
	 * Returns the rendered widget by the editparts presentation. Will return
	 * <code>null</code> if the presentation was not rendered yet.
	 *
	 * @return the widget
	 */
	Object getWidget();

	/**
	 * Requests disposal of the current editpart. This method will forward the
	 * request to the parent if available and the parent will handle the steps
	 * required to dispose the editpart properly.
	 */
	void requestDispose();

	/**
	 * Sets the input data binding endpoint.
	 * 
	 * @param inputData
	 *            this object contains information about the input data of the
	 *            target navigation page.
	 */
	@Deprecated // use model instead
	void setInputDataBindingEndpoint(IBindableEndpointEditpart inputData);

}