org.eclipse.ui.cheatsheets
Class TaskExplorer

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

public abstract class TaskExplorer

extends Object

Classes that extend this class are responsible for rendering the hierarchy of tasks in the composite cheat sheet. They must support task selection via the selection provider, be able to accept focus, and create control when asked.

Constructor Summary

TaskExplorer()

Method Summary

abstract void	createControl(Composite parent, FormToolkit toolkit) Create a control which will display the structure of the composite cheat sheet and allow tasks within the composite cheat sheet to be selected.
abstract void	dispose() Called after this explorer is no longer in use.
abstract Control	getControl() Get the control created by a previous call to createControl
abstract String	getId()
abstract ISelectionProvider	getSelectionProvider() Get the selection provider for this explorer.
abstract void	setCompositeCheatSheet(ICompositeCheatSheet compositeCheatSheet) Sets the composite cheat sheet to be displayed. createControl will already have been called.
abstract void	setFocus() Called when the explorer gains focus.
abstract void	setSelection(ISelection selection, boolean reveal) Called to set the provided selection and optionally reveal it if the scroll bars are active and the selected tasks are partially or fully hidden.
abstract void	taskUpdated(ICompositeCheatSheetTask task) Called when the state of a task changes and the representation of the task may need to be redrawn.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskExplorer

public TaskExplorer()

Method Detail

getId

public abstract String getId()

Returns:

the id of this TaskExplorer which must match the id used in the extension point

createControl

public abstract void createControl(Composite parent,
                                   FormToolkit toolkit)

Create a control which will display the structure of the composite cheat sheet and allow tasks within the composite cheat sheet to be selected.

Parameters:

parent -

toolkit -

getControl

public abstract Control getControl()

Get the control created by a previous call to createControl

Returns:

the task explorer control

setFocus

public abstract void setFocus()

Called when the explorer gains focus.

getSelectionProvider

public abstract ISelectionProvider getSelectionProvider()

Get the selection provider for this explorer. The selections returned by the selection provider should represent IGuideTasks.

Returns:

the selection provider for the task explorer

setCompositeCheatSheet

public abstract void setCompositeCheatSheet(ICompositeCheatSheet compositeCheatSheet)

Sets the composite cheat sheet to be displayed. createControl will already have been called.

Parameters:

compositeCheatSheet -

dispose

public abstract void dispose()

Called after this explorer is no longer in use. Any resources should be disposed of at this point.

taskUpdated

public abstract void taskUpdated(ICompositeCheatSheetTask task)

Called when the state of a task changes and the representation of the task may need to be redrawn.

Parameters:

task -

setSelection

public abstract void setSelection(ISelection selection,
                                  boolean reveal)

Called to set the provided selection and optionally reveal it if the scroll bars are active and the selected tasks are partially or fully hidden.

Parameters:

selection - the new selection

reveal - if true, expose the task if hidden; otherwise, just select.