new DateTimePicker()
This constructor is never used explicitly.
Extends
Members
Methods
-
inherited addClass(name, replaced)
-
Add/replace CSS class(es) for this control
Name Type Description name
string CSS class name(s) to add to the control. Separate class names by a space if more than one class. replaced
string optional 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
-
focus()
-
Set focus on this control
-
getColorStyle(){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"
Returns:
Type Description string -
getDate(){date}
-
Get date for DatePicker control
Returns:
Type Description date -
getEnd(){string}
-
Get the end date of the calendar that is currently set, if available.
Returns:
Type Description string Example
me.getEnd();
-
getLabel(){string}
-
Get label associated with DatePicker control
Returns:
Type Description string -
getLabelPlacement(){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"
Returns:
Type Description string Example
me.getLabelPlacement();
-
getLabelWidth(){string}
-
Get label width of DatePicker control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Returns:
Type Description string -
getPlaceholder(){string}
-
Get placeholder text associated with DatePicker control
Returns:
Type Description string -
getSizeStyle(){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"
Returns:
Type Description string -
getStart(){string}
-
Get the start date of the calendar that is currently set, if available.
Returns:
Type Description string Example
me.getStart();
-
getTabIndex(){integer}
-
Get tab index for DatePicker control
Returns:
Type Description integer -
getType(){string}
-
Get descriptive string representing the type of control
Returns:
Type Description string -
getWidth(){string}
-
Get configured width for DatePicker control (including unit)
Returns:
Type Description string -
inherited hide(collapseFlag)
-
Hide this view/control
Name Type Description collapseFlag
boolean Set to true
to collapse the view (equivalent to a view setting of "NONE")Example
MyView.hide();
-
inherited isBound(){boolean}
-
Indicates bound status of control.
Returns:
Type Description boolean True if the control is bound to coach data. -
inherited isEnabled(){boolean}
-
Checks if the view is enabled or not
Returns:
Type Description boolean Enabled status Example
var enabled = MyView.isEnabled();
-
isLabelVisible(){boolean}
-
Get label visibility for DatePicker control
Returns:
Type Description boolean -
inherited isVisible(){boolean}
-
Checks whether or not view is visible
Returns:
Type Description boolean Visibility status Example
var visible = MyView.isVisible();
-
inherited propagateUpValueChange(event){boolean}
-
Propagates value change of control up through parent views
Name Type Description event
Event Value change event (usually an onchange event) Returns:
Type Description boolean True if a formula update was triggered on the control's parent, otherwise false 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"
Name Type Description 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
Name Type Description date
date Sets the date -
inherited setEnabled(enabled, required)
-
Enable/disable this view/control
Name Type Description 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
Name Type Description 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
Name Type Description label
string Date picker label -
setLabelPlacement(placement)
-
Set label placement for control. NOTE: to avoid ambiguity always set the label placement using "T"|"L"
Name Type Description placement
string "T"|"TOP"=Top | "L"|"LEFT"=Left Example
me.setLabelPlacement("L");
-
setLabelVisible(flag)
-
Set label visibility for DatePicker control
Name Type Description 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)
Name Type Description labelWidth
string Control's label width -
setPlaceholder(text)
-
Set placeholder text for DatePicker control
Name Type Description 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"
Name Type Description style
string "DEFAULT"|"DEF"|"NORMAL"|"D"=Default | "SMALL"|"S"=Small | "LARGE"|"L"=Large -
setStart(start)
-
Set the available start date programmatically
Name Type Description 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
Name Type Description tabIndex
integer Tab indices start at 1 and may be set sparsely -
inherited setVisible(visible, collapse)
-
Show/hide this view/control
Name Type Description visible
boolean Visibility flag ( true
to show view,false
to hide)collapse
boolean Set to true
to collapse the control space whenvisible
is set tofalse
.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)
Name Type Description width
string sets the width of the control -
Show this view/control
Example
MyView.show();
-
inherited triggerFormulaUpdates(phase)
-
Broadcasts the expression trigger for the specified view
Name Type Default Description phase
int bpmext.ui.PHASE_NORMAL optional The phase we are currently in Example
MyView.triggerFormulaUpdates();