oracle.ide.todo
Class ToDoManager

java.lang.Object
  oracle.ide.todo.ToDoManager

public abstract class ToDoManager
extends java.lang.Object

The ToDoManager coordinates the management of ToDoItem data and the UI that displays it the ToDo window. In addition it defines constants to use for standardized priorities that can be used when creating a ToDoItem).

Field Summary

static int	HIGH_PRIORITY Constant for high priority that can be assigned to the ToDoItem
static int	LOW_PRIORITY Constant for low priority that can be assigned to the ToDoItem
static int	MEDIUM_PRIORITY Constant for medium priority that can be assigned to the ToDoItem
static int	NO_PRIORITY A default priority that is used when no other priority has been assigned to the ToDoItem
static java.lang.String	TODO_MANAGER_NAME

Constructor Summary

ToDoManager()

Method Summary

abstract void	add(java.util.List<ToDoItem> items) Adds an List of ToDoItems to the list of items
abstract void	add(ToDoItem[] items) Adds an array of ToDoItems to the list of items
abstract ToDoItem	createToDoItem(java.lang.String description, int priorityId, java.util.Date date) Creates a ToDoItem.
static ToDoManager	getToDoManager() Returns the ToDoManager instance that is active in the IDE
abstract void	remove(java.util.List<ToDoItem> items) Removes an List of ToDoItems from the list of items
abstract void	remove(ToDoItem[] items) Removes an array of ToDoItems from the list of items
static void	setToDoManager(ToDoManager toDoManager) Deprecated.
abstract void	setWindowVisible(boolean show) Shows/Hides the task window.

Methods inherited from class java.lang.Object

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

Field Detail

TODO_MANAGER_NAME

public static final java.lang.String TODO_MANAGER_NAME

See Also:

Constant Field Values

NO_PRIORITY

public static final int NO_PRIORITY

A default priority that is used when no other priority has been assigned to the ToDoItem

See Also:

Constant Field Values

HIGH_PRIORITY

public static final int HIGH_PRIORITY

Constant for high priority that can be assigned to the ToDoItem

See Also:

Constant Field Values

MEDIUM_PRIORITY

public static final int MEDIUM_PRIORITY

Constant for medium priority that can be assigned to the ToDoItem

See Also:

Constant Field Values

LOW_PRIORITY

public static final int LOW_PRIORITY

Constant for low priority that can be assigned to the ToDoItem

See Also:

Constant Field Values

Constructor Detail

ToDoManager

public ToDoManager()

Method Detail

getToDoManager

public static ToDoManager getToDoManager()

Returns the ToDoManager instance that is active in the IDE

setToDoManager

@Deprecated
public static void setToDoManager(ToDoManager toDoManager)

Deprecated.

Publishes the specified ToDoManager as the active instance in the IDE.

add

public abstract void add(ToDoItem[] items)

Adds an array of ToDoItems to the list of items

remove

public abstract void remove(ToDoItem[] items)

Removes an array of ToDoItems from the list of items

add

public abstract void add(java.util.List<ToDoItem> items)

Adds an List of ToDoItems to the list of items

remove

public abstract void remove(java.util.List<ToDoItem> items)

Removes an List of ToDoItems from the list of items

createToDoItem

public abstract ToDoItem createToDoItem(java.lang.String description,
                                        int priorityId,
                                        java.util.Date date)

Creates a ToDoItem. The client can then call additional methods on the ToDoItem to set data on the item. The client is responsible for adding the item to the IDE's list of items using the add() method.

Parameters:

description - to use for the task

priorityId - id to use for the task; typically one of the constants defined in ToDoManager

date - the task is to be completed

Returns:

a ToDoItem

setWindowVisible

public abstract void setWindowVisible(boolean show)

Shows/Hides the task window.