com.googlecode.wicket.kendo.ui.scheduler

Class SchedulerEvent

java.lang.Object

com.googlecode.wicket.kendo.ui.scheduler.SchedulerEvent

All Implemented Interfaces:

Serializable

public class SchedulerEvent
extends Object
implements Serializable

Provides a scheduler event that can be used with a SchedulerModel
If the IDs are not numbers, the datasource's schema need to reflect the type. ie:

 
 // Scheduler
 protected void onConfigure(SchedulerDataSource dataSource)
 {
        super.onConfigure(dataSource);
 
        Options options = SchedulerDataSource.newSchemaFields();
        options.set("id", "{ type: 'string' }"); // override default type for event-id
 
        dataSource.set("schema", String.format("{ model: { fields: %s } }", options));
 }

 
 

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SchedulerEvent(Number id, String title, Date start) Constructor The end date will be the start date + DEFAULT_RANGE hour(s)
SchedulerEvent(Number id, String title, Date start, Date end) Constructor
SchedulerEvent(Number id, String title, long start) Constructor The end date will be the start date + DEFAULT_RANGE hour(s)
SchedulerEvent(Number id, String title, long start, long end) Constructor
SchedulerEvent(Object id, String title, Date start) Constructor The end date will be the start date + DEFAULT_RANGE hour(s) Caution: if the id is not a number, the datasource's schema need to reflect the type
SchedulerEvent(Object id, String title, Date start, Date end) Constructor Caution: if the id is not a number, the datasource's schema need to reflect the type
SchedulerEvent(Object id, String title, long start) Constructor The end date will be the start date + DEFAULT_RANGE hour(s) Caution: if the id is not a number, the datasource's schema need to reflect the type
SchedulerEvent(Object id, String title, long start, long end) Constructor Caution: if the id is not a number, the datasource's schema need to reflect the type

Method Summary

Modifier and Type	Method and Description
void	accept(ISchedulerVisitor visitor) Visitor accept method
String	getDescription() Gets the text description of the scheduler event
Date	getEnd() Sets the date at which the event ends
Set<String>	getFields() Gets the event related fields
Object	getId() Gets the unique identifier of the scheduler event
<T> T	getId(Class<T> type) Gets the unique identifier of the scheduler event Caution: not type-safe
String	getRecurrenceException() Gets the recurrence exception
String	getRecurrenceId() Gets the id of the recurrence parent.
String	getRecurrenceRule() Gets the recurrence rule which describes the repetition pattern of the event.
Date	getStart() Sets the date at which the event starts
String	getTitle() Gets the title of the event which is displayed in the scheduler views
Object	getValue(String field) Gets a field value
Object	getValue(String field, Object defaultValue) Gets a field value
boolean	isAllDay() Indicates whether the event is "all day" or not
static boolean	isNew(SchedulerEvent event)
boolean	isVisible() Indicates whether the event is visible If false, it will not be added to the JSON response
void	setAllDay(boolean allDay) Sets if the event is "all day" or not
void	setDescription(String description) Sets the text description of the scheduler event
void	setEnd(Date date) Gets the date at which the event ends
void	setEnd(long date) Gets the date at which the event ends
void	setId(Object id) Sets the unique identifier of the scheduler event
void	setRecurrenceException(String exception) Sets the recurrence exception
void	setRecurrenceId(String id) Sets the id of the recurrence parent.
void	setRecurrenceRule(String rule) Sets the recurrence rule which describes the repetition pattern of the event.
void	setStart(Date date) Sets the date at which the event starts
void	setStart(long date) Sets the date at which the event starts
void	setTitle(String title) Sets the title of the event which is displayed in the scheduler views
void	setValue(String field, Object value) Sets a resource value
void	setVisible(boolean visible) Sets whether the event is visible
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SchedulerEvent

public SchedulerEvent(Object id,
                      String title,
                      Date start)

Constructor
The end date will be the start date + DEFAULT_RANGE hour(s)
Caution: if the id is not a number, the datasource's schema need to reflect the type

Parameters:

id - the event id

title - the event title

start - the start date

SchedulerEvent

public SchedulerEvent(Object id,
                      String title,
                      long start)

Constructor
The end date will be the start date + DEFAULT_RANGE hour(s)
Caution: if the id is not a number, the datasource's schema need to reflect the type

Parameters:

id - the event id

title - the event title

start - the start date

SchedulerEvent

public SchedulerEvent(Object id,
                      String title,
                      Date start,
                      Date end)

Constructor
Caution: if the id is not a number, the datasource's schema need to reflect the type

Parameters:

id - the event id

title - the event title

start - the start date

end - the end date

SchedulerEvent

public SchedulerEvent(Object id,
                      String title,
                      long start,
                      long end)

