public interface ToDoItem extends Copyable, LocatableItem, Element
ToDoItem
interface provides the API for dealing with ToDoItems.
A ToDoItem
represents some task that the user wants to track.
The interface defines a set of common data elements that will be displayed
in the log page that displays ToDoItem
s. Special care should
be taken with the data element priorityId. Priority id is an integer used to
look up a priority object. The priority object contains a description, an
integer used for ordering the priorities (so that ordering is not tied to the
alphabetic description, consider ordering High, Medium, and Low if only ordered
alphabetically), and an optional icon. Constants which can be used to represent
pre-defined priorities of High, Medium, and Low can be found in ToDoManager
.
The simplest way to create a ToDoItem
is to extend the
AbstractToDoItem
and use the methods in ToDoManager
to
manipulate the list of ToDoItem
s.
The Copyable
interface is used as the to do item is copied before
an editor to modify the to do item is opened. This allows the user to
cancel the editor after making changes without affecting the base object.
Modifier and Type | Method and Description |
---|---|
boolean |
canGoTo()
Called to determine if the to do item allows the goTo() action
|
void |
dispose()
Called when the to do item is being deleted.
|
java.util.Date |
getDate()
Gets the
Date associated with the to do item |
int |
getPriorityId()
Gets the priority id.
|
java.lang.String |
getText()
Gets the descriptive text of the to do item
|
java.lang.Object |
getUserData()
Gets the user-specified data object
|
void |
goTo()
Called when the to do item is double-clicked in the
ToDoLogPage |
boolean |
isDone()
Gets whether the to do item has been marked as complete or not
|
boolean |
isEditable()
Determines whether the to do item can be edited.
|
void |
setDate(java.util.Date date)
Sets the
Date associated with the to do item |
void |
setDone(boolean done)
Sets whether the to do item is completed or not
|
void |
setPriorityId(int priorityId)
Sets the priority id.
|
void |
setText(java.lang.String text)
Sets the descriptive text of the to do item
|
void |
setUserData(java.lang.Object userData)
Sets the user-specified data object
|
boolean |
shouldPersist()
Determines whether the IDE should persist the
ToDoItem in it's
data file. |
void |
stateChanged()
Called when the state of the ToDoItem has changed
|
getColumn, getLine, setLine
getAttributes, getChildren, getData, mayHaveChildren
getAttributedLabel, getIcon, getLongLabel, getShortLabel, getToolTipText, toString
java.lang.String getText()
void setText(java.lang.String text)
text
- the description of the to do itemboolean isDone()
void setDone(boolean done)
done
- true if the to do item is completed; false otherwisejava.util.Date getDate()
Date
associated with the to do itemDate
associated with the to do itemvoid setDate(java.util.Date date)
Date
associated with the to do itemdate
- the Date
to associate this to do item withjava.lang.Object getUserData()
void setUserData(java.lang.Object userData)
userData
- int getPriorityId()
ToDoItem
void setPriorityId(int priorityId)
ToDoManager
.
ToDoManager
provides constants for pre-defined High, Medium, and
Low priorities.priorityId
- the priority id to set on the ToDoItem
boolean isEditable()
boolean shouldPersist()
ToDoItem
in it's
data file. The IDE will use Object2Dom
to save the ToDoItem
void goTo()
ToDoLogPage
boolean canGoTo()
void dispose()
void stateChanged()