|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 2 (11.1.2.2.0) E17488-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class RichCalendar
The calendar component provides the user the ability to view a user's activities by day, week, month, or list. The 'view' attribute controls whether day, week, month, or list is shown.
The 'activeDay' attribute drives the display range shown. 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.
The value attribute of the calendar component binds to an oracle.adf.view.rich.model.CalendarModel which contains oracle.adf.view.rich.model.CalendarActivity model objects, and the calendar knows how to render a calendarActivity. The public static method CalendarModel.isActivityInRange is provided as a convenience. You should use it when you need to decide if a CalendarActivity is in a certain date range, e.g., from your implementation of CalendarModel's method getTimeActivities.
The calendar does not control how activities are created, edited, or deleted, but it does fire events to allow you to wire up creating, editing, and deleting activities. As a convenience the calendar supports several facets, all of which should contain popups. There is more specific documentation about the facets in the "Supported Facets" section.
In printable page mode the list view is shown regardless of the value of the view attribute.
<section name="Activity_Style_Customization"> <html:p> <html:p> The activityStyles attribute can be used to customize the look of an acitivty instance. The activityStyles attribute type is Map<Set<String>, InstanceStyles>. The InstanceStyles object in the map can return per activity styles. Please see the javadoc on InstanceStyles and CalendarActivityRamp for information on those classes. </html:p> <html:p> So how do we set up the activityStyles attribute so that it returns the appropriate InstanceStyles object for a given activity? Let's say we have 3 providers, "Me", "Larry", and "Ted", and we want to show the activities for these as red, orange, and blue respectively. You would create a map with the following key/value pairs and bind it to the activityStyles attribute: </html:p> <html:table><html:tbody> <html:tr> <html:th>Key(String Set)</html:th> <html:th> Value (InstanceStyles Object)</html:th> </html:tr> <html:tr> <html:td>{"Me"} </html:td> <html:td> CalendarActivityRamp.getActivityRamp(CalendarActivityRamp.RampKey.RED) </html:td> </html:tr> <html:tr> <html:td>{"Larry"} </html:td> <html:td> CalendarActivityRamp.getActivityRamp(CalendarActivityRamp.RampKey.ORANGE) </html:td> </html:tr> <html:tr> <html:td>{"Ted"} </html:td> <html:td> CalendarActivityRamp.getActivityRamp(CalendarActivityRamp.RampKey.BLUE) </html:td> </html:tr> </html:tbody></html:table> <html:p>Additionally you would set up the activities such that the string set returned from the getTags method matches the string set keys in the activityStyles map, for example: </html:p> <html:ul> <html:li>a "Me" activity returns the string set {"Me"} from the getTags() method</html:li> <html:li>a "Larry" activity returns the string set {"Larry"} from the getTags() method</html:li> <html:li>a "Ted" activity returns the string set {"Ted"} from the getTags() method</html:li> </html:ul> <html:p> During calendar rendering for each activity the renderer calls CalendarActivity.getTags to get a string set. The string set is then passed to the activityStyles map and an InstanceStyles object is returned (keep in mind that CalendarActivityRamp is a subclass of InstanceStyles), so in our example: </html:p> <html:ul> <html:li>if we pass in the string set {"Me"} we get back the red CalendarActivityRamp.</html:li> <html:li>if we pass in the string set {"Larry"} we get back the orange CalendarActivityRamp.</html:li> <html:li>if we pass in the string set {"Me"} we get back the blue CalendarActivityRamp.</html:li> </html:ul> </html:p> </section> <section name="Drag_and_Drop"> <html:p> The calendar supports 2 types of dragging. <html:ol> <html:li>Moving a calendar activity - in this case the activity is moved to a new start date/time. This type of drag and drop requires that a calendarDropTarget is attached to the calendar. If there is no calendarDropTarget then this type of drag and drop is disabled. See the calendarDropTarget doc for more information.</html:li> <html:li>Duration drag - in this case the end time is dragged to resize the activity. The calendarActivityDurationChange event is delivered when the user resizes an activity on the client. The activity is immediately moved/resized on the client and an event is queued on the server. You are expected to update the activity based on new end Dates. If there is no listener for CalendarActivityDurationChangeEvents then this type of dragging is disabled. </html:li> </html:ol> </html:p> </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>right clicks</html:li> <html:li>focuses and presses a key</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> <html:p> Although you are free to wire up your own ui response (for example showing a popup) to an event, for convenience the component has several facets that have been wired to show for common ui gestures. See the "Supported Facets" section for details. </html:p> </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. panelStretchLayout, panelSplitter.</html:li> <html:li>This component does not have support for stretching its children.</html:li> </html:ul> </section>
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: In general the calendar doesn't know if anything visible will change when this event is handled, for example if the start time is changed then the calendar needs to be ppr'ed, but if the description changes, then it does not need to be ppr'ed. Therefore in general the calendar does not add itself as a ppr target, the app developer must therefore PPR the calendar if it is needed. There is one exception when the calendar will add itself as a ppr target, which is if the CalendarActivity cannot be found in the model. For example let's say 2 users are looking at the same data. User A deletes activity 1, then User B clicks on activity 1, but the activity has been deleted, so CalendarModel.getActivity will return null. In this case the calendar will add itself as a ppr target since the end user is trying to interact with an activity that is no longer available. |
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.CalendarActivityDurationChangeEvent |
Invoke Application |
The calendarActivityDurationChange 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 event 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 |
AVAILABLE_VIEWS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CALENDAR_ACTIVITY_DURATION_CHANGE_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 Deprecated. |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DATE_CUSTOMIZER_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DONT_PERSIST_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 |
PERSIST_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 org.apache.myfaces.trinidad.bean.PropertyKey |
UNSECURE_KEY |
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 java.lang.String |
VIEW_WEEK |
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 |
---|
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY |
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 |
addCalendarActivityDurationChangeListener(CalendarActivityDurationChangeListener listener) Adds a calendarActivityDurationChange 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 |
addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior) |
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. |
java.util.List<java.lang.String> |
getAvailableViews() Gets Available calendar views. |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
javax.el.MethodExpression |
getCalendarActivityDurationChangeListener() Gets a method reference to a calendarActivityDurationChange listener. |
CalendarActivityDurationChangeListener[] |
getCalendarActivityDurationChangeListeners() Returns an array of attached calendarActivityDurationChange 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. |
java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> |
getClientBehaviors() |
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() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
DateCustomizer |
getDateCustomizer() Gets DateCustomizer allows for per date customizations such as string formatting. |
java.lang.String |
getDefaultEventName() |
java.lang.String[] |
getDontPersist() Gets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. |
java.util.Collection<java.lang.String> |
getEventNames() |
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[] |
getPersist() Gets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. |
java.lang.String |
getShortDesc() Gets the short description of the component. |
java.lang.String |
getStartDayOfWeek() Gets Returns the start day of the week in week or 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.util.Set<java.lang.String> |
getUnsecure() Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. |
java.lang.String |
getView() Gets calendar view: day, week, month, or list. |
boolean |
isClientComponent() Gets whether a client-side component will be generated. |
boolean |
isVisible() Gets the visibility of the component. |
void |
queueEvent(javax.faces.event.FacesEvent e) |
void |
removeCalendarActivityDurationChangeListener(CalendarActivityDurationChangeListener listener) Removes a calendarActivityDurationChange 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 |
setAvailableViews(java.util.List<java.lang.String> availableViews) Sets Available calendar views. |
void |
setCalendarActivityDurationChangeListener(javax.el.MethodExpression calendarActivityDurationChangeListener) Sets a method reference to a calendarActivityDurationChange 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) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
void |
setDateCustomizer(DateCustomizer dateCustomizer) Sets DateCustomizer allows for per date customizations such as string formatting. |
void |
setDontPersist(java.lang.String[] dontPersist) Sets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. |
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 |
setPersist(java.lang.String[] persist) Sets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. |
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 week or 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 |
setUnsecure(java.util.Set<java.lang.String> unsecure) Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. |
void |
setView(java.lang.String view) Sets calendar view: day, week, 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, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, subscribeToEvent, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent |
---|
addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String VIEW_DAY
public static final java.lang.String VIEW_WEEK
public static final java.lang.String VIEW_MONTH
public static final java.lang.String VIEW_LIST
public static final java.lang.String LIST_TYPE_DAY
public static final java.lang.String LIST_TYPE_WEEK
public static final java.lang.String LIST_TYPE_MONTH
public static final java.lang.String LIST_TYPE_DAY_COUNT
public static final java.lang.String START_DAY_OF_WEEK_SUN
public static final java.lang.String START_DAY_OF_WEEK_MON
public static final java.lang.String START_DAY_OF_WEEK_TUE
public static final java.lang.String START_DAY_OF_WEEK_WED
public static final java.lang.String START_DAY_OF_WEEK_THU
public static final java.lang.String START_DAY_OF_WEEK_FRI
public static final java.lang.String START_DAY_OF_WEEK_SAT
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PERSIST_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DONT_PERSIST_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VIEW_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ACTIVE_DAY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey AVAILABLE_VIEWS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DATE_CUSTOMIZER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey START_HOUR_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LIST_TYPE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LIST_COUNT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey START_DAY_OF_WEEK_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TIME_ZONE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ACTIVITY_STYLES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TOOLBOX_LAYOUT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CALENDAR_ACTIVITY_LISTENER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CALENDAR_DISPLAY_CHANGE_LISTENER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CALENDAR_LISTENER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CALENDAR_ACTIVITY_DURATION_CHANGE_LISTENER_KEY
public static final java.lang.String CREATE_FACET
public static final java.lang.String CONTEXT_MENU_FACET
public static final java.lang.String ACTIVITY_CONTEXT_MENU_FACET
public static final java.lang.String ACTIVITY_HOVER_FACET
public static final java.lang.String ACTIVITY_DETAIL_FACET
public static final java.lang.String ACTIVITY_DELETE_FACET
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String TOOLBOX_LAYOUT_ALL
public static final java.lang.String TOOLBOX_LAYOUT_DATES
public static final java.lang.String TOOLBOX_LAYOUT_VIEWS
public static final java.lang.String TOOLBOX_LAYOUT_NEWLINE
public static final java.lang.String TOOLBOX_LAYOUT_STRETCH
public static final java.lang.String TOOLBOX_LAYOUT_RANGE
Constructor Detail |
---|
public RichCalendar()
protected RichCalendar(java.lang.String rendererType)
Method Detail |
---|
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class org.apache.myfaces.trinidad.component.UIXComponentBase
javax.faces.event.AbortProcessingException
public void queueEvent(javax.faces.event.FacesEvent e)
queueEvent
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public final javax.faces.component.UIComponent getCreate()
This facet should contain a popup, and the child of the popup should be a dialog. The popup should have the 'contentDelivery' attribute set to 'lazyUncached' so that cached values are not shown. 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.public final void setCreate(javax.faces.component.UIComponent createFacet)
This facet should contain a popup, and the child of the popup should be a dialog. The popup should have the 'contentDelivery' attribute set to 'lazyUncached' so that cached values are not shown. 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.public final javax.faces.component.UIComponent getContextMenu()
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.
public final void setContextMenu(javax.faces.component.UIComponent contextMenuFacet)
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.
public final javax.faces.component.UIComponent getActivityContextMenu()
This facet should contain a popup, and the child of the popup should be a menu. If the content of the menu depends on the activity in some way then the popup should have the 'contentDelivery' attribute set to 'lazyUncached' so that cached values are not shown.
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.
public final void setActivityContextMenu(javax.faces.component.UIComponent activityContextMenuFacet)
This facet should contain a popup, and the child of the popup should be a menu. If the content of the menu depends on the activity in some way then the popup should have the 'contentDelivery' attribute set to 'lazyUncached' so that cached values are not shown.
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.
public final javax.faces.component.UIComponent getActivityHover()
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.
public final void setActivityHover(javax.faces.component.UIComponent activityHoverFacet)
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.
public final javax.faces.component.UIComponent getActivityDetail()
This facet should contain a popup, and the child of the popup should be a dialog. The popup should have the 'contentDelivery' attribute set to 'lazyUncached' so that cached values are not shown. 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.
public final void setActivityDetail(javax.faces.component.UIComponent activityDetailFacet)
This facet should contain a popup, and the child of the popup should be a dialog. The popup should have the 'contentDelivery' attribute set to 'lazyUncached' so that cached values are not shown. 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.
public final javax.faces.component.UIComponent getActivityDelete()
This facet should contain a popup, and the child of the popup should be a dialog. If the content of the popup depends on the activity in some way then the popup should have the 'contentDelivery' attribute set to 'lazyUncached' so that cached values are not shown. 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.
public final void setActivityDelete(javax.faces.component.UIComponent activityDeleteFacet)
This facet should contain a popup, and the child of the popup should be a dialog. If the content of the popup depends on the activity in some way then the popup should have the 'contentDelivery' attribute set to 'lazyUncached' so that cached values are not shown. 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.
public final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.util.Set<java.lang.String> getUnsecure()
public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value
@Deprecated
public final java.lang.String getCustomizationId()
@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final java.util.Set getClientAttributes()
public final void setClientAttributes(java.util.Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final java.lang.String[] getPersist()
public final void setPersist(java.lang.String[] persist)
persist
- the new persist valuepublic final java.lang.String[] getDontPersist()
public final void setDontPersist(java.lang.String[] dontPersist)
dontPersist
- the new dontPersist valuepublic final java.lang.String getView()
public final void setView(java.lang.String view)
view
- the new view valuepublic final java.util.Date getActiveDay()
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 8, 2009.
public final void setActiveDay(java.util.Date activeDay)
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 8, 2009.
activeDay
- the new activeDay valuepublic final java.util.List<java.lang.String> getAvailableViews()
public final void setAvailableViews(java.util.List<java.lang.String> availableViews)
availableViews
- the new availableViews valuepublic final DateCustomizer getDateCustomizer()
Keys passed to the DateCustomizer.format method are
public final void setDateCustomizer(DateCustomizer dateCustomizer)
Keys passed to the DateCustomizer.format method are
dateCustomizer
- the new dateCustomizer valuepublic final int getStartHour()
public final void setStartHour(int startHour)
startHour
- the new startHour valuepublic final java.lang.String getListType()
public final void setListType(java.lang.String listType)
listType
- the new listType valuepublic final int getListCount()
public final void setListCount(int listCount)
listCount
- the new listCount valuepublic final java.lang.String getStartDayOfWeek()
public final void setStartDayOfWeek(java.lang.String startDayOfWeek)
startDayOfWeek
- the new startDayOfWeek valuepublic final java.util.TimeZone getTimeZone()
public final void setTimeZone(java.util.TimeZone timeZone)
timeZone
- the new timeZone valuepublic final java.util.Map getActivityStyles()
For built in color ramps see CalendarActivityRamp.getActivityRamp, which returns a CalendarActivityRamp object, a subclass of InstanceStyles
public final void setActivityStyles(java.util.Map activityStyles)
For built in color ramps see CalendarActivityRamp.getActivityRamp, which returns a CalendarActivityRamp object, a subclass of InstanceStyles
activityStyles
- the new activityStyles valuepublic final java.lang.String[] getToolboxLayout()
The built in strings the component recognizes are:
Custom toolbox content: when the calendar encounters a string in toolboxLayout that it doesn't recognize, like 'customToolbarXyz', 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 topublic final void setToolboxLayout(java.lang.String[] toolboxLayout)
The built in strings the component recognizes are:
Custom toolbox content: when the calendar encounters a string in toolboxLayout that it doesn't recognize, like 'customToolbarXyz', 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 totoolboxLayout
- the new toolboxLayout valuepublic final javax.el.MethodExpression getCalendarActivityListener()
public final void setCalendarActivityListener(javax.el.MethodExpression calendarActivityListener)
calendarActivityListener
- the new calendarActivityListener valuepublic final javax.el.MethodExpression getCalendarDisplayChangeListener()
public final void setCalendarDisplayChangeListener(javax.el.MethodExpression calendarDisplayChangeListener)
calendarDisplayChangeListener
- the new calendarDisplayChangeListener valuepublic final javax.el.MethodExpression getCalendarListener()
public final void setCalendarListener(javax.el.MethodExpression calendarListener)
calendarListener
- the new calendarListener valuepublic final javax.el.MethodExpression getCalendarActivityDurationChangeListener()
public final void setCalendarActivityDurationChangeListener(javax.el.MethodExpression calendarActivityDurationChangeListener)
calendarActivityDurationChangeListener
- the new calendarActivityDurationChangeListener valuepublic final void addCalendarActivityListener(CalendarActivityListener listener)
listener
- the calendarActivity listener to addpublic final void removeCalendarActivityListener(CalendarActivityListener listener)
listener
- the calendarActivity listener to removepublic final CalendarActivityListener[] getCalendarActivityListeners()
public final void addCalendarDisplayChangeListener(CalendarDisplayChangeListener listener)
listener
- the calendarDisplayChange listener to addpublic final void removeCalendarDisplayChangeListener(CalendarDisplayChangeListener listener)
listener
- the calendarDisplayChange listener to removepublic final CalendarDisplayChangeListener[] getCalendarDisplayChangeListeners()
public final void addCalendarListener(CalendarListener listener)
listener
- the calendar listener to addpublic final void removeCalendarListener(CalendarListener listener)
listener
- the calendar listener to removepublic final CalendarListener[] getCalendarListeners()
public final void addCalendarActivityDurationChangeListener(CalendarActivityDurationChangeListener listener)
listener
- the calendarActivityDurationChange listener to addpublic final void removeCalendarActivityDurationChangeListener(CalendarActivityDurationChangeListener listener)
listener
- the calendarActivityDurationChange listener to removepublic final CalendarActivityDurationChangeListener[] getCalendarActivityDurationChangeListeners()
public java.lang.String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public java.util.Collection<java.lang.String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public java.lang.String getFamily()
getFamily
in class UIXCalendar
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class UIXCalendar
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 2 (11.1.2.2.0) E17488-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |