org.eclipse.ui.cheatsheets
Interface ICompositeCheatSheetTask

All Known Subinterfaces:

IEditableTask, ITaskGroup

public interface ICompositeCheatSheetTask

A task within a composite cheat sheet.

This interface is not intended to be implemented by clients.

Since:

3.2

Field Summary

static int	COMPLETED The constant that indicates that the task has been completed.
static int	IN_PROGRESS The constant that indicates that the task is in progress.
static int	NOT_STARTED The constant that indicates that the task has not been processed yet.
static int	SKIPPED The constant that indicates that the task has been skipped.

Method Summary

String	getCompletionMessage() Gets the text to be displayed when this task is completed
ICompositeCheatSheet	getCompositeCheatSheet() Get the enclosing composite cheat sheet
String	getDescription() Returns the description of the task.
String	getId()
String	getKind() Returns the kind of the task editor or task group.
String	getName()
Dictionary	getParameters() The task parameters are used to configure the task editor with data meaningful to an editor of this kind.
ICompositeCheatSheetTask[]	getRequiredTasks() get the tasks which are required to be completed before this task is started.
int	getState() Get the state of this task
ICompositeCheatSheetTask[]	getSubtasks() Get the subtasks of this task.
boolean	requiredTasksCompleted() Determine whether the required tasks for this task have all been completed.

Field Detail

NOT_STARTED

public static final int NOT_STARTED

The constant that indicates that the task has not been processed yet.

See Also:

Constant Field Values

IN_PROGRESS

public static final int IN_PROGRESS

The constant that indicates that the task is in progress.

See Also:

Constant Field Values

SKIPPED

public static final int SKIPPED

The constant that indicates that the task has been skipped.

See Also:

Constant Field Values

COMPLETED

public static final int COMPLETED

The constant that indicates that the task has been completed.

See Also:

Constant Field Values

Method Detail

getId

public String getId()

Returns:

the unique identifier of this task.

getName

public String getName()

Returns:

the translatable name of the task.

getKind

public String getKind()

Returns the kind of the task editor or task group.

Returns:

task editor kind or null if no editor is assoticated with this task.

getParameters

public Dictionary getParameters()

The task parameters are used to configure the task editor with data meaningful to an editor of this kind.

Returns:

the parameter names and values as specified in the composite cheatsheet content file.

getDescription

public String getDescription()

Returns the description of the task.

Returns:

a plain String, or XML markup that can be understood by FormText widget.

See Also:

FormText

getCompletionMessage

public String getCompletionMessage()

Gets the text to be displayed when this task is completed

Returns:

a plain String, or XML markup that can be understood by FormText widget.

See Also:

FormText

getSubtasks

public ICompositeCheatSheetTask[] getSubtasks()

Get the subtasks of this task. Each subtask may be a task group or editable task. If the task is an editable task there will be no children and an empty array will be returned.

Returns:

an array of subtasks for this task

getRequiredTasks

public ICompositeCheatSheetTask[] getRequiredTasks()

get the tasks which are required to be completed before this task is started.

Returns:

an array of tasks that must be completed before this task can be started. The array will be empty if this tasks is independent of other tasks.

requiredTasksCompleted

public boolean requiredTasksCompleted()

Determine whether the required tasks for this task have all been completed.

Returns:

true if there are noi required tasks or all required tasks have been completed.

getState

public int getState()

Get the state of this task

Returns:

NOT_STARTED, IN_PROGRESS, SKIPPED or COMPLETED.

getCompositeCheatSheet

public ICompositeCheatSheet getCompositeCheatSheet()

Get the enclosing composite cheat sheet

Returns:

the composite cheat sheet which contains this task