Constructor
Caution: if the id is not a number, the datasource's schema need to reflect the type

Parameters:

id - the event id

title - the event title

start - the start date

end - the end date

SchedulerEvent

public SchedulerEvent(Number id,
                      String title,
                      Date start)

Constructor
The end date will be the start date + DEFAULT_RANGE hour(s)

Parameters:

id - the event id

title - the event title

start - the start date

SchedulerEvent

public SchedulerEvent(Number id,
                      String title,
                      long start)

Constructor
The end date will be the start date + DEFAULT_RANGE hour(s)

Parameters:

id - the event id

title - the event title

start - the start date

SchedulerEvent

public SchedulerEvent(Number id,
                      String title,
                      Date start,
                      Date end)

Constructor

Parameters:

id - the event id

title - the event title

start - the start date

end - the end date

SchedulerEvent

public SchedulerEvent(Number id,
                      String title,
                      long start,
                      long end)

Constructor

Parameters:

id - the event id

title - the event title

start - the start date

end - the end date

Method Detail

getId

public Object getId()

Gets the unique identifier of the scheduler event

Returns:

the id

getId

public <T> T getId(Class<T> type)

Gets the unique identifier of the scheduler event
Caution: not type-safe

Type Parameters:

T - the type

Parameters:

type - the class type

Returns:

the id, casted to the supplied type (unchecked)

setId

public void setId(Object id)

Sets the unique identifier of the scheduler event

Parameters:

id - the id

getTitle

public String getTitle()

Gets the title of the event which is displayed in the scheduler views

Returns:

the title

setTitle

public void setTitle(String title)

Sets the title of the event which is displayed in the scheduler views

Parameters:

title - the title

getDescription

public String getDescription()

Gets the text description of the scheduler event

Returns:

the description

setDescription

public void setDescription(String description)

Sets the text description of the scheduler event

Parameters:

description - the description

getStart

public Date getStart()

Sets the date at which the event starts

Returns:

the start date

setStart

public void setStart(Date date)

Sets the date at which the event starts

Parameters:

date - the start date

setStart

public void setStart(long date)

Sets the date at which the event starts

Parameters:

date - the start date

getEnd

public Date getEnd()

Sets the date at which the event ends

Returns:

the end date

setEnd

public void setEnd(Date date)

Gets the date at which the event ends

Parameters:

date - the end date

setEnd

public void setEnd(long date)

Gets the date at which the event ends

Parameters:

date - the end date

isAllDay

public boolean isAllDay()

Indicates whether the event is "all day" or not

Returns:

true or false

setAllDay

public void setAllDay(boolean allDay)

Sets if the event is "all day" or not

Parameters:

allDay - true or false

isVisible

public boolean isVisible()

Indicates whether the event is visible
If false, it will not be added to the JSON response

Returns:

true or false

setVisible

public void setVisible(boolean visible)

Sets whether the event is visible

Parameters:

visible - true or false

getRecurrenceId

public String getRecurrenceId()

Gets the id of the recurrence parent.

Returns:

the id of the recurrence parent

setRecurrenceId

public void setRecurrenceId(String id)

Sets the id of the recurrence parent. If set the current event is a recurrence exception.

Parameters:

id - the id of the recurrence parent

getRecurrenceRule

public String getRecurrenceRule()

Gets the recurrence rule which describes the repetition pattern of the event. Follows the rfc5545 specification.

Returns:

the recurrence rule

setRecurrenceRule

public void setRecurrenceRule(String rule)

Sets the recurrence rule which describes the repetition pattern of the event. Follows the rfc5545 specification.

Parameters:

rule - the recurrence rule

getRecurrenceException

public String getRecurrenceException()

Gets the recurrence exception

Returns:

the recurrence exception

setRecurrenceException

public void setRecurrenceException(String exception)

Sets the recurrence exception

Parameters:

exception - the recurrence exception

getFields

public Set<String> getFields()

Gets the event related fields

Returns:

the event related fields

getValue

public final Object getValue(String field)

Gets a field value

Parameters:

field - the field (ie: 'resourceId')

Returns:

the value as Object

getValue

public final Object getValue(String field,
                             Object defaultValue)

Gets a field value

Parameters:

field - the field (ie: 'resourceId')

defaultValue - the default value to return if the current one is null

Returns:

the value as Object

setValue

public final void setValue(String field,
                           Object value)

Sets a resource value

Parameters:

field - the field

value - the value

accept

public final void accept(ISchedulerVisitor visitor)

Visitor accept method

Parameters:

visitor - the ISchedulerVisitor

toString

public String toString()

Overrides:

toString in class Object

isNew

public static boolean isNew(SchedulerEvent event)