public interface IEventEditor
Modifier and Type | Field and Description |
---|---|
static int |
DISPLAYED_HOURS
The number of hours to display at a time.
|
Modifier and Type | Method and Description |
---|---|
void |
addItemDeleteHandler(CalendarableItemEventHandler deleteHandler)
Adds the handler to the collection of handlers who will
be notified when a CalendarableItem is deleted from the receiver, by sending
it one of the messages defined in the
CalendarableItemEventHandler
abstract class. |
void |
addItemDisposeHandler(CalendarableItemEventHandler itemDisposeHandler)
Adds the handler to the collection of handler who will
be notified when a CalendarableItem's control is disposed, by sending
it one of the messages defined in the
CalendarableItemEventHandler
abstract class. |
void |
addItemEditHandler(CalendarableItemEventHandler handler)
Adds the handler to the collection of handlers who will
be notified when a CalendarableItem is inserted in the receiver, by sending
it one of the messages defined in the
CalendarableItemInsertHandler
abstract class. |
void |
addItemInsertHandler(CalendarableItemEventHandler insertHandler)
Adds the handler to the collection of handlers who will
be notified when a CalendarableItem is inserted in the receiver, by sending
it one of the messages defined in the
CalendarableItemInsertHandler
abstract class. |
void |
addSelectionChangeListener(CalendarableSelectionChangeListener l)
Adds the listener to the collection of listeners who will
be notified when the receiver's selection changes, by sending
it one of the messages defined in the
CalendarableSelectionChangeListener
interface. |
boolean |
fireDelete(CalendarableItem toDelete)
Requests that the event editor delete the specified CalendarableItem's
data.
|
NewEvent |
fireInsert(java.util.Date date,
boolean allDayEvent)
Requests that the event editor attempt to insert a new element by calling
its registered insert handlers
|
int |
getNumberOfDays()
Method getNumberOfDays.
|
int |
getNumberOfDivisionsInHour()
Returns the numberOfDivisionsInHour.
|
java.util.Date |
getStartDate()
Return the current start date for this event editor.
|
void |
refresh()
Tells the IEventEditor to refresh all days in its display.
|
void |
refresh(java.util.Date date)
Tells the IEventEditor to refresh its display for the specified date.
|
void |
removeItemDeleteHandler(CalendarableItemEventHandler deleteHandler)
Removes the handler from the collection of handlers who will
be notified when a CalendarableItem is deleted from the receiver, by sending
it one of the messages defined in the
CalendarableItemEventHandler
abstract class. |
void |
removeItemDisposeHandler(CalendarableItemEventHandler itemDisposeHandler)
Removes the handler from the collection of handlers who will
be notified when a CalendarableItem is disposed, by sending
it one of the messages defined in the
CalendarableItemEventHandler
abstract class. |
void |
removeItemEditHandler(CalendarableItemEventHandler handler)
Removes the handler from the collection of handlers who will
be notified when a CalendarableItem is inserted into the receiver, by sending
it one of the messages defined in the
CalendarableItemInsertHandler
abstract class. |
void |
removeItemInsertHandler(CalendarableItemEventHandler insertHandler)
Removes the handler from the collection of handlers who will
be notified when a CalendarableItem is inserted into the receiver, by sending
it one of the messages defined in the
CalendarableItemInsertHandler
abstract class. |
void |
removeSelectionChangeListener(CalendarableSelectionChangeListener l)
Removes the listener from the collection of listeners who will
be notified when the receiver's selection changes, by sending
it one of the messages defined in the
CalendarableSelectionChangeListener
interface. |
void |
setEventContentProvider(EventContentProvider eventContentProvider)
Sets the strategy pattern object that can set the properties of the event
objects in order to display the data associated with the specified event.
|
void |
setEventCountProvider(EventCountProvider eventCountProvider)
Set the strategy pattern object that can return how many events to
display for specific periods of time.
|
void |
setStartDate(java.util.Date startDate)
Set the start date for this event editor.
|
void |
setTimeBreakdown(int numberOfDays,
int numberOfDivisionsInHour)
Method setTimeBreakdown.
|
static final int DISPLAYED_HOURS
void setTimeBreakdown(int numberOfDays, int numberOfDivisionsInHour)
This method may be executed exactly once. Executing more than once will result in undefined behavior.
This method is a hint. It may be ignored by specific implementations (ie: a month view).
numberOfDays
- The number of days to display.numberOfDivisionsInHour
- 1 == one line per hour; 2 == every 1/2 hour; 4 = every 1/4
hour; etc...int getNumberOfDays()
int getNumberOfDivisionsInHour()
void setStartDate(java.util.Date startDate)
For example, a month editor would only pay attention to the month portion of the date. A multi-day editor would make the date passed be the first date edited in the set of days being visualized.
startDate
- The date representing what slice of time to visualize in the editor.
null is not permitted. Passing null will result in undefined behavior.java.util.Date getStartDate()
null
if no start date has been specified yet.void setEventCountProvider(EventCountProvider eventCountProvider)
Note that having a separate event count provider and event content provider assumes that the implementer is single-threaded and that the count can't change between calling the count provider and the content provider.
eventCountProvider
- The eventCountProvider to set.void setEventContentProvider(EventContentProvider eventContentProvider)
Note that having a separate event count provider and event content provider assumes that the implementer is single-threaded and that the count can't change between calling the count provider and the content provider.
eventContentProvider
- The eventContentProvider to set.void refresh(java.util.Date date)
date
- The date to refresh or null to refresh everything.void refresh()
void addItemInsertHandler(CalendarableItemEventHandler insertHandler)
CalendarableItemInsertHandler
abstract class.
itemInserted
is called when the CalendarableItem is inserted.
handler
- the handler which should be notifiedjava.lang.IllegalArgumentException
- org.eclipse.swt.SWTException
- CalendarableItemInsertHandler
,
removeItemInsertHandler(org.eclipse.nebula.widgets.compositetable.day.CalendarableItemEventHandler)
void removeItemInsertHandler(CalendarableItemEventHandler insertHandler)
CalendarableItemInsertHandler
abstract class.
itemInserted
is called when the CalendarableItem is inserted.
handler
- the handler which should be notifiedjava.lang.IllegalArgumentException
- org.eclipse.swt.SWTException
- CalendarableItemInsertHandler
,
addItemInsertHandler(org.eclipse.nebula.widgets.compositetable.day.CalendarableItemEventHandler)
NewEvent fireInsert(java.util.Date date, boolean allDayEvent)
date
- The date/time on which to request the insert. The actual date
on which the insert is performed may be different. This is a
HINT.allDayEvent
- Indicates if the new event should be an all-day event. This is
a HINT; the actual event inserted may be a timed event.void addItemDeleteHandler(CalendarableItemEventHandler deleteHandler)
CalendarableItemEventHandler
abstract class.
itemDeleted
is called when the CalendarableItem is deleted.
handler
- the handler which should be notifiedjava.lang.IllegalArgumentException
- org.eclipse.swt.SWTException
- CalendarableItemEventHandler
,
#removeDeleteItemHandler
boolean fireDelete(CalendarableItem toDelete)
toDelete
- The CalendarableItem to delete.void removeItemDeleteHandler(CalendarableItemEventHandler deleteHandler)
CalendarableItemEventHandler
abstract class.
itemDeleted
is called when the CalendarableItem is deleted.
handler
- the handler which should be notifiedjava.lang.IllegalArgumentException
- org.eclipse.swt.SWTException
- CalendarableItemEventHandler
,
#addDeleteItemHandler
void addItemDisposeHandler(CalendarableItemEventHandler itemDisposeHandler)
CalendarableItemEventHandler
abstract class. This is normally used to remove any data bindings
that may be attached to the (now-unused) CalendarableItem.
itemDeleted
is called when the CalendarableItem is deleted.
handler
- the handler which should be notifiedjava.lang.IllegalArgumentException
- org.eclipse.swt.SWTException
- CalendarableItemEventHandler
,
#removeCalendarableItemDisposeHandler
void removeItemDisposeHandler(CalendarableItemEventHandler itemDisposeHandler)
CalendarableItemEventHandler
abstract class. This is normally used to remove any data bindings
that may be attached to the (now-unused) CalendarableItem.
itemDeleted
is called when the CalendarableItem is deleted.
handler
- the handler which should be notifiedjava.lang.IllegalArgumentException
- org.eclipse.swt.SWTException
- CalendarableItemEventHandler
,
#removeDeleteListener
void addItemEditHandler(CalendarableItemEventHandler handler)
CalendarableItemInsertHandler
abstract class.
itemInserted
is called when the CalendarableItem is inserted.
handler
- the handler which should be notifiedjava.lang.IllegalArgumentException
- org.eclipse.swt.SWTException
- CalendarableItemInsertHandler
,
removeItemInsertHandler(org.eclipse.nebula.widgets.compositetable.day.CalendarableItemEventHandler)
void removeItemEditHandler(CalendarableItemEventHandler handler)
CalendarableItemInsertHandler
abstract class.
itemInserted
is called when the CalendarableItem is inserted.
handler
- the handler which should be notifiedjava.lang.IllegalArgumentException
- org.eclipse.swt.SWTException
- CalendarableItemInsertHandler
,
addItemInsertHandler(org.eclipse.nebula.widgets.compositetable.day.CalendarableItemEventHandler)
void addSelectionChangeListener(CalendarableSelectionChangeListener l)
CalendarableSelectionChangeListener
interface.
selectionChanged
is called when the selection changes.
listener
- the listener which should be notifiedjava.lang.IllegalArgumentException
- org.eclipse.swt.SWTException
- CalendarableSelectionChangeListener
,
removeSelectionChangeListener(org.eclipse.nebula.widgets.compositetable.day.CalendarableSelectionChangeListener)
,
SelectionChangeEvent
void removeSelectionChangeListener(CalendarableSelectionChangeListener l)
CalendarableSelectionChangeListener
interface.
selectionChanged
is called when the selection changes.
listener
- the listener which should no longer be notifiedjava.lang.IllegalArgumentException
- org.eclipse.swt.SWTException
- CalendarableSelectionChangeListener
,
addSelectionChangeListener(org.eclipse.nebula.widgets.compositetable.day.CalendarableSelectionChangeListener)
,
SelectionChangeEvent