Methods

addClass
clear
close
focus
getColorStyle
getDate
getEnd
getLabel
getLabelPlacement
getLabelWidth
getPlaceholder
getSizeStyle
getStart
getTabIndex
getType
getWidth
hide
isBound
isEnabled
isLabelVisible
isVisible
open
propagateUpValueChange
setColorStyle
setDate
setEnabled
setEnd
setLabel
setLabelPlacement
setLabelVisible
setLabelWidth
setPlaceholder
setSizeStyle
setStart
setTabIndex
setVisible
setWidth
show
triggerFormulaUpdates

Parent

CoachView

Helpers

bpmext.log
bpmext.number
bpmext.text
bpmext.ui
bpmext.ui.View
bpmext.ui.util
Date Time Picker
The Date Time Picker control creates an input text field and a calendar to select dates and times for a web form. The picker supports localized calendars, blackout dates and different presentation options.
Appearance
Date Picker type: Set whether the datepicker has a textbox which when clicked shows a calendar, or simply has an inline calendar.
{Text Input | Inline}		 DatePickerType
Width: Width of the Date Picker String
Size: The size of the control.
{Default | Large | Small}		 TextSizeStyle
Label placement: The label placement for the control
{Top | Left}		 LabelPlacement
Label width: The width of the label in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. String
Format: The format used to display and parse text that is entered into the text field, such as MM/dd/yyyy or dd/MM/yyyy. This option supports the same formats as the Java SimpleDateFormat, and applies only when a browser does not have a native date time picker. String
Week start: The day used to start each week.
{Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}		 DatePickerWeekStart
Disabled week days: The days of the week that should be disabled. DatePickerDisabledWeekDays
Show Today button: Display button to set date to today Boolean
Show Clear button: Display button that clears date value Boolean
Orientation: The position of the calendar when clicked.
{Auto | Top Auto | Bottom Auto | Auto Left | Top Left | Bottom Left | Auto Right | Top Right | Bottom Right}		 DatePickerOrientation
Color style: The color style for this control.
{Default | Info | Success | Warning | Danger}		 DatePickerColorStyle
Show week number: Shows the number of week it is in the year Boolean
Highlight Today: Set to true to highlight today's date in the calendar Boolean
Hide header: Boolean
Behavior
Custom picker only: Check this option to always display the custom date time picker. On mobile devices attempt will be made to display native date time picker, if non-supported configuration options are specifed then custom date time picker will be displayed. Non-supported configuration options include "Disabled Week Days", "Blackout Dates", "Blackout date start", "Blackout date end", "Week Start", "Calendar type" as hebrew/islamic and "DatePicker Type" as "Inline" Boolean
Include time picker: Boolean
Calendar type: Select the type of calendar
{Gregorian | Hebrew | Islamic}		 CalendarType
Tab index: The tabbing sequence index of the form control. Indices start at 1, and can be set sparsely. For example, you can use 1, 5, 10. String
Placeholder text: The text that is displayed when no date is entered. String
Available start date: Dates before the start date will be blocked out. The format for this date is specified by the Appearance, Format configuration option. Date
Available end date: Dates after the end date will be blocked out. The format for this date is specified by the Appearance, Format configuration option. Date
Blackout dates: Set a date that the user cannot select. To set a range of blackout dates, create a variable containing the list of dates and use that variable for this configuration option Date[]
Blackout date start: Dates after the start date, including the selected date, will be blocked out Date
Blackout date end: Dates before the end date, including the selected date, will be blocked out Date
Start view: Level of granularity calendar should start at
{Month | Year | Decade}		 DatePickerStartView
Minimum view mode: Minimum date granularity level to use in the calendar
{Days | Months | Years}		 DatePickerMinViewMode
No Auto close: When set to true, calendar will not close when a date is selected (calendar will close when control loses focus) Boolean
Events
On Load:
Description: This event is triggered the datepicker control is loaded.
Example: 
var workerStart = ${StartDate}.getDate();  me.setStart(workerStart);
On Change:
Description: This event is triggered when there is a change detected.
Example: 
return confirm("Are you sure you want to change date?")
On Day Cell Render:
Description: This event is triggered before the date shows on the control.
Example: 
me.setDate("01/01/2015")
Context Variables date {object}
Extends:
com.ibm.bpm.coach.CoachView
Methods:
Inherited addClass(name, [replaced])
Add/replace CSS class(es) for this control
NameTypeDefaultDescription
name{string}CSS class name(s) to add to the control. Separate class names by a space if more than one class.
replaced{string}CSS class name(s) to be replaced by the first argument. Separate class names by a space if more than one class.
Example
Button.addClass("green");
clear()
Clear selected date on this control
close()
Closes the drop-down calendar.
Example
me.close();
focus()
Set focus on this control
getColorStyle() Returns: {string}
Gets color style of DatePicker control. NOTE: This always returns the color as set, to avoid ambiguity always set the color using "D"|"I"|"S"|"W"|"G"
getDate() Returns: {date}
Get date for DatePicker control
getEnd()
Get the end date of the calendar that is currently set, if available.
Example
me.getEnd();
getLabel() Returns: {string}
Get label associated with DatePicker control
getLabelPlacement() Returns: {string}
Get label placement for control. NOTE: This always returns the label placement as set, to avoid ambiguity always set the label placement using "T"|"L"
Example
me.getLabelPlacement();
getLabelWidth() Returns: {string}
Get label width of DatePicker control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
getPlaceholder() Returns: {string}
Get placeholder text associated with DatePicker control
getSizeStyle() Returns: {string}
Gets size style of DatePicker control. NOTE: This always returns the size style as set, to avoid ambiguity always set the size style using "D"|"S"|"L"
getStart()
Get the start date of the calendar that is currently set, if available.
Example
me.getStart();
getTabIndex() Returns: {integer}
Get tab index for DatePicker control
getType() Returns: {string}
Get descriptive string representing the type of control
getWidth() Returns: {string}
Get configured width for DatePicker control (including unit)
hide()
Hides the date time picker
Inherited isBound() Returns: {boolean}
Indicates bound status of control.
Inherited isEnabled() Returns: {boolean}
Checks if the view is enabled or not
Example
var enabled = MyView.isEnabled();
isLabelVisible() Returns: {boolean}
Get label visibility for DatePicker control
Inherited isVisible() Returns: {boolean}
Checks whether or not view is visible
Example
var visible = MyView.isVisible();
open()
Opens the drop-down calendar.
Example
me.open();
Inherited propagateUpValueChange(event) Returns: {boolean}
Propagates value change of control up through parent views
NameTypeDefaultDescription
event{Event}Value change event (usually an onchange event)
Example
MyView.propagateUp(event);
setColorStyle(style)
Sets color style of DatePicker control. NOTE: to avoid ambiguity always set the color using "D"|"I"|"S"|"W"|"G"
NameTypeDefaultDescription
style{string}"DEFAULT"|"DEF"|"D"=Default | "INFO"|INF"|"I"=Info | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "DANGER"|"ERROR"|"ERR"|"G"=Danger
setDate(date)
Set date for DatePicker control
NameTypeDefaultDescription
date{date}Sets the date
Inherited setEnabled(enabled, required)
Enable/disable this view/control
NameTypeDefaultDescription
enabled{boolean}Enabled/read-only flag (true to enable view, false to disable/make read-only)
required{boolean}Enable/disable required field flag for control
Example
MyView.setEnabled(false); //Make MyView read-only
setEnd(end)
Set the available start date programmatically
NameTypeDefaultDescription
end{string}This sets the cut-off date, dates subsequent to this are disallowed . Must use the format specified in the Format configuration option.
Examples
me.setEnd("06/07/2015");
me.setEnd("6/7/2015");
me.setEnd("6-7-15");
setLabel(label)
Set label associated with DatePicker control
NameTypeDefaultDescription
label{string}Date picker label
setLabelPlacement(placement)
Set label placement for control. NOTE: to avoid ambiguity always set the label placement using "T"|"L"
NameTypeDefaultDescription
placement{string}"T"|"TOP"=Top | "L"|"LEFT"=Left
Example
me.setLabelPlacement("L");
setLabelVisible(flag)
Set label visibility for DatePicker control
NameTypeDefaultDescription
flag{boolean}Sets the visibility of the label {true | false}
setLabelWidth(labelWidth)
Set label width of DatePicker control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
NameTypeDefaultDescription
labelWidth{string}Control's label width
setPlaceholder(text)
Set placeholder text for DatePicker control
NameTypeDefaultDescription
text{string}Placeholder text
setSizeStyle(style)
Sets size style of DatePicker control. NOTE: to avoid ambiguity always set the size style using "D"|"S"|"L"
NameTypeDefaultDescription
style{string}"DEFAULT"|"DEF"|"NORMAL"|"D"=Default | "SMALL"|"S"=Small | "LARGE"|"L"=Large
setStart(start)
Set the available start date programmatically
NameTypeDefaultDescription
start{string}This sets the start date, dates prior to this date are disallowed. Must use the format specified in the Format configuration option.
Examples
me.setStart("06/01/2015");
me.setStart("6/1/2015");
me.setStart("6-1-15");
setTabIndex(tabIndex)
Sets tab index of DatePicker control
NameTypeDefaultDescription
tabIndex{integer}Tab indices start at 1 and may be set sparsely
Inherited setVisible(visible, collapse)
Show/hide this view/control
NameTypeDefaultDescription
visible{boolean}Visibility flag (true to show view, false to hide)
collapse{boolean}Set to true to collapse the control space when visible is set to false.
Examples
MyView.setVisible(false, false); //Equivalent to MyView.hide()
MyView.setVisible(false, true); // Sets visibility to "None"
setWidth(width)
Set width of DatePicker control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
NameTypeDefaultDescription
width{string}sets the width of the control
Inherited show()
Show this view/control
Example
MyView.show();
Inherited triggerFormulaUpdates([phase])
Broadcasts the expression trigger for the specified view
NameTypeDefaultDescription
phase{int}bpmext.ui.PHASE_NORMALThe phase we are currently in
Example
MyView.triggerFormulaUpdates();