org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/ui/editors/AbstractTaskEditorPageFactory.java

/*******************************************************************************
 * Copyright (c) 2004, 2013 Tasktop Technologies and others.
 * 
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * https://www.eclipse.org/legal/epl-2.0
 * 
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     Tasktop Technologies - initial API and implementation
 *******************************************************************************/

package org.eclipse.mylyn.tasks.ui.editors;

import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.swt.graphics.Image;
import org.eclipse.ui.IPluginContribution;
import org.eclipse.ui.forms.editor.IFormPage;

/**
 * @since 3.0
 * @author Steffen Pingel
 */
public abstract class AbstractTaskEditorPageFactory implements IPluginContribution {

	public static final int PRIORITY_ADDITIONS = 100;

	public static final int PRIORITY_CONTEXT = 20;

	public static final int PRIORITY_PLANNING = 10;

	public static final int PRIORITY_TASK = 30;

	private String id;

	private String pluginId;

	public abstract boolean canCreatePageFor(@NonNull TaskEditorInput input);

	@NonNull
	public abstract IFormPage createPage(@NonNull TaskEditor parentEditor);

	@Nullable
	public String[] getConflictingIds(@NonNull TaskEditorInput input) {
		return null;
	}

	@Nullable
	public String getId() {
		return id;
	}

	// TODO EDITOR life cycle of image?
	@NonNull
	public abstract Image getPageImage();

	@NonNull
	public abstract String getPageText();

	public int getPriority() {
		return PRIORITY_ADDITIONS;
	}

	public void setId(String id) {
		this.id = id;
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @since 3.2
	 */
	@Nullable
	public final String getLocalId() {
		return getId();
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @since 3.2
	 * @see #setPluginId(String)
	 */
	@Nullable
	public final String getPluginId() {
		return pluginId;
	}

	/**
	 * @since 3.2
	 * @see #getPluginId()
	 */
	public final void setPluginId(@Nullable String pluginId) {
		this.pluginId = pluginId;
	}

	/**
	 * Clients should override to provide an image for <code>page</code>. Invokes {@link #getPageImage()} for backwards
	 * compatibility.
	 * 
	 * @param editor
	 *            the task editor instance
	 * @param page
	 *            the page that uses the image
	 * @return an image
	 * @since 3.10
	 */
	@NonNull
	public Image getPageImage(@NonNull TaskEditor editor, @NonNull IFormPage page) {
		return getPageImage();
	}

	/**
	 * Clients should override to provide a label for <code>page</code>. Invokes {@link #getPageText()} for backwards
	 * compatibility.
	 * 
	 * @param editor
	 *            the task editor instance
	 * @param page
	 *            the page that uses the label
	 * @return a label
	 * @since 3.10
	 */
	@NonNull
	public String getPageText(@NonNull TaskEditor editor, @NonNull IFormPage page) {
		return getPageText();
	}

}