org.eclipse.ui.cheatsheets
Interface IEditableTask

All Superinterfaces:

ICompositeCheatSheetTask

public interface IEditableTask

extends ICompositeCheatSheetTask

An editable task within a composite cheatsheet. An editable task is associated with a task editor and the task editor is responsible for completing the task.

This interface is not intended to be implemented by clients.

Since:

3.2

Field Summary

Fields inherited from interface org.eclipse.ui.cheatsheets.ICompositeCheatSheetTask

COMPLETED, IN_PROGRESS, NOT_STARTED, SKIPPED

Method Summary

void	complete() Set the state of this task to COMPLETED
URL	getInputUrl(String path) Gets a URL which can be used to open the content file for this task if the content file can be specified by a path relative to the content file for the composite cheat sheet which contains it.

Methods inherited from interface org.eclipse.ui.cheatsheets.ICompositeCheatSheetTask

getCompletionMessage, getCompositeCheatSheet, getDescription, getId, getKind, getName, getParameters, getRequiredTasks, getState, getSubtasks, requiredTasksCompleted

Method Detail

complete

public void complete()

Set the state of this task to COMPLETED

getInputUrl

public URL getInputUrl(String path)
                throws MalformedURLException

Gets a URL which can be used to open the content file for this task if the content file can be specified by a path relative to the content file for the composite cheat sheet which contains it.

Parameters:

path - a relative path

Returns:

a URL which represents a location relative to the location of the content file for the composite cheat sheet.

Throws:

MalformedURLException