Titanium SDK # Titanium.Calendar.Calendar
An object that represents a single calendar.
3.2.0
3.1.0
9.2.0# Properties
# apiName READONLY
3.2.0 3.2.0 9.2.0The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button
returns Ti.UI.Button.
# bubbleParent
3.2.0 3.1.0 9.2.0Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.
Default: true
Indicates whether this calendar can be edited or deleted.
This property is true when this calendar is editable.
# lifecycleContainer
3.6.0The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.
# selected READONLY
3.2.0Indicates whether the calendar is selected.
Set to true when this calendar is selected.
See Titanium.Calendar for examples.
# Methods
# addEventListener
3.2.0 3.1.0 9.2.0Adds the specified callback as an event listener for the named event.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. |
Returns
- Type
- void
# applyProperties
3.2.0 3.1.0 9.2.0Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
Parameters
| Name | Type | Description |
|---|---|---|
props | Dictionary | A dictionary of properties to apply. |
Returns
- Type
- void
# createEvent
3.2.0 3.1.0 9.2.0Creates an event in this calendar.
Parameters
| Name | Type | Description |
|---|---|---|
properties | Dictionary<Titanium.Calendar.Event> | Properties of the event |
Returns
# fireEvent
3.2.0 3.1.0 9.2.0Fires a synthesized event to any registered listeners.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. |
Returns
- Type
- void
# getEventById
3.2.0 3.1.0 9.2.0Gets the event with the specified identifier.
Parameters
| Name | Type | Description |
|---|---|---|
id | String | Identifier of the event. |
Returns
# getEventsBetweenDates
3.2.0 3.1.0 9.2.0Gets events that occur between two dates.
Parameters
| Name | Type | Description |
|---|---|---|
date1 | Date | String | Start date. |
date2 | Date | String | End date. |
Returns
- Type
- Array<Titanium.Calendar.Event>
# getEventsInDate DEPRECATED
3.2.0 3.1.0 9.2.0DEPRECATED SINCE 7.0.0
Use getEventsBetweenDates instead.
Gets events that occur on a specified date.
Parameters
| Name | Type | Description |
|---|---|---|
year | Number | Year of the events. |
month | Number | Month of the events, as a zero-based integer with January at 0 and December at 11. |
day | Number | Day of the month of the events. |
Returns
- Type
- Array<Titanium.Calendar.Event>
# getEventsInMonth DEPRECATED
3.2.0 3.1.0 9.2.0DEPRECATED SINCE 7.0.0
Use getEventsBetweenDates instead.
Gets events that occur during a specified month.
Parameters
| Name | Type | Description |
|---|---|---|
year | Number | Year of the events. |
month | Number | Month of the events, as a zero-based integer with January at 0 and December at 11. |
Returns
- Type
- Array<Titanium.Calendar.Event>
# getEventsInYear DEPRECATED
3.2.0 3.1.0 9.2.0DEPRECATED SINCE 7.0.0
Use getEventsBetweenDates instead.
Gets all events that occur during a specified year.
Parameters
| Name | Type | Description |
|---|---|---|
year | Number | Year of the events. |
Returns
- Type
- Array<Titanium.Calendar.Event>
# removeEventListener
3.2.0 3.1.0 9.2.0Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to |
Returns
- Type
- void