Skip navigation links

oracle.adf.view.rich.component.rich.data
Class RichCalendar

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
oracle.adf.view.rich.component.UIXCalendar
oracle.adf.view.rich.component.rich.data.RichCalendar

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class RichCalendar

extends UIXCalendar

implements javax.faces.component.NamingContainer

WARNINGThe calendar component is under development. It is not complete, and all api's are subject to change.

The calendar component provides the user the ability to view a user's activities by day, week, or month. The component fires events to allow the application developer to create and delete activities.

The calendar supports several facets, all of which should contain popups. There is more specific documentation about the facets in the "Supported Facets" section.

<section name="Geometry_Management"> <html:ul> <html:li>This component can be stretched by a parent layout component that stretches its children, e.g., the panelStretchLayout.</html:li> <html:li>If this component is not a child of a parent layout component that stretches its children, it will have a default width and height, and cannot be stretched by the end user. You can override the default width and height if the calendar component is not being stretched by a parent component by setting the inlineStyle attribute, e.g., inlineStyle="width:300px; height: 400px". If the component is being stretched by a parent component and you try to override the default width and height then you may accidentally specify one or more indeterminate dimensions without knowing it (e.g. having all non-auto values for width, left, and right and/or all non-auto values for height, top, and bottom). </html:li> </html:ul> </section> <section name="Low_Level_Events"> <html:p> The calendar does not fire "high level" events, for example it does not fire specific events for edit, delete, create, context menu, etc. Instead calendar fires the "low level" Calendar and CalendarActivity events. </html:p> <html:p> Let's take a calendarActivity. A calendarActivityEvent will be queued if the user does any of the following on a calendarActivity <html:ul> <html:li>clicks</html:li> <html:li>focuses and presses enter</html:li> <html:li>focuses and presses delete</html:li> </html:ul> Even though a calendarActivityEvent is queued for all these, you can tell these apart because keyboard, mouse, and triggerType information will also be available in the event. </html:p> </section>

Events:

Type	Phases	Description
oracle.adf.view.rich.event.CalendarActivityEvent	Invoke Application	The calendarActivity event is delivered when the user acts on a calendar activity, for example clicks on an activity. PPR behavior: The calendar does not get PPR'd automatically when this event is fired since the calendar doesn't know if anything visible will change when this event is handled. You must PPR the calendar in the event listener if the calendar needs to be re-rendered to show any visible changes, like if the user changes the activity's start time.
oracle.adf.view.rich.event.CalendarDisplayChangeEvent	Invoke Application	The calendarDisplayChange event is delivered when the calendar component changes the value of an attribute on the calendar. For example the view attribute may be changed from month to day if the user hits the day button in the toolbar. Another example is the next button in the toolbar is pressed, which causes the calendar to update the activeDay. Note that when these attributes are set by the calendar they are only set locally on the component, and the component no longer pulls the value from the EL expression. This is common practice, for example when you click on the +/- on a showDetail, disclosed is being set locally on the component to true/false by the framework. In order to save these local values you must use the change management framework. PPR behavior: Generally, if a calendarDisplayChange event is fired then the calendar will add itself as a ppr target. This is because if the calendar changes the value of activeDate or view, there is no doubt that the calendar will need to be re-rendered.
oracle.adf.view.rich.event.CalendarEvent	Invoke Application	The Calendar event is delivered when the user acts on non-activity, non-toolbar space in the calendar. PPR behavior: The calendar does not get PPR'd automatically when this event is fired since the calendar doesn't know if anything visible will change when this event is handled. You must PPR the calendar in the event listener if the calendar needs to be re-rendered to show any visible changes, like if a new activity was created.
oracle.adf.view.rich.event.CalendarActivityChangeDurationEvent	Invoke Application	The calendarActivityChangeDuration event is delivered when the user changes the duration of a calendar activity by resizing it.
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	ACTIVE_DAY_KEY
static java.lang.String	ACTIVITY_CONTEXT_MENU_FACET
static java.lang.String	ACTIVITY_DELETE_FACET
static java.lang.String	ACTIVITY_DETAIL_FACET
static java.lang.String	ACTIVITY_HOVER_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	ACTIVITY_STYLES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CALENDAR_ACTIVITY_CHANGE_DURATION_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CALENDAR_ACTIVITY_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CALENDAR_DISPLAY_CHANGE_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CALENDAR_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_ATTRIBUTES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_COMPONENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	CONTEXT_MENU_FACET
static java.lang.String	CREATE_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LIST_COUNT_KEY
static java.lang.String	LIST_TYPE_DAY
static java.lang.String	LIST_TYPE_DAY_COUNT
static org.apache.myfaces.trinidad.bean.PropertyKey	LIST_TYPE_KEY
static java.lang.String	LIST_TYPE_MONTH
static java.lang.String	LIST_TYPE_WEEK
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static java.lang.String	START_DAY_OF_WEEK_FRI
static org.apache.myfaces.trinidad.bean.PropertyKey	START_DAY_OF_WEEK_KEY
static java.lang.String	START_DAY_OF_WEEK_MON
static java.lang.String	START_DAY_OF_WEEK_SAT
static java.lang.String	START_DAY_OF_WEEK_SUN
static java.lang.String	START_DAY_OF_WEEK_THU
static java.lang.String	START_DAY_OF_WEEK_TUE
static java.lang.String	START_DAY_OF_WEEK_WED
static org.apache.myfaces.trinidad.bean.PropertyKey	START_HOUR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TIME_ZONE_KEY
static java.lang.String	TOOLBOX_LAYOUT_ALL
static java.lang.String	TOOLBOX_LAYOUT_DATES
static org.apache.myfaces.trinidad.bean.PropertyKey	TOOLBOX_LAYOUT_KEY
static java.lang.String	TOOLBOX_LAYOUT_NEWLINE
static java.lang.String	TOOLBOX_LAYOUT_RANGE
static java.lang.String	TOOLBOX_LAYOUT_STRETCH
static java.lang.String	TOOLBOX_LAYOUT_VIEWS
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static java.lang.String	VIEW_DAY
static org.apache.myfaces.trinidad.bean.PropertyKey	VIEW_KEY
static java.lang.String	VIEW_LIST
static java.lang.String	VIEW_MONTH
static org.apache.myfaces.trinidad.bean.PropertyKey	VISIBLE_KEY

Fields inherited from class oracle.adf.view.rich.component.UIXCalendar

VALUE_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

	RichCalendar() Construct an instance of the RichCalendar.
protected	RichCalendar(java.lang.String rendererType) Construct an instance of the RichCalendar.

Method Summary

void	addCalendarActivityChangeDurationListener(CalendarActivityChangeDurationListener listener) Adds a calendarActivityChangeDuration listener.
void	addCalendarActivityListener(CalendarActivityListener listener) Adds a calendarActivity listener.
void	addCalendarDisplayChangeListener(CalendarDisplayChangeListener listener) Adds a calendarDisplayChange listener.
void	addCalendarListener(CalendarListener listener) Adds a calendar listener.
void	broadcast(javax.faces.event.FacesEvent event)
java.util.Date	getActiveDay() Gets The activeDay drives the display range shown, and must be changed in order to show a new display range.
javax.faces.component.UIComponent	getActivityContextMenu() the activityContextMenu facet is opened when you right click on an activity.
javax.faces.component.UIComponent	getActivityDelete() The activityDelete facet is opened if the activity has focus and delete is pressed.
javax.faces.component.UIComponent	getActivityDetail() The activityDetail facet is opened when you click or double click on an activity.
javax.faces.component.UIComponent	getActivityHover() the activityHover facet is opened when you hover over an activity.
java.util.Map	getActivityStyles() Gets Allows per activity instance style customization.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
javax.el.MethodExpression	getCalendarActivityChangeDurationListener() Gets a method reference to a calendarActivityChangeDuration listener.
CalendarActivityChangeDurationListener[]	getCalendarActivityChangeDurationListeners() Returns an array of attached calendarActivityChangeDuration listeners.
javax.el.MethodExpression	getCalendarActivityListener() Gets a method reference to a calendarActivity listener.
CalendarActivityListener[]	getCalendarActivityListeners() Returns an array of attached calendarActivity listeners.
javax.el.MethodExpression	getCalendarDisplayChangeListener() Gets a method reference to a calendarDisplayChange listener.
CalendarDisplayChangeListener[]	getCalendarDisplayChangeListeners() Returns an array of attached calendarDisplayChange listeners.
javax.el.MethodExpression	getCalendarListener() Gets a method reference to a calendar event listener.
CalendarListener[]	getCalendarListeners() Returns an array of attached calendar listeners.
java.util.Set	getClientAttributes() Gets a set of client attribute names.
ClientListenerSet	getClientListeners() Gets a set of client listeners.
javax.faces.component.UIComponent	getContextMenu() The contextMenu facet is opened when you right click on the calendar, except if you are in the toolbar or on an activity.
javax.faces.component.UIComponent	getCreate() The create facet is brought up when you click or double click on free space (not on an activity) on the calendar.
java.lang.String	getCustomizationId() Gets The id used to locate this component when applying persistent customizations.
java.lang.String	getFamily()
java.lang.String	getInlineStyle() Gets the CSS styles to use for this component.
int	getListCount() Gets This is the number of days to show in list view when the listType is dayCount
java.lang.String	getListType() Gets Drives which activities are displayed in list view.
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
java.lang.String	getShortDesc() Gets the short description of the component.
java.lang.String	getStartDayOfWeek() Gets Returns the start day of the week in month view.
int	getStartHour() Gets The start hour that is scrolled into view.
java.lang.String	getStyleClass() Gets a CSS style class to use for this component.
java.util.TimeZone	getTimeZone() Gets The timezone to use for this instance.
java.lang.String[]	getToolboxLayout() Gets Allows control over the layout of the toolbar.
java.lang.String	getView() Gets calendar view: day, month, or list
boolean	isClientComponent() Gets whether a client-side component will be generated.
boolean	isVisible() Gets the visibility of the component.
void	removeCalendarActivityChangeDurationListener(CalendarActivityChangeDurationListener listener) Removes a calendarActivityChangeDuration listener.
void	removeCalendarActivityListener(CalendarActivityListener listener) Removes a calendarActivity listener.
void	removeCalendarDisplayChangeListener(CalendarDisplayChangeListener listener) Removes a calendarDisplayChange listener.
void	removeCalendarListener(CalendarListener listener) Removes a calendar listener.
void	setActiveDay(java.util.Date activeDay) Sets The activeDay drives the display range shown, and must be changed in order to show a new display range.
void	setActivityContextMenu(javax.faces.component.UIComponent activityContextMenuFacet) the activityContextMenu facet is opened when you right click on an activity.
void	setActivityDelete(javax.faces.component.UIComponent activityDeleteFacet) The activityDelete facet is opened if the activity has focus and delete is pressed.
void	setActivityDetail(javax.faces.component.UIComponent activityDetailFacet) The activityDetail facet is opened when you click or double click on an activity.
void	setActivityHover(javax.faces.component.UIComponent activityHoverFacet) the activityHover facet is opened when you hover over an activity.
void	setActivityStyles(java.util.Map activityStyles) Sets Allows per activity instance style customization.
void	setCalendarActivityChangeDurationListener(javax.el.MethodExpression calendarActivityChangeDurationListener) Sets a method reference to a calendarActivityChangeDuration listener.
void	setCalendarActivityListener(javax.el.MethodExpression calendarActivityListener) Sets a method reference to a calendarActivity listener.
void	setCalendarDisplayChangeListener(javax.el.MethodExpression calendarDisplayChangeListener) Sets a method reference to a calendarDisplayChange listener.
void	setCalendarListener(javax.el.MethodExpression calendarListener) Sets a method reference to a calendar event listener.
void	setClientAttributes(java.util.Set clientAttributes) Sets a set of client attribute names.
void	setClientComponent(boolean clientComponent) Sets whether a client-side component will be generated.
void	setClientListeners(ClientListenerSet clientListeners) Sets a set of client listeners.
void	setContextMenu(javax.faces.component.UIComponent contextMenuFacet) The contextMenu facet is opened when you right click on the calendar, except if you are in the toolbar or on an activity.
void	setCreate(javax.faces.component.UIComponent createFacet) The create facet is brought up when you click or double click on free space (not on an activity) on the calendar.
void	setCustomizationId(java.lang.String customizationId) Sets The id used to locate this component when applying persistent customizations.
void	setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component.
void	setListCount(int listCount) Sets This is the number of days to show in list view when the listType is dayCount
void	setListType(java.lang.String listType) Sets Drives which activities are displayed in list view.
void	setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the component.
void	setStartDayOfWeek(java.lang.String startDayOfWeek) Sets Returns the start day of the week in month view.
void	setStartHour(int startHour) Sets The start hour that is scrolled into view.
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component.
void	setTimeZone(java.util.TimeZone timeZone) Sets The timezone to use for this instance.
void	setToolboxLayout(java.lang.String[] toolboxLayout) Sets Allows control over the layout of the toolbar.
void	setView(java.lang.String view) Sets calendar view: day, month, or list
void	setVisible(boolean visible) Sets the visibility of the component.

