org.eclipse.ui.cheatsheets
Class TaskEditor

java.lang.Object
  org.eclipse.ui.cheatsheets.TaskEditor

public abstract class TaskEditor

extends Object

An editor which provides the UI for a task within a composite cheat sheet. A task editor is responsible for saving the state of the task whenever it changes.

Since:

3.2

Constructor Summary

TaskEditor()

Method Summary

abstract void	createControl(Composite parent, FormToolkit toolkit) Creates the widget
abstract Control	getControl()
abstract void	saveState(IMemento memento) Saves the object state within a memento.
abstract void	setInput(IEditableTask task, IMemento memento) Starts editing the provided task.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskEditor

public TaskEditor()

Method Detail

createControl

public abstract void createControl(Composite parent,
                                   FormToolkit toolkit)

Creates the widget

Parameters:

parent -

toolkit -

getControl

public abstract Control getControl()

Returns:

the Control created by a previous call to CreateControl()

setInput

public abstract void setInput(IEditableTask task,
                              IMemento memento)

Starts editing the provided task. The editor is responsible for saving its state. createControl() will always be called before setInput().

Parameters:

task - The task associated with this editor

memento - The state of this task saved from a previous invocation. The memento will be null if the task has not been previously started or if it is being restarted. If the editor is being restored from a previous session the memento will contain the last saved state.

saveState

public abstract void saveState(IMemento memento)

Saves the object state within a memento.

Parameters:

memento - a memento to receive the object state