org.icefaces.ace.component.schedule

Class ScheduleBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIData

org.icefaces.ace.component.schedule.ScheduleBase

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.UniqueIdVendor, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, IceClientBehaviorHolder, ISchedule

Direct Known Subclasses:

Schedule

public abstract class ScheduleBase
extends javax.faces.component.UIData
implements ISchedule, IceClientBehaviorHolder

A calendar with month, week, and day views that displays events and information about them. There are multiple ways to configure the component for a more custom user experience including scrolling, side bar location, event details display mode, tooltip, twelve-hour clock, default duration, enhanced styling and others. The component uses instances of org.icefaces.ace.model.schedule.ScheduleEvent to represent events. The dates must be stored internally in UTC time. They are converted to the time zone specified by the 'timeZone' attribute to display to the user. The class org.icefaces.ace.component.schedule.ScheduleUtils contains utility functions to help with conversion.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ScheduleBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIData

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
ScheduleBase()

Method Summary

Methods

Modifier and Type	Method and Description
void	addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
java.lang.Integer	getCurrentDay() Return the value of the currentDay property.
java.lang.Integer	getCurrentMonth() Return the value of the currentMonth property.
java.lang.Integer	getCurrentYear() Return the value of the currentYear property.
java.lang.Integer	getDefaultDuration() Return the value of the defaultDuration property.
java.lang.String	getDefaultEventName()
java.lang.String	getDefaultExecute(java.lang.String event)
java.util.List	getDefaultList() Return the value of the defaultList property.
java.lang.String	getDefaultRender(java.lang.String event)
java.util.Collection<java.lang.String>	getEventNames()
java.lang.String	getFamily()
java.lang.String	getListenerArgument(java.lang.String event)
java.lang.Integer	getScrollHeight() Return the value of the scrollHeight property.
java.lang.String	getShowEventDetails() Return the value of the showEventDetails property.
java.lang.String	getSideBar() Return the value of the sideBar property.
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
java.lang.Object	getTimeZone() Return the value of the timeZone property.
java.util.Date	getViewDate() Return the value of the viewDate property.
java.lang.String	getViewMode() Return the value of the viewMode property.
boolean	isAddEvents() Return the value of the addEvents property.
boolean	isDeleteEvents() Return the value of the deleteEvents property.
boolean	isEditEvents() Return the value of the editEvents property.
boolean	isEnhancedStyling() Return the value of the enhancedStyling property.
protected boolean	isPropertySet(java.lang.String finder)
boolean	isScrollable() Return the value of the scrollable property.
boolean	isShowTooltip() Return the value of the showTooltip property.
boolean	isTwelveHourClock() Return the value of the twelveHourClock property.
void	setAddEvents(boolean addEvents) Set the value of the addEvents property.
void	setCurrentDay(java.lang.Integer currentDay) Set the value of the currentDay property.
void	setCurrentMonth(java.lang.Integer currentMonth) Set the value of the currentMonth property.
void	setCurrentYear(java.lang.Integer currentYear) Set the value of the currentYear property.
void	setDefaultDuration(java.lang.Integer defaultDuration) Set the value of the defaultDuration property.
void	setDefaultList(java.util.List defaultList) Set the value of the defaultList property.
void	setDeleteEvents(boolean deleteEvents) Set the value of the deleteEvents property.
void	setEditEvents(boolean editEvents) Set the value of the editEvents property.
void	setEnhancedStyling(boolean enhancedStyling) Set the value of the enhancedStyling property.
void	setScrollable(boolean scrollable) Set the value of the scrollable property.
void	setScrollHeight(java.lang.Integer scrollHeight) Set the value of the scrollHeight property.
void	setShowEventDetails(java.lang.String showEventDetails) Set the value of the showEventDetails property.
void	setShowTooltip(boolean showTooltip) Set the value of the showTooltip property.
void	setSideBar(java.lang.String sideBar) Set the value of the sideBar property.
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setTimeZone(java.lang.Object timeZone) Set the value of the timeZone property.
void	setTwelveHourClock(boolean twelveHourClock) Set the value of the twelveHourClock property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)
void	setViewDate(java.util.Date viewDate) Set the value of the viewDate property.
void	setViewMode(java.lang.String viewMode) Set the value of the viewMode property.

Methods inherited from class javax.faces.component.UIData

broadcast, createUniqueId, encodeBegin, getClientId, getDataModel, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, invokeOnComponent, isRowAvailable, isRowStatePreserved, markInitialState, processDecodes, processUpdates, processValidators, queueEvent, restoreState, saveState, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setRowStatePreserved, setValue, setValueBinding, setVar, visitTree

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

ScheduleBase

public ScheduleBase()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIData

setAddEvents

public void setAddEvents(boolean addEvents)

Set the value of the addEvents property.

Contents: Enable or disable the built-in event addition controls. These controls appear in the popup and sidebar event details view when clicking on an empty area of a day square or an empty time slot. Adding new events this way is only supported if the component value is an instance of any of the following four types: Array, List, Collection, and org.icefaces.ace.model.schedule.LazyScheduleEventList.

Specified by:

setAddEvents in interface ISchedule

isAddEvents

public boolean isAddEvents()

Return the value of the addEvents property.

Contents: Enable or disable the built-in event addition controls. These controls appear in the popup and sidebar event details view when clicking on an empty area of a day square or an empty time slot. Adding new events this way is only supported if the component value is an instance of any of the following four types: Array, List, Collection, and org.icefaces.ace.model.schedule.LazyScheduleEventList. Default = 'true'.

Specified by:

isAddEvents in interface ISchedule

setDefaultDuration

public void setDefaultDuration(java.lang.Integer defaultDuration)

Set the value of the defaultDuration property.

Contents: Defines the default duration (in minutes) of new events added by the user if an end date or time was not set.

Specified by:

setDefaultDuration in interface ISchedule

getDefaultDuration

public java.lang.Integer getDefaultDuration()

Return the value of the defaultDuration property.

Contents: Defines the default duration (in minutes) of new events added by the user if an end date or time was not set. Default = '60'.

Specified by:

getDefaultDuration in interface ISchedule

setDeleteEvents

public void setDeleteEvents(boolean deleteEvents)

Set the value of the deleteEvents property.

Contents: Enable or disable the built-in event deletion controls. These controls appear in the popup and sidebar event details view. Deleting events this way is only supported if the component value is an instance of any of the following four types: Array, List, Collection, and org.icefaces.ace.model.schedule.LazyScheduleEventList.

Specified by:

setDeleteEvents in interface ISchedule

isDeleteEvents

public boolean isDeleteEvents()

Return the value of the deleteEvents property.

Contents: Enable or disable the built-in event deletion controls. These controls appear in the popup and sidebar event details view. Deleting events this way is only supported if the component value is an instance of any of the following four types: Array, List, Collection, and org.icefaces.ace.model.schedule.LazyScheduleEventList. Default = 'true'.

Specified by:

isDeleteEvents in interface ISchedule

setEditEvents

public void setEditEvents(boolean editEvents)

Set the value of the editEvents property.

Contents: Enable or disable the built-in event editing controls. These controls appear in the popup and sidebar event details view. Modifying events this way is only supported if the component value is an instance of any of the following three types: Array, List, and org.icefaces.ace.model.schedule.LazyScheduleEventList.

Specified by:

setEditEvents in interface ISchedule

isEditEvents

public boolean isEditEvents()

Return the value of the editEvents property.

Contents: Enable or disable the built-in event editing controls. These controls appear in the popup and sidebar event details view. Modifying events this way is only supported if the component value is an instance of any of the following three types: Array, List, and org.icefaces.ace.model.schedule.LazyScheduleEventList. Default = 'true'.

Specified by:

isEditEvents in interface ISchedule

setEnhancedStyling

public void setEnhancedStyling(boolean enhancedStyling)

Set the value of the enhancedStyling property.

Contents: Enabling applies an original styling to the day and time girds and to the events rendered on them in the month, week, and day views. This original styling makes it easier to read the information contained in the schedule by styling the contents in additional ways not covered by Themeroller themes. This styling is always the same, regardless of the theme being applied. Other parts of the schedule such as the title, sidebar and event details dialog are not affected by this styling. Setting this attribute to false prevents this original styling from being applied, leaving only the theme styling.

Specified by:

setEnhancedStyling in interface ISchedule

isEnhancedStyling

public boolean isEnhancedStyling()

Return the value of the enhancedStyling property.

Contents: Enabling applies an original styling to the day and time girds and to the events rendered on them in the month, week, and day views. This original styling makes it easier to read the information contained in the schedule by styling the contents in additional ways not covered by Themeroller themes. This styling is always the same, regardless of the theme being applied. Other parts of the schedule such as the title, sidebar and event details dialog are not affected by this styling. Setting this attribute to false prevents this original styling from being applied, leaving only the theme styling. Default = 'true'.

Specified by:

isEnhancedStyling in interface ISchedule

setScrollHeight

public void setScrollHeight(java.lang.Integer scrollHeight)

Set the value of the scrollHeight property.

Contents: Defines a fixed height for the scrollable time grid in pixels.

Specified by:

setScrollHeight in interface ISchedule

getScrollHeight

public java.lang.Integer getScrollHeight()

Return the value of the scrollHeight property.

Contents: Defines a fixed height for the scrollable time grid in pixels. Default = '600'.

Specified by:

getScrollHeight in interface ISchedule

setScrollable

public void setScrollable(boolean scrollable)

Set the value of the scrollable property.

Contents: Enabling renders the time grid of the week and day views in a container that overflows the fixed height and adds a scrollbar.

Specified by:

setScrollable in interface ISchedule

isScrollable

public boolean isScrollable()

Return the value of the scrollable property.

Contents: Enabling renders the time grid of the week and day views in a container that overflows the fixed height and adds a scrollbar.

Specified by:

isScrollable in interface ISchedule

setShowEventDetails

public void setShowEventDetails(java.lang.String showEventDetails)

Set the value of the showEventDetails property.

Contents: Specifies where to display the event details after clicking on an event tag on the calendar. Possible values are 'sidebar', 'popup', and 'disabled'.

Specified by:

setShowEventDetails in interface ISchedule

getShowEventDetails

public java.lang.String getShowEventDetails()

Return the value of the showEventDetails property.

Contents: Specifies where to display the event details after clicking on an event tag on the calendar. Possible values are 'sidebar', 'popup', and 'disabled'. Default = 'popup'.

Specified by:

getShowEventDetails in interface ISchedule

setShowTooltip

public void setShowTooltip(boolean showTooltip)

Set the value of the showTooltip property.

Contents: Specifies whether to display a tooltip next to an event, containing the event's detailed information.

Specified by:

setShowTooltip in interface ISchedule

isShowTooltip

public boolean isShowTooltip()

Return the value of the showTooltip property.

Contents: Specifies whether to display a tooltip next to an event, containing the event's detailed information. Default = 'false'.

Specified by:

isShowTooltip in interface ISchedule

setSideBar

public void setSideBar(java.lang.String sideBar)

Set the value of the sideBar property.

Contents: Specifies the location of the sidebar or whether it should be hidden. Possible values are 'right', 'left', and 'hidden'.

Specified by:

setSideBar in interface ISchedule

getSideBar

public java.lang.String getSideBar()

Return the value of the sideBar property.

Contents: Specifies the location of the sidebar or whether it should be hidden. Possible values are 'right', 'left', and 'hidden'. Default = 'right'.

Specified by:

getSideBar in interface ISchedule

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Contents: The inline style of the component, rendered on the root div of the component.

Specified by:

setStyle in interface ISchedule

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Contents: The inline style of the component, rendered on the root div of the component.

Specified by:

getStyle in interface ISchedule

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Contents: The CSS style class of the component, rendered on the root div of the component.

Specified by:

setStyleClass in interface ISchedule

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: The CSS style class of the component, rendered on the root div of the component.

Specified by:

getStyleClass in interface ISchedule

setTimeZone

public void setTimeZone(java.lang.Object timeZone)

Set the value of the timeZone property.

Contents: A time zone ID String (matching an element of java.util.TimeZone.getAvailableIDs()) or a java.util.TimeZone instance to specify the time zone used for date conversion to and from UTC time. If not specified, the default value is TimeZone.getDefault(), which is the default time zone on the system.

Specified by:

setTimeZone in interface ISchedule

getTimeZone

public java.lang.Object getTimeZone()

Return the value of the timeZone property.

Contents: A time zone ID String (matching an element of java.util.TimeZone.getAvailableIDs()) or a java.util.TimeZone instance to specify the time zone used for date conversion to and from UTC time. If not specified, the default value is TimeZone.getDefault(), which is the default time zone on the system.

Specified by:

getTimeZone in interface ISchedule

setTwelveHourClock

public void setTwelveHourClock(boolean twelveHourClock)

Set the value of the twelveHourClock property.

Contents: Enabling renders the times in the 12-hour clock format.

Specified by:

setTwelveHourClock in interface ISchedule

isTwelveHourClock

public boolean isTwelveHourClock()

Return the value of the twelveHourClock property.

Contents: Enabling renders the times in the 12-hour clock format. Default = 'false'.

Specified by:

isTwelveHourClock in interface ISchedule

setViewDate

public void setViewDate(java.util.Date viewDate)

Set the value of the viewDate property.

Contents: A Date object specifying the date that is currently displayed in the client. This attribute can be used to set an inital date to display or to programmatically set a date to display. This attribute will be automatically updated with the current date being displayed in the client as the user interacts with the component. If the current view mode is set to 'month', this Date object will be automatically changed to the first day of the given month. If the current view mode is set to 'week', this Date object will be automatically changed to the Sunday when the week starts. If the current view mode is set to 'day', this Date object will not change. The time values are irrelevant for this attribute. If this attribute is not specified, the current date is going to be used. This Date object is assumed to be in the time zone specified by the 'timeZone' attribute.

Specified by:

setViewDate in interface ISchedule

getViewDate

public java.util.Date getViewDate()

Return the value of the viewDate property.

Contents: A Date object specifying the date that is currently displayed in the client. This attribute can be used to set an inital date to display or to programmatically set a date to display. This attribute will be automatically updated with the current date being displayed in the client as the user interacts with the component. If the current view mode is set to 'month', this Date object will be automatically changed to the first day of the given month. If the current view mode is set to 'week', this Date object will be automatically changed to the Sunday when the week starts. If the current view mode is set to 'day', this Date object will not change. The time values are irrelevant for this attribute. If this attribute is not specified, the current date is going to be used. This Date object is assumed to be in the time zone specified by the 'timeZone' attribute.

Specified by:

getViewDate in interface ISchedule

setViewMode

public void setViewMode(java.lang.String viewMode)

Set the value of the viewMode property.

Contents: Specifies the range of days that should be displayed at a time in the calendar. Possible values are 'month', 'week', 'day'.

Specified by:

setViewMode in interface ISchedule

getViewMode

public java.lang.String getViewMode()

Return the value of the viewMode property.

Contents: Specifies the range of days that should be displayed at a time in the calendar. Possible values are 'month', 'week', 'day'. Default = 'month'.

Specified by:

getViewMode in interface ISchedule

setCurrentDay

public void setCurrentDay(java.lang.Integer currentDay)

Set the value of the currentDay property.

Specified by:

setCurrentDay in interface ISchedule

getCurrentDay

public java.lang.Integer getCurrentDay()

Return the value of the currentDay property.

Specified by:

getCurrentDay in interface ISchedule

setCurrentMonth

public void setCurrentMonth(java.lang.Integer currentMonth)

Set the value of the currentMonth property.

Specified by:

setCurrentMonth in interface ISchedule

getCurrentMonth

public java.lang.Integer getCurrentMonth()

Return the value of the currentMonth property.

Specified by:

getCurrentMonth in interface ISchedule

setCurrentYear

public void setCurrentYear(java.lang.Integer currentYear)

Set the value of the currentYear property.

Specified by:

setCurrentYear in interface ISchedule

getCurrentYear

public java.lang.Integer getCurrentYear()

Return the value of the currentYear property.

Specified by:

getCurrentYear in interface ISchedule

setDefaultList

public void setDefaultList(java.util.List defaultList)

Set the value of the defaultList property.

Specified by:

setDefaultList in interface ISchedule

getDefaultList

public java.util.List getDefaultList()

Return the value of the defaultList property.

Specified by:

getDefaultList in interface ISchedule

isPropertySet

protected boolean isPropertySet(java.lang.String finder)

setValueExpression

public void setValueExpression(java.lang.String name,
                      javax.el.ValueExpression binding)

Overrides:

setValueExpression in class javax.faces.component.UIData

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public java.lang.String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

getDefaultRender

public java.lang.String getDefaultRender(java.lang.String event)

Specified by:

getDefaultRender in interface IceClientBehaviorHolder

getDefaultExecute

public java.lang.String getDefaultExecute(java.lang.String event)

Specified by:

getDefaultExecute in interface IceClientBehaviorHolder

getListenerArgument

public java.lang.String getListenerArgument(java.lang.String event)

Specified by:

getListenerArgument in interface IceClientBehaviorHolder

addClientBehavior

public void addClientBehavior(java.lang.String eventName,
                     javax.faces.component.behavior.ClientBehavior behavior)

Specified by:

addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

addClientBehavior in class javax.faces.component.UIComponentBase