org.eclipse.ui.progress.IProgressConstants2 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.ui.workbench Show documentation

This is org.eclipse.ui.workbench jar used by Scout SDK

There is a newer version: 3.108.0.v20160602-1232

Show newest version

/*******************************************************************************
 * Copyright (c) 2010 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
 *     Tasktop Technologies - Bug 302529 [UX] [Progress] Show Eclipse IDE progress in the Eclipse icon on the Windows 7 Task Bar
 *******************************************************************************/
package org.eclipse.ui.progress;

import org.eclipse.core.runtime.QualifiedName;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.progress.IProgressConstants;

/**
 * Constants relating to progress UI functionality of the workbench plug-in.
 * 
 * The constants define property keys that are used to associate UI related
 * information with Jobs (org.eclipse.core.runtime.jobs.Job). This
 * class is a superset of all previously defined progress constants.
 *
 * @see org.eclipse.core.runtime.jobs.Job#setProperty
 * @see IProgressConstants
 * @since 3.6
 *
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface IProgressConstants2 extends IProgressConstants {

    /**
     * Common prefix for properties defined in this interface.
     */
    static final String PROPERTY_PREFIX = PlatformUI.PLUGIN_ID
            + ".workbench.progress"; //$NON-NLS-1$

	/**
	 * This property is used to associate a ParameterizedCommand
	 * with a Job. If the Job is shown in the UI, the command might be
	 * represented as a button or hyper link to allow the user to trigger a job
	 * specific action, like showing the Job's results.
	 * 

	 * Note: Only one of ACTION_PROPERTY or
	 * COMMAND_PROPERTY should be used
	 * 
	 *
	 * @see org.eclipse.core.commands.ParameterizedCommand
	 **/
	public static final QualifiedName COMMAND_PROPERTY = new QualifiedName(
			PROPERTY_PREFIX, "command"); //$NON-NLS-1$

	/**
	 * This property provides a hint to the progress UI to show the progress of
	 * the job in the application TaskBar
	 * 
	 * The property must be of type Boolean and the hint is used if
	 * its value is true.
	 * 
	 */
	public static final QualifiedName SHOW_IN_TASKBAR_ICON_PROPERTY = new QualifiedName(
			PROPERTY_PREFIX, "inTaskBarIcon"); //$NON-NLS-1$
}