Web Dynpro DateNavigator API –
IWDDateNavigator 
Definition
The DateNavigatorUI
element enables users to display and enter dates. Its features include the ability to navigate in a
calendar and choose a day, month, year, or range of dates. Primarily, this
element should be used to help users to input dates in an appropriate format.
The following screenshots show the DateNavigator
UI element with different values for the properties monthsPerColumn
and monthsPerRow.
You can use the DateNavigatorLegend and the DateNavigatorMarking Element to add a legend for the description of selected
data to the DateNavigator UI element. This enables
you to provide the user with information on specific data that is assigned to
a category. For example, events in the calendar can be highlighted in a
different color and each event can be described with agenda, time, and
location.
Property values: monthsPerColumn = 2 monthsPerRow = 1 |
Property values: monthsPerColumn = 1 monthsPerRow = 2 |
|
|
Description of the UI Element Properties
·
accessibilityDescription
When accessibility is activated, the assigned text is added to the tooltip. This description provides semantic details of
the UI element and is only read by the screen reader if the user focuses the
complete Ul element.
·
firstSelectedDate
Specifies the first date in the selected date range.
·
lastSelectedDate
Specifies the last date in the selected date range.
·
monthsPerColumn
You use this property to specify the number of months in a column.
·
monthsPerRow
You use this property to specify the number of months in a row.
·
selectionMode
Specifies whether the user can choose a single date or a range of dates.
The selectionMode property can be filled with the following
values and is represented by the enumeration type WDDateSelectionMode.
range |
The user can choose a contiguous block of dates. |
single |
The user can choose only one dates. |
·
startsWith
Specifies the start of the date range displayed.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
accessibilityDescription |
IWDDateNavigator |
String (TranslatableText) |
|
bindable |
No |
IWDUIElement |
boolean |
true |
bindable |
No |
|
firstSelectedDate |
IWDDateNavigator |
java.sql.Date |
|
bindable |
No |
lastSelectedDate |
IWDDateNavigator |
java.sql.Date |
|
bindable |
No |
monthsPerColumn |
IWDDateNavigator |
int |
1 |
bindable |
No |
monthsPerRow |
IWDDateNavigator |
int |
3 |
bindable |
No |
selectionMode |
IWDDateNavigator |
WDDateSelectionMode |
single |
bindable |
No |
startsWith |
IWDDateNavigator |
java.sql.Date |
|
bindable |
No |
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
|
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
Events
·
onDaySelect
Specifies the action that is carried out when the user chooses a day.
The event parameter is the chosen day.
Event Parameter |
Type |
day |
java.sql.Date |
·
onMonthSelect
Specifies the action that is carried out when the user chooses a month. Event
parameters are the chosen months (in the range of 1 to 12) and the chosen
year.
Event Parameter |
Type |
month |
int |
year |
int |
·
onStartDateChanged
Specifies the action that is carried out when the user changes the
startsWidth property. The event
parameter is new start date.
Event Parameter |
Type |
startDate |
java.sql.Date |
·
onWeekSelect
Specifies the action that is carried out when the user chooses a week. Event
parameters are the chosen weeks (in the range of 1 to 53) and the chosen
year.
Event Parameter |
Type |
week |
int |
year |
int |
Associated Interfaces
Methods in the Web Dynpro IWDDateNavigator API
Method Name |
Parameter |
Return Value |
Description |
bindAccessibilityDescription |
(String path) |
|
Binds the accessibilityDescription property to the context node specified by a path. |
bindFirstSelectedDate |
(String path) |
|
Binds the value of the firstSelectedDate property to the context element specified by the path. |
bindingOfAccessibilityDescription |
|
String |
Returns the path of the context element to which the accessibilityDescription property is bound. Returns NULL if no binding exists. |
bindingOfFirstSelectedDate |
|
String |
Returns the path of the context element to which the firstSelectedDate property is bound. Returns NULL if no binding exists. |
bindingOfLastSelectedDate |
|
String |
Returns the path of the context element to which the lastSelectedDate property is bound. Returns NULL if no binding exists. |
bindingOfMonthsPerColumn |
|
String |
Returns the path of the context element to which the monthsPerColumn property is bound. Returns NULL if no binding exists. |
bindingOfMonthsPerRow |
|
String |
Returns the path of the context element to which the monthsPerRow property is bound. Returns NULL if no binding exists. |
bindingOfSelectionMode |
|
String |
Returns the path of the context element to which the selectionMode property is bound. Returns NULL if no binding exists. |
bindingOfStartsWith |
|
String |
Returns the path of the context element to which the startsWith property is bound. Returns NULL if no binding exists. |
bindLastSelectedDate |
(String path) |
|
Binds the value of the lastSelectedDate property to the context element specified by the path. |
bindMonthsPerColumn |
(String path) |
|
Binds the value of the monthsPerColumn property to the context element specified by the path. |
bindMonthsPerRow |
(String path) |
|
Binds the value of the monthsPerRow property to the context element specified by the path. |
bindSelectionMode |
(String path) |
|
Binds the value of the selectionMode property to the context element specified by the path. |
bindStartsWith |
(String path) |
|
Binds the value of the startsWith property to the context element specified by the path. |
destroyLegend |
|
|
Removes and deletes the legend for this DateNavigator element. |
destroyMarking |
|
|
Removes and deletes the highlighting for this DateNavigator element. |
getAccessibilityDescription |
|
String |
Returns the value of the accessibilityDescription property. |
getFirstSelectedDate |
|
java.sql.Date |
Returns the value of the firstSelectedDate property. |
getLastSelectedDate |
|
java.sql.Date |
Returns the value of the lastSelectedDate property. |
getLegend |
|
IWDDateNavigatorLegend |
Returns the legend for this DateNavigator element. |
getMarking |
|
IWDDateNavigatorMarking |
Returns the highlighting for this DateNavigator element. |
getMonthsPerColumn |
|
int |
Returns the value of the monthsPerColumn property. |
getMonthsPerRow |
|
int |
Returns the value of the monthsPerRow property. |
getOnDaySelect |
|
IWDAction |
Returns the action that is executed if the onDaySelect event is raised. |
getOnMonthSelect |
|
IWDAction |
Returns the action that is executed if the onMonthSelect event is raised. |
getOnStartDateChanged |
|
IWDAction |
Returns the action that is executed if the onStartDateChanged event is raised. |
getOnWeekSelect |
|
IWDAction |
Returns the action that is executed if the onWeekSelect event is raised. |
getSelectionMode |
|
WDDateSelectionMode |
Returns the value of the selectionMode property. |
getStartsWith |
|
java.sql.Date |
Returns the value of the startsWith property. |
mappingOfOnDaySelect |
|
IWDParameterMapping |
Returns the parameter mapping for the onDaySelect action. |
mappingOfOnMonthSelect |
|
IWDParameterMapping |
Returns the parameter mapping for the onMonthSelect action. |
mappingOfOnStartDateChanged |
|
IWDParameterMapping |
Returns the parameter mapping for the onStartDateChanged action. |
mappingOfOnWeekSelect |
|
IWDParameterMapping |
Returns the parameter mapping for the onWeekSelect action. |
setAccessibilityDescription |
(String accessibilityDescription) |
|
Sets the value of the accessibilityDescription property. |
setFirstSelectedDate |
(java.sql.Date firstSelectedDate) |
|
Sets the value of the firstSelectedDate property. |
setLastSelectedDate |
(java.sql.Date lastSelectedDate) |
|
Sets the value of the lastSelectedDate property. |
setLegend |
(IWDDateNavigatorLegend legend) |
|
Sets the legend for this DateNavigator element. |
setMarking |
(IWDDateNavigatorMarking marking) |
|
Sets the highlighting for this DateNavigator element. |
setMonthsPerColumn |
(int monthsPerColumn) |
|
Sets the value of the monthsPerColumn property. |
setMonthsPerRow |
(int monthsPerRow) |
|
Sets the value of the monthsPerRow property. |
setOnDaySelect |
(IWDAction action) |
|
Sets the action that is executed if the onDaySelect event is raised. |
setOnMonthSelect |
(IWDAction action) |
|
Sets the action that is executed if the onMonthSelect event is raised. |
setOnStartDateChanged |
(IWDAction action) |
|
Sets the action that is executed when the onStartDateChanged event is triggered. |
setOnWeekSelect |
(IWDAction action) |
|
Sets the action that is executed if the onWeekSelect event is raised. |
setSelectionMode |
(WDDateSelectionMode selectionMode) |
|
Sets the value of the selectionMode property. |
setStartsWith |
(java.sql.Date startsWith) |
|
Sets the value of the startsWith property. |
Additional methods described in the following APIs are available using inheritance:
For detailed documentation of all inherited methods, see the documentation for the relevant APIs.