Package: | Ext.ensible.cal |
Defined In: | ReminderField.js |
Class: | ReminderField |
Extends: | Object |
A custom combo used for choosing a reminder setting for an event.
This is pretty much a standard combo that is simply pre-configured for the options needed by the calendar components. The default configs are as follows:
width: 200,
fieldLabel: 'Reminder',
mode: 'local',
triggerAction: 'all',
forceSelection: true,
displayField: 'desc',
valueField: 'value',
noneText: 'None',
atStartTimeText: 'At start time',
reminderValueFormat: '{0} {1} before start'
To customize the descriptions in the dropdown list override the following methods: getMinutesText, getHoursText, getDaysText and getWeeksText.
Method | Defined By | |
---|---|---|
ReminderField( Object config )
Parameters:
| ReminderField | |
getDaysText( Number numDays )
:
StringReturns the unit text to use for a reminder that has a specified number of days
prior to the due time (defaults to 'd... Returns the unit text to use for a reminder that has a specified number of days
prior to the due time (defaults to 'day' when the passed value === 1, else 'days'). Parameters:
| ReminderField | |
getHoursText( Number numHours )
:
StringReturns the unit text to use for a reminder that has a specified number of hours
prior to the due time (defaults to '... Returns the unit text to use for a reminder that has a specified number of hours
prior to the due time (defaults to 'hour' when the passed value === 1, else 'hours'). Parameters:
| ReminderField | |
getMinutesText( Number numMinutes )
:
StringReturns the unit text to use for a reminder that has a specified number of minutes
prior to the due time (defaults to... Returns the unit text to use for a reminder that has a specified number of minutes
prior to the due time (defaults to 'minute' when the passed value === 1, else 'minutes'). Parameters:
| ReminderField | |
getValueList()
:
Array Returns the list of reminder values used as the contents of the combo list. This method is provided so that
the value... Returns the list of reminder values used as the contents of the combo list. This method is provided so that
the value list can be easily overridden as needed. Parameters:
| ReminderField | |
getWeeksText( Number numWeeks )
:
StringReturns the unit text to use for a reminder that has a specified number of weeks
prior to the due time (defaults to '... Returns the unit text to use for a reminder that has a specified number of weeks
prior to the due time (defaults to 'week' when the passed value === 1, else 'weeks'). Parameters:
| ReminderField |