Methods inherited from class oracle.adf.view.rich.component.UIXCalendar

getValue, setValue

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren

Methods inherited from class javax.faces.component.UIComponent

getContainerClientId, invokeOnComponent

Methods inherited from class java.lang.Object

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

Field Detail

VIEW_DAY

public static final java.lang.String VIEW_DAY

See Also:

Constant Field Values

VIEW_MONTH

public static final java.lang.String VIEW_MONTH

See Also:

Constant Field Values

VIEW_LIST

public static final java.lang.String VIEW_LIST

See Also:

Constant Field Values

LIST_TYPE_DAY

public static final java.lang.String LIST_TYPE_DAY

See Also:

Constant Field Values

LIST_TYPE_WEEK

public static final java.lang.String LIST_TYPE_WEEK

See Also:

Constant Field Values

LIST_TYPE_MONTH

public static final java.lang.String LIST_TYPE_MONTH

See Also:

Constant Field Values

LIST_TYPE_DAY_COUNT

public static final java.lang.String LIST_TYPE_DAY_COUNT

See Also:

Constant Field Values

START_DAY_OF_WEEK_SUN

public static final java.lang.String START_DAY_OF_WEEK_SUN

See Also:

Constant Field Values

START_DAY_OF_WEEK_MON

public static final java.lang.String START_DAY_OF_WEEK_MON

