org.eclipse.compare.contentmergeviewer.IMergeViewerContentProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.compare Show documentation
This is org.eclipse.compare jar used by Scout SDK
The newest version!
/*******************************************************************************
 * Copyright (c) 2000, 2011 IBM Corporation 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:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.compare.contentmergeviewer;

import org.eclipse.swt.graphics.Image;
import org.eclipse.jface.viewers.IContentProvider;


/** 
 * A content provider that mediates between a ContentMergeViewer's model
 * and the viewer itself.
 * 
 * Clients may implement this interface.
 * 
 * 
 * @see ContentMergeViewer
 */
public interface IMergeViewerContentProvider extends IContentProvider {
	
	//---- ancestor side

	/**
	 * Returns the label for the ancestor side of a ContentMergeViewer.
	 *
	 * @param input the input object of the ContentMergeViewer
	 * @return the label for the ancestor side of a ContentMergeViewer
	 */
	String getAncestorLabel(Object input);

	/**
	 * Returns an optional image for the ancestor side of a ContentMergeViewer.
	 *
	 * @param input the input object of the ContentMergeViewer
	 * @return the image for the ancestor side of a ContentMergeViewer,
	 *   or null if none
	 */
	Image getAncestorImage(Object input);

	/**
	 * Returns the contents for the ancestor side of a ContentMergeViewer.
	 * The interpretation of the returned object depends on the concrete ContentMergeViewer.
	 *
	 * @param input the input object of the ContentMergeViewer
	 * @return the content for the ancestor side of a ContentMergeViewer,
	 *   or null if none
	 */
	Object getAncestorContent(Object input);

	/**
	 * Returns whether the ancestor side of the given input element should be shown.
	 * @param input the merge viewer's input
	 * @return true if the ancestor side of the given input element should be shown
	 */
	boolean showAncestor(Object input);
	
	//---- left side

	/**
	 * Returns the label for the left side of a ContentMergeViewer.
	 *
	 * @param input the input object of the ContentMergeViewer
	 * @return the label for the left side of a ContentMergeViewer
	 */
	String getLeftLabel(Object input);

	/**
	 * Returns an optional image for the left side of a ContentMergeViewer.
	 *
	 * @param input the input object of the ContentMergeViewer
	 * @return the image for the left side of a ContentMergeViewer,
	 *   or null if none
	 */
	Image getLeftImage(Object input);

	/**
	 * Returns the contents for the left side of a ContentMergeViewer.
	 * The interpretation of the returned object depends on the concrete ContentMergeViewer.
	 *
	 * @param input the input object of the ContentMergeViewer
	 * @return the content for the left side of a ContentMergeViewer,
	 *   or null if none
	 */
	Object getLeftContent(Object input);

	/**
	 * Returns whether the left side is editable.
	 *
	 * @param input the input object of the ContentMergeViewer
	 * @return true if the left side of a ContentMergeViewer is editable	 
	 */
	boolean isLeftEditable(Object input);

	/**
	 * Saves new contents for the left side of the ContentMergeViewer.
	 *
	 * @param input the input object of the ContentMergeViewer
	 * @param bytes the new contents to save for the left side
	 */
	void saveLeftContent(Object input, byte[] bytes);

	//---- right side

	/**
	 * Returns the label for the right side of a ContentMergeViewer.
	 *
	 * @param input the input object of the ContentMergeViewer
	 * @return the label for the right side of a ContentMergeViewer
	 */
	String getRightLabel(Object input);

	/**
	 * Returns an optional image for the right side of a ContentMergeViewer.
	 *
	 * @param input the input object of the ContentMergeViewer
	 * @return the image for the right side of a ContentMergeViewer,
	 *   or null if none
	 */
	Image getRightImage(Object input);

	/**
	 * Returns the contents for the right side of a ContentMergeViewer.
	 * The interpretation of the returned object depends on the concrete ContentMergeViewer.
	 *
	 * @param input the input object of the ContentMergeViewer
	 * @return the content for the right side of a ContentMergeViewer,
	 *   or null if none
	 */
	Object getRightContent(Object input);

	/**
	 * Returns whether the right side is editable.
	 *
	 * @param input the input object of the ContentMergeViewer
	 * @return true if the right side of a ContentMergeViewer is editable	 
	 */
	boolean isRightEditable(Object input);

	/**
	 * Saves new contents for the right side of the ContentMergeViewer.
	 *
	 * @param input the input object of the ContentMergeViewer
	 * @param bytes the new contents to save for the right side
	 */
	void saveRightContent(Object input, byte[] bytes);
}