See Also:

Constant Field Values

START_DAY_OF_WEEK_TUE

public static final java.lang.String START_DAY_OF_WEEK_TUE

See Also:

Constant Field Values

START_DAY_OF_WEEK_WED

public static final java.lang.String START_DAY_OF_WEEK_WED

See Also:

Constant Field Values

START_DAY_OF_WEEK_THU

public static final java.lang.String START_DAY_OF_WEEK_THU

See Also:

Constant Field Values

START_DAY_OF_WEEK_FRI

public static final java.lang.String START_DAY_OF_WEEK_FRI

See Also:

Constant Field Values

START_DAY_OF_WEEK_SAT

public static final java.lang.String START_DAY_OF_WEEK_SAT

See Also:

Constant Field Values

TOOLBOX_LAYOUT_ALL

public static final java.lang.String TOOLBOX_LAYOUT_ALL

See Also:

Constant Field Values

TOOLBOX_LAYOUT_DATES

public static final java.lang.String TOOLBOX_LAYOUT_DATES

See Also:

Constant Field Values

TOOLBOX_LAYOUT_VIEWS

public static final java.lang.String TOOLBOX_LAYOUT_VIEWS

See Also:

Constant Field Values

TOOLBOX_LAYOUT_NEWLINE

public static final java.lang.String TOOLBOX_LAYOUT_NEWLINE

See Also:

Constant Field Values

TOOLBOX_LAYOUT_STRETCH

public static final java.lang.String TOOLBOX_LAYOUT_STRETCH

See Also:

Constant Field Values

TOOLBOX_LAYOUT_RANGE

public static final java.lang.String TOOLBOX_LAYOUT_RANGE

See Also:

Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY

CUSTOMIZATION_ID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY

CLIENT_COMPONENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY

CLIENT_ATTRIBUTES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

VIEW_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VIEW_KEY

ACTIVE_DAY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ACTIVE_DAY_KEY

START_HOUR_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey START_HOUR_KEY

LIST_TYPE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LIST_TYPE_KEY

LIST_COUNT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LIST_COUNT_KEY

START_DAY_OF_WEEK_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey START_DAY_OF_WEEK_KEY

TIME_ZONE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey TIME_ZONE_KEY

ACTIVITY_STYLES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ACTIVITY_STYLES_KEY

TOOLBOX_LAYOUT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey TOOLBOX_LAYOUT_KEY

CALENDAR_ACTIVITY_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CALENDAR_ACTIVITY_LISTENER_KEY

CALENDAR_DISPLAY_CHANGE_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CALENDAR_DISPLAY_CHANGE_LISTENER_KEY

CALENDAR_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CALENDAR_LISTENER_KEY

CALENDAR_ACTIVITY_CHANGE_DURATION_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CALENDAR_ACTIVITY_CHANGE_DURATION_LISTENER_KEY

CREATE_FACET

public static final java.lang.String CREATE_FACET

See Also:

Constant Field Values

CONTEXT_MENU_FACET

public static final java.lang.String CONTEXT_MENU_FACET

See Also:

Constant Field Values

ACTIVITY_CONTEXT_MENU_FACET

public static final java.lang.String ACTIVITY_CONTEXT_MENU_FACET

See Also:

Constant Field Values

ACTIVITY_HOVER_FACET

public static final java.lang.String ACTIVITY_HOVER_FACET

See Also:

Constant Field Values

ACTIVITY_DETAIL_FACET

public static final java.lang.String ACTIVITY_DETAIL_FACET

See Also:

Constant Field Values

ACTIVITY_DELETE_FACET

public static final java.lang.String ACTIVITY_DELETE_FACET

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

RichCalendar

public RichCalendar()

Construct an instance of the RichCalendar.

RichCalendar

protected RichCalendar(java.lang.String rendererType)

Construct an instance of the RichCalendar.

Method Detail

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class org.apache.myfaces.trinidad.component.UIXComponentBase

Throws:

javax.faces.event.AbortProcessingException

getCreate

public final javax.faces.component.UIComponent getCreate()

The create facet is brought up when you click or double click on free space (not on an activity) on the calendar.

This facet should contain a popup, and the child of the popup should be a dialog. If you don't want to launch a popup when you click or double click free space, then don't use this facet. If no facet is present a calendarEvent will still be sent to the server and you can listen for a it and respond appropriately.

This facet can only be triggered by mouse clicks, therefore you must add custom toolbar buttons that trigger the same functionality if the calendar needs to be keyboard accessible.

setCreate

public final void setCreate(javax.faces.component.UIComponent createFacet)

The create facet is brought up when you click or double click on free space (not on an activity) on the calendar.

This facet should contain a popup, and the child of the popup should be a dialog. If you don't want to launch a popup when you click or double click free space, then don't use this facet. If no facet is present a calendarEvent will still be sent to the server and you can listen for a it and respond appropriately.

This facet can only be triggered by mouse clicks, therefore you must add custom toolbar buttons that trigger the same functionality if the calendar needs to be keyboard accessible.

getContextMenu

public final javax.faces.component.UIComponent getContextMenu()

The contextMenu facet is opened when you right click on the calendar, except if you are in the toolbar or on an activity.

This facet should contain a popup, and the child of the popup should be a menu. If this facet is specified a calendarEvent will be sent to the server for the right click. If this facet is not specified, no event will be sent to the server for the right click.

There is no built in context menu functionality provided, all menu items should be added by the developer.

This facet can only be triggered by mouse clicks, therefore you must add custom toolbar buttons that trigger the same functionality if the calendar needs to be keyboard accessible.

If this facet is not present, then no calendarEvent will be sent for a right click in a free space area.

setContextMenu

public final void setContextMenu(javax.faces.component.UIComponent contextMenuFacet)

The contextMenu facet is opened when you right click on the calendar, except if you are in the toolbar or on an activity.

This facet should contain a popup, and the child of the popup should be a menu. If this facet is specified a calendarEvent will be sent to the server for the right click. If this facet is not specified, no event will be sent to the server for the right click.

There is no built in context menu functionality provided, all menu items should be added by the developer.

This facet can only be triggered by mouse clicks, therefore you must add custom toolbar buttons that trigger the same functionality if the calendar needs to be keyboard accessible.

If this facet is not present, then no calendarEvent will be sent for a right click in a free space area.

getActivityContextMenu

public final javax.faces.component.UIComponent getActivityContextMenu()

the activityContextMenu facet is opened when you right click on an activity.

This facet should contain a popup, and the child of the popup should be a menu.

If this facet is specified a calendarActivityEvent will be sent to the server for the right click. If this facet is not specified, no event will be sent to the server for the right click.

There is no built in context menu functionality provided, all menu items should be added by the developer.

setActivityContextMenu

public final void setActivityContextMenu(javax.faces.component.UIComponent activityContextMenuFacet)

the activityContextMenu facet is opened when you right click on an activity.

This facet should contain a popup, and the child of the popup should be a menu.

If this facet is specified a calendarActivityEvent will be sent to the server for the right click. If this facet is not specified, no event will be sent to the server for the right click.

There is no built in context menu functionality provided, all menu items should be added by the developer.

getActivityHover

public final javax.faces.component.UIComponent getActivityHover()

the activityHover facet is opened when you hover over an activity. This facet should contain a popup, and the child of the popup should be a noteWindow.

If this facet is not present, then no calendarActivityEvent will be sent when the user hovers over an activity.

There will be a delay before this popup is opened such that it doesn't show up when the user quickly mouses in and back out of the activity.

setActivityHover

public final void setActivityHover(javax.faces.component.UIComponent activityHoverFacet)

the activityHover facet is opened when you hover over an activity. This facet should contain a popup, and the child of the popup should be a noteWindow.

If this facet is not present, then no calendarActivityEvent will be sent when the user hovers over an activity.

There will be a delay before this popup is opened such that it doesn't show up when the user quickly mouses in and back out of the activity.

getActivityDetail

public final javax.faces.component.UIComponent getActivityDetail()

The activityDetail facet is opened when you click or double click on an activity. It is also opened if the activity has focus and enter is pressed.

This facet should contain a popup, and the child of the popup should be a dialog. If you don't want to launch a popup for click/double click/enter, then don't use this facet. If no facet is present a calendarActivityEvent will still be sent to the server and you can listen for a it and respond appropriately.

setActivityDetail

public final void setActivityDetail(javax.faces.component.UIComponent activityDetailFacet)

The activityDetail facet is opened when you click or double click on an activity. It is also opened if the activity has focus and enter is pressed.

This facet should contain a popup, and the child of the popup should be a dialog. If you don't want to launch a popup for click/double click/enter, then don't use this facet. If no facet is present a calendarActivityEvent will still be sent to the server and you can listen for a it and respond appropriately.

getActivityDelete

public final javax.faces.component.UIComponent getActivityDelete()

The activityDelete facet is opened if the activity has focus and delete is pressed.

This facet should contain a popup, and the child of the popup should be a dialog. If you don't want to launch a popup when the user hits delete, then don't use this facet. If no facet is present a calendarActivityEvent will still be sent to the server and you can listen for a it and respond appropriately.

setActivityDelete

public final void setActivityDelete(javax.faces.component.UIComponent activityDeleteFacet)

The activityDelete facet is opened if the activity has focus and delete is pressed.

This facet should contain a popup, and the child of the popup should be a dialog. If you don't want to launch a popup when the user hits delete, then don't use this facet. If no facet is present a calendarActivityEvent will still be sent to the server and you can listen for a it and respond appropriately.

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Returns:

the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Parameters:

inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()

Gets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Parameters:

styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window.

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window.

Parameters:

shortDesc - the new shortDesc value

isVisible

public final boolean isVisible()

Gets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Returns:

the new visible value

setVisible

public final void setVisible(boolean visible)

Sets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Parameters:

visible - the new visible value

getCustomizationId

public final java.lang.String getCustomizationId()

Gets The id used to locate this component when applying persistent customizations. Components without a customizationId set can not save customizations to the persistent store. Instead, any customizations will at most only apply to the current Session. Each customizationId must be unique in the document.

Returns:

the new customizationId value

setCustomizationId

public final void setCustomizationId(java.lang.String customizationId)

Sets The id used to locate this component when applying persistent customizations. Components without a customizationId set can not save customizations to the persistent store. Instead, any customizations will at most only apply to the current Session. Each customizationId must be unique in the document.

Parameters:

customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()

Gets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Returns:

the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)

Sets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Parameters:

clientComponent - the new clientComponent value

getClientAttributes

public final java.util.Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Returns:

the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Parameters:

partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()

Gets a set of client listeners.

Returns:

the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)

Sets a set of client listeners.

Parameters:

clientListeners - the new clientListeners value

getView

public final java.lang.String getView()

Gets calendar view: day, month, or list

Returns:

the new view value

setView

public final void setView(java.lang.String view)

Sets calendar view: day, month, or list

Parameters:

view - the new view value

getActiveDay

public final java.util.Date getActiveDay()

Gets The activeDay drives the display range shown, and must be changed in order to show a new display range. For example to display the month of June 2008 in month view, the activeDay must be a day in June 2008. The activeDay is also the specific date that will be shown in day view.

When the arrows in the toolbar are used, the activeDay will be changed. For example if the arrow is pressed when the activeDay is June 8, 2009 and the view is month then the activeDay will change to July 9, 2009.

Returns:

the new activeDay value

setActiveDay

public final void setActiveDay(java.util.Date activeDay)

Sets The activeDay drives the display range shown, and must be changed in order to show a new display range. For example to display the month of June 2008 in month view, the activeDay must be a day in June 2008. The activeDay is also the specific date that will be shown in day view.

When the arrows in the toolbar are used, the activeDay will be changed. For example if the arrow is pressed when the activeDay is June 8, 2009 and the view is month then the activeDay will change to July 9, 2009.

Parameters:

activeDay - the new activeDay value

getStartHour

public final int getStartHour()

Gets The start hour that is scrolled into view. Valid values are 0-23. The default startHour is 8.

Returns:

the new startHour value

setStartHour

public final void setStartHour(int startHour)

Sets The start hour that is scrolled into view. Valid values are 0-23. The default startHour is 8.

Parameters:

startHour - the new startHour value

getListType

public final java.lang.String getListType()

Gets Drives which activities are displayed in list view.

• day - activities for the activeDay
• month - activities for the month that includes the displayDate
• all - show all activities
• dayCount - starting with the activeDay, show activities for a certain number of days. The actual number of days to show is set in the listCount attribute.

Returns:

the new listType value

setListType

public final void setListType(java.lang.String listType)

Sets Drives which activities are displayed in list view.

• day - activities for the activeDay
• month - activities for the month that includes the displayDate
• all - show all activities
• dayCount - starting with the activeDay, show activities for a certain number of days. The actual number of days to show is set in the listCount attribute.

Parameters:

listType - the new listType value

getListCount

public final int getListCount()

Gets This is the number of days to show in list view when the listType is dayCount

Returns:

the new listCount value

setListCount

public final void setListCount(int listCount)

Sets This is the number of days to show in list view when the listType is dayCount

Parameters:

listCount - the new listCount value

getStartDayOfWeek

public final java.lang.String getStartDayOfWeek()

Gets Returns the start day of the week in month view. When not set this will default based on the locale, for example it may be Sunday in the U.S., but Monday in France.

Returns:

the new startDayOfWeek value

setStartDayOfWeek

public final void setStartDayOfWeek(java.lang.String startDayOfWeek)

Sets Returns the start day of the week in month view. When not set this will default based on the locale, for example it may be Sunday in the U.S., but Monday in France.

Parameters:

startDayOfWeek - the new startDayOfWeek value

getTimeZone

public final java.util.TimeZone getTimeZone()

Gets The timezone to use for this instance. If not set, the timezone is pulled from the AdfFacesContext.

Returns:

the new timeZone value

setTimeZone

public final void setTimeZone(java.util.TimeZone timeZone)

Sets The timezone to use for this instance. If not set, the timezone is pulled from the AdfFacesContext.

Parameters:

timeZone - the new timeZone value

getActivityStyles

public final java.util.Map getActivityStyles()

Gets Allows per activity instance style customization. The type is Map<Set<String>, InstanceStyles>. The Set<String> being used for the map key will come from getTags() on CalendarActivity. The value is an instanceStyles object. Calendar skinning keys will be passed to the instanceStyle object and per activity styles returned.

For built in color ramps see CalendarActivityRamp.getActivityRamp, which returns a CalendarActivityRamp object, a subclass of InstanceStyles

Returns:

the new activityStyles value

setActivityStyles

public final void setActivityStyles(java.util.Map activityStyles)

Sets Allows per activity instance style customization. The type is Map<Set<String>, InstanceStyles>. The Set<String> being used for the map key will come from getTags() on CalendarActivity. The value is an instanceStyles object. Calendar skinning keys will be passed to the instanceStyle object and per activity styles returned.

For built in color ramps see CalendarActivityRamp.getActivityRamp, which returns a CalendarActivityRamp object, a subclass of InstanceStyles

Parameters:

activityStyles - the new activityStyles value

getToolboxLayout

public final java.lang.String[] getToolboxLayout()

Gets Allows control over the layout of the toolbar.

The built in strings the component recognizes are:

• "all" - all the buttons calendar provides by default - if "all" is in the list, other built in strings are ignored except for 'newline'
• "range" - the string showing the date range displayed
• "dates" - the buttons that change the date: today, previous, and next
• "views" - the view buttons: day, month, list
• "newline" - means put the next thing on a new line
• "stretch" - adds a stretched component

Custom toolbox content: when the calendar encounters a string in toolboxLayout that it doesn't recognize, like 'customToolboxXyz', it looks for a facet of that name and renders the content if it finds it. In the future new facets may be added to calendar. In order to avoid future name clashes strings starting with the word 'custom' should be used for custom facets. We make no guarantees for other names.

The toolboxLayout attribute allows the user to

• add as many custom toolbars as desired, for example
  • toolboxLayout="customToolbox1 all customToolbox2"
• stack as many toolbars as desired, for example
  • toolboxLayout="all newline customToolbox1 newline customToolbox2"
• show multiple rows of toolbars. for example
  • toolboxLayout="customToolbox1 newline all"
• reorder the button groups, for example
  • toolboxLayout="views stretch range dates"
• remove toolbar content that isn't desired, for example the date buttons won't show up with this:
  • toolboxLayout="views"

Returns:

the new toolboxLayout value

setToolboxLayout

public final void setToolboxLayout(java.lang.String[] toolboxLayout)

Sets Allows control over the layout of the toolbar.

The built in strings the component recognizes are:

• "all" - all the buttons calendar provides by default - if "all" is in the list, other built in strings are ignored except for 'newline'
• "range" - the string showing the date range displayed
• "dates" - the buttons that change the date: today, previous, and next
• "views" - the view buttons: day, month, list
• "newline" - means put the next thing on a new line
• "stretch" - adds a stretched component

Custom toolbox content: when the calendar encounters a string in toolboxLayout that it doesn't recognize, like 'customToolboxXyz', it looks for a facet of that name and renders the content if it finds it. In the future new facets may be added to calendar. In order to avoid future name clashes strings starting with the word 'custom' should be used for custom facets. We make no guarantees for other names.

The toolboxLayout attribute allows the user to

• add as many custom toolbars as desired, for example
  • toolboxLayout="customToolbox1 all customToolbox2"
• stack as many toolbars as desired, for example
  • toolboxLayout="all newline customToolbox1 newline customToolbox2"
• show multiple rows of toolbars. for example
  • toolboxLayout="customToolbox1 newline all"
• reorder the button groups, for example
  • toolboxLayout="views stretch range dates"
• remove toolbar content that isn't desired, for example the date buttons won't show up with this:
  • toolboxLayout="views"

Parameters:

toolboxLayout - the new toolboxLayout value

getCalendarActivityListener

public final javax.el.MethodExpression getCalendarActivityListener()

Gets a method reference to a calendarActivity listener.

Returns:

the new calendarActivityListener value

setCalendarActivityListener

public final void setCalendarActivityListener(javax.el.MethodExpression calendarActivityListener)

Sets a method reference to a calendarActivity listener.

Parameters:

calendarActivityListener - the new calendarActivityListener value

getCalendarDisplayChangeListener

public final javax.el.MethodExpression getCalendarDisplayChangeListener()

Gets a method reference to a calendarDisplayChange listener.

Returns:

the new calendarDisplayChangeListener value

setCalendarDisplayChangeListener

public final void setCalendarDisplayChangeListener(javax.el.MethodExpression calendarDisplayChangeListener)

Sets a method reference to a calendarDisplayChange listener.

Parameters:

calendarDisplayChangeListener - the new calendarDisplayChangeListener value

getCalendarListener

public final javax.el.MethodExpression getCalendarListener()

Gets a method reference to a calendar event listener.

Returns:

the new calendarListener value

setCalendarListener

public final void setCalendarListener(javax.el.MethodExpression calendarListener)

Sets a method reference to a calendar event listener.

Parameters:

calendarListener - the new calendarListener value

getCalendarActivityChangeDurationListener

public final javax.el.MethodExpression getCalendarActivityChangeDurationListener()

Gets a method reference to a calendarActivityChangeDuration listener.

Returns:

the new calendarActivityChangeDurationListener value

setCalendarActivityChangeDurationListener

public final void setCalendarActivityChangeDurationListener(javax.el.MethodExpression calendarActivityChangeDurationListener)

Sets a method reference to a calendarActivityChangeDuration listener.

Parameters:

calendarActivityChangeDurationListener - the new calendarActivityChangeDurationListener value

addCalendarActivityListener

public final void addCalendarActivityListener(CalendarActivityListener listener)

Adds a calendarActivity listener.

Parameters:

listener - the calendarActivity listener to add

removeCalendarActivityListener

public final void removeCalendarActivityListener(CalendarActivityListener listener)

Removes a calendarActivity listener.

Parameters:

listener - the calendarActivity listener to remove

getCalendarActivityListeners

public final CalendarActivityListener[] getCalendarActivityListeners()

Returns an array of attached calendarActivity listeners.

Returns:

an array of attached calendarActivity listeners.

addCalendarDisplayChangeListener

public final void addCalendarDisplayChangeListener(CalendarDisplayChangeListener listener)

Adds a calendarDisplayChange listener.

Parameters:

listener - the calendarDisplayChange listener to add

removeCalendarDisplayChangeListener

public final void removeCalendarDisplayChangeListener(CalendarDisplayChangeListener listener)

Removes a calendarDisplayChange listener.

Parameters:

listener - the calendarDisplayChange listener to remove

getCalendarDisplayChangeListeners

public final CalendarDisplayChangeListener[] getCalendarDisplayChangeListeners()

Returns an array of attached calendarDisplayChange listeners.

Returns:

an array of attached calendarDisplayChange listeners.

addCalendarListener

public final void addCalendarListener(CalendarListener listener)

Adds a calendar listener.

Parameters:

listener - the calendar listener to add

removeCalendarListener

public final void removeCalendarListener(CalendarListener listener)

Removes a calendar listener.

Parameters:

listener - the calendar listener to remove

getCalendarListeners

public final CalendarListener[] getCalendarListeners()

Returns an array of attached calendar listeners.

Returns:

an array of attached calendar listeners.

addCalendarActivityChangeDurationListener

public final void addCalendarActivityChangeDurationListener(CalendarActivityChangeDurationListener listener)

Adds a calendarActivityChangeDuration listener.

Parameters:

listener - the calendarActivityChangeDuration listener to add

removeCalendarActivityChangeDurationListener

public final void removeCalendarActivityChangeDurationListener(CalendarActivityChangeDurationListener listener)

Removes a calendarActivityChangeDuration listener.

Parameters:

listener - the calendarActivityChangeDuration listener to remove

getCalendarActivityChangeDurationListeners

public final CalendarActivityChangeDurationListener[] getCalendarActivityChangeDurationListeners()

Returns an array of attached calendarActivityChangeDuration listeners.

Returns:

an array of attached calendarActivityChangeDuration listeners.

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class UIXCalendar

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXCalendar

Skip navigation links