com.sap.tc.webdynpro.clientserver.uielib.standard.api
Interface IWDDateNavigator

All Superinterfaces:

IWDUIElement, IWDViewElement

public interface IWDDateNavigator

extends IWDUIElement

Web Dynpro DateNavigator API. A date navigator allows navigating through a calendar and selecting a day, month or a year. The selectionMode determines if a single date or a date range may be selected.

This type can be called by applications using Web Dynpro, but DO NOT EXTEND OR IMPLEMENT IT!

Field Summary

static java.lang.String	DEFAULT_ACCESSIBILITY_DESCRIPTION Default value of property accessibilityDescription.
static java.sql.Date	DEFAULT_FIRST_SELECTED_DATE Default value of property firstSelectedDate.
static java.sql.Date	DEFAULT_LAST_SELECTED_DATE Default value of property lastSelectedDate.
static int	DEFAULT_MONTHS_PER_COLUMN Default value of property monthsPerColumn.
static int	DEFAULT_MONTHS_PER_ROW Default value of property monthsPerRow.
static WDDateSelectionMode	DEFAULT_SELECTION_MODE Default value of property selectionMode.
static java.sql.Date	DEFAULT_STARTS_WITH Default value of property startsWith.

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindAccessibilityDescription(IWDAttributeInfo attributeInfo) Binds property accessibilityDescription to the context attribute specified by the given attribute info.
void	bindAccessibilityDescription(java.lang.String path) Binds property accessibilityDescription to the context attribute specified by path.
void	bindFirstSelectedDate(IWDAttributeInfo attributeInfo) Binds property firstSelectedDate to the context attribute specified by the given attribute info.
void	bindFirstSelectedDate(java.lang.String path) Binds property firstSelectedDate to the context attribute specified by path.
java.lang.String	bindingOfAccessibilityDescription() Binding path of property accessibilityDescription.
java.lang.String	bindingOfFirstSelectedDate() Binding path of property firstSelectedDate.
java.lang.String	bindingOfLastSelectedDate() Binding path of property lastSelectedDate.
java.lang.String	bindingOfMonthsPerColumn() Binding path of property monthsPerColumn.
java.lang.String	bindingOfMonthsPerRow() Binding path of property monthsPerRow.
java.lang.String	bindingOfSelectionMode() Binding path of property selectionMode.
java.lang.String	bindingOfStartsWith() Binding path of property startsWith.
void	bindLastSelectedDate(IWDAttributeInfo attributeInfo) Binds property lastSelectedDate to the context attribute specified by the given attribute info.
void	bindLastSelectedDate(java.lang.String path) Binds property lastSelectedDate to the context attribute specified by path.
void	bindMonthsPerColumn(IWDAttributeInfo attributeInfo) Binds property monthsPerColumn to the context attribute specified by the given attribute info.
void	bindMonthsPerColumn(java.lang.String path) Binds property monthsPerColumn to the context attribute specified by path.
void	bindMonthsPerRow(IWDAttributeInfo attributeInfo) Binds property monthsPerRow to the context attribute specified by the given attribute info.
void	bindMonthsPerRow(java.lang.String path) Binds property monthsPerRow to the context attribute specified by path.
void	bindSelectionMode(IWDAttributeInfo attributeInfo) Binds property selectionMode to the context attribute specified by the given attribute info.
void	bindSelectionMode(java.lang.String path) Binds property selectionMode to the context attribute specified by path.
void	bindStartsWith(IWDAttributeInfo attributeInfo) Binds property startsWith to the context attribute specified by the given attribute info.
void	bindStartsWith(java.lang.String path) Binds property startsWith to the context attribute specified by path.
void	destroyLegend() Destroys the Legend instance.
void	destroyMarking() Destroys the Marking instance.
java.lang.String	getAccessibilityDescription() Returns the value of the accessibilityDescription property.
java.sql.Date	getFirstSelectedDate() Returns the value of the firstSelectedDate property.
java.sql.Date	getLastSelectedDate() Returns the value of the lastSelectedDate property.
IWDDateNavigatorLegend	getLegend() Gets the Legend instance.
IWDDateNavigatorMarking	getMarking() Gets the Marking instance.
int	getMonthsPerColumn() Returns the value of the monthsPerColumn property.
int	getMonthsPerRow() Returns the value of the monthsPerRow property.
IWDAction	getOnDaySelect() Returns the action to which the event onDaySelect is mapped.
IWDAction	getOnMonthSelect() Returns the action to which the event onMonthSelect is mapped.
IWDAction	getOnStartDateChanged() Returns the action to which the event onStartDateChanged is mapped.
IWDAction	getOnWeekSelect() Returns the action to which the event onWeekSelect is mapped.
WDDateSelectionMode	getSelectionMode() Returns the value of the selectionMode property.
java.sql.Date	getStartsWith() Returns the value of the startsWith property.
IWDParameterMapping	mappingOfOnDaySelect() Returns the parameter mapping of event onDaySelect.
IWDParameterMapping	mappingOfOnMonthSelect() Returns the parameter mapping of event onMonthSelect.
IWDParameterMapping	mappingOfOnStartDateChanged() Returns the parameter mapping of event onStartDateChanged.
IWDParameterMapping	mappingOfOnWeekSelect() Returns the parameter mapping of event onWeekSelect.
void	setAccessibilityDescription(java.lang.String value) Sets property accessibilityDescription to the new value.
void	setFirstSelectedDate(java.sql.Date value) Sets property firstSelectedDate to the new value.
void	setLastSelectedDate(java.sql.Date value) Sets property lastSelectedDate to the new value.
void	setLegend(IWDDateNavigatorLegend legend) Sets the Legend instance.
void	setMarking(IWDDateNavigatorMarking marking) Sets the Marking instance.
void	setMonthsPerColumn(int value) Sets property monthsPerColumn to the new value.
void	setMonthsPerRow(int value) Sets property monthsPerRow to the new value.
void	setOnDaySelect(IWDAction action) Maps the event onDaySelect to the given action.
void	setOnMonthSelect(IWDAction action) Maps the event onMonthSelect to the given action.
void	setOnStartDateChanged(IWDAction action) Maps the event onStartDateChanged to the given action.
void	setOnWeekSelect(IWDAction action) Maps the event onWeekSelect to the given action.
void	setSelectionMode(WDDateSelectionMode value) Sets property selectionMode to the new value.
void	setStartsWith(java.sql.Date value) Sets property startsWith to the new value.

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

bindEnabled, bindEnabled, bindingOfEnabled, bindingOfTooltip, bindingOfVisible, bindTooltip, bindTooltip, bindVisible, bindVisible, createLayoutData, getContainer, getEnabled, getLayoutData, getTooltip, getVisible, setEnabled, setTooltip, setVisible

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDViewElement

getId, getView, requestFocus

Field Detail

DEFAULT_ACCESSIBILITY_DESCRIPTION

public static final java.lang.String DEFAULT_ACCESSIBILITY_DESCRIPTION

Default value of property accessibilityDescription.

DEFAULT_FIRST_SELECTED_DATE

public static final java.sql.Date DEFAULT_FIRST_SELECTED_DATE

Default value of property firstSelectedDate.

DEFAULT_LAST_SELECTED_DATE

public static final java.sql.Date DEFAULT_LAST_SELECTED_DATE

Default value of property lastSelectedDate.

DEFAULT_MONTHS_PER_COLUMN

public static final int DEFAULT_MONTHS_PER_COLUMN

Default value of property monthsPerColumn.

DEFAULT_MONTHS_PER_ROW

public static final int DEFAULT_MONTHS_PER_ROW

Default value of property monthsPerRow.

DEFAULT_SELECTION_MODE

public static final WDDateSelectionMode DEFAULT_SELECTION_MODE

Default value of property selectionMode.

DEFAULT_STARTS_WITH

public static final java.sql.Date DEFAULT_STARTS_WITH

Default value of property startsWith.

Method Detail

getOnDaySelect

public IWDAction getOnDaySelect()

Returns the action to which the event onDaySelect is mapped. The event raised when a day is selected.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnDaySelect()

setOnDaySelect

public void setOnDaySelect(IWDAction action)

Maps the event onDaySelect to the given action.

Parameters:

action - the action for the event

See Also:

getOnDaySelect()

mappingOfOnDaySelect

public IWDParameterMapping mappingOfOnDaySelect()

Returns the parameter mapping of event onDaySelect.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• java.sql.Date day - The date of the newly selected day.

Returns:

parameter mapping list.

See Also:

getOnDaySelect()

getOnMonthSelect

public IWDAction getOnMonthSelect()

Returns the action to which the event onMonthSelect is mapped. The event raised when a month is selected.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnMonthSelect()

setOnMonthSelect

public void setOnMonthSelect(IWDAction action)

Maps the event onMonthSelect to the given action.

Parameters:

action - the action for the event

See Also:

getOnMonthSelect()

mappingOfOnMonthSelect

public IWDParameterMapping mappingOfOnMonthSelect()

Returns the parameter mapping of event onMonthSelect.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• int month - The number of the newly selected month.
• int year - The newly selected year.

Returns:

parameter mapping list.

See Also:

getOnMonthSelect()

getOnStartDateChanged

public IWDAction getOnStartDateChanged()

Returns the action to which the event onStartDateChanged is mapped. Event that is triggered whenever the "startsWith" property is changed through user interactions.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnStartDateChanged()

setOnStartDateChanged

public void setOnStartDateChanged(IWDAction action)

Maps the event onStartDateChanged to the given action.

Parameters:

action - the action for the event

See Also:

getOnStartDateChanged()

mappingOfOnStartDateChanged

public IWDParameterMapping mappingOfOnStartDateChanged()

Returns the parameter mapping of event onStartDateChanged.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• java.sql.Date startDate - New value of the "startsWith" property, i.e. new start date of the date range shown by the navigator.

Returns:

parameter mapping list.

See Also:

getOnStartDateChanged()

getOnWeekSelect

public IWDAction getOnWeekSelect()

Returns the action to which the event onWeekSelect is mapped. The event raised when a week is selected.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnWeekSelect()

setOnWeekSelect

public void setOnWeekSelect(IWDAction action)

Maps the event onWeekSelect to the given action.

Parameters:

action - the action for the event

See Also:

getOnWeekSelect()

mappingOfOnWeekSelect

public IWDParameterMapping mappingOfOnWeekSelect()

Returns the parameter mapping of event onWeekSelect.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• int week - The number of the newly selected week.
• int year - The newly selected year.

Returns:

parameter mapping list.

See Also:

getOnWeekSelect()

bindAccessibilityDescription

public void bindAccessibilityDescription(java.lang.String path)

Binds property accessibilityDescription to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the accessibilityDescription property is bound

bindAccessibilityDescription

public void bindAccessibilityDescription(IWDAttributeInfo attributeInfo)

Binds property accessibilityDescription to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the accessibilityDescription property is bound

bindingOfAccessibilityDescription

public java.lang.String bindingOfAccessibilityDescription()

Binding path of property accessibilityDescription.

Returns:

the path of the context attribute to which the accessibilityDescription is currently bound

getAccessibilityDescription

public java.lang.String getAccessibilityDescription()

Returns the value of the accessibilityDescription property. The initial value is "". Short description for the DateNavigator (it's like a title) in the accessibility mode. It is only used if accessibility mode (508) is switched on and will be included into the tooltip. Its read by the screen reader when the whole UI element gets the focus.

Returns:

the current value of the accessibilityDescription property

See Also:

setAccessibilityDescription(String)

setAccessibilityDescription

public void setAccessibilityDescription(java.lang.String value)

Sets property accessibilityDescription to the new value.

Parameters:

value - the new value of the accessibilityDescription property

See Also:

getAccessibilityDescription()

bindFirstSelectedDate

public void bindFirstSelectedDate(java.lang.String path)

Binds property firstSelectedDate to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the firstSelectedDate property is bound

bindFirstSelectedDate

public void bindFirstSelectedDate(IWDAttributeInfo attributeInfo)

Binds property firstSelectedDate to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the firstSelectedDate property is bound

bindingOfFirstSelectedDate

public java.lang.String bindingOfFirstSelectedDate()

Binding path of property firstSelectedDate.

Returns:

the path of the context attribute to which the firstSelectedDate is currently bound

getFirstSelectedDate

public java.sql.Date getFirstSelectedDate()

Returns the value of the firstSelectedDate property. The initial value is new java.sql.Date(System.currentTimeMillis()).

Returns:

the current value of the firstSelectedDate property

See Also:

setFirstSelectedDate(java.sql.Date)

setFirstSelectedDate

public void setFirstSelectedDate(java.sql.Date value)

Sets property firstSelectedDate to the new value.

Parameters:

value - the new value of the firstSelectedDate property

See Also:

getFirstSelectedDate()

bindLastSelectedDate

public void bindLastSelectedDate(java.lang.String path)

Binds property lastSelectedDate to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the lastSelectedDate property is bound

bindLastSelectedDate

public void bindLastSelectedDate(IWDAttributeInfo attributeInfo)

Binds property lastSelectedDate to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the lastSelectedDate property is bound

bindingOfLastSelectedDate

public java.lang.String bindingOfLastSelectedDate()

Binding path of property lastSelectedDate.

Returns:

the path of the context attribute to which the lastSelectedDate is currently bound

getLastSelectedDate

public java.sql.Date getLastSelectedDate()

Returns the value of the lastSelectedDate property. The initial value is new java.sql.Date(System.currentTimeMillis()).

Returns:

the current value of the lastSelectedDate property

See Also:

setLastSelectedDate(java.sql.Date)

setLastSelectedDate

public void setLastSelectedDate(java.sql.Date value)

Sets property lastSelectedDate to the new value.

Parameters:

value - the new value of the lastSelectedDate property

See Also:

getLastSelectedDate()

bindMonthsPerColumn

public void bindMonthsPerColumn(java.lang.String path)

Binds property monthsPerColumn to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the monthsPerColumn property is bound

bindMonthsPerColumn

public void bindMonthsPerColumn(IWDAttributeInfo attributeInfo)

Binds property monthsPerColumn to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the monthsPerColumn property is bound

bindingOfMonthsPerColumn

public java.lang.String bindingOfMonthsPerColumn()

Binding path of property monthsPerColumn.

Returns:

the path of the context attribute to which the monthsPerColumn is currently bound

getMonthsPerColumn

public int getMonthsPerColumn()

Returns the value of the monthsPerColumn property. The initial value is 1.

Returns:

the current value of the monthsPerColumn property

See Also:

setMonthsPerColumn(int)

setMonthsPerColumn

public void setMonthsPerColumn(int value)

Sets property monthsPerColumn to the new value.

Parameters:

value - the new value of the monthsPerColumn property

See Also:

getMonthsPerColumn()

bindMonthsPerRow

public void bindMonthsPerRow(java.lang.String path)

Binds property monthsPerRow to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the monthsPerRow property is bound

bindMonthsPerRow

public void bindMonthsPerRow(IWDAttributeInfo attributeInfo)

Binds property monthsPerRow to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the monthsPerRow property is bound

bindingOfMonthsPerRow

public java.lang.String bindingOfMonthsPerRow()

Binding path of property monthsPerRow.

Returns:

the path of the context attribute to which the monthsPerRow is currently bound

getMonthsPerRow

public int getMonthsPerRow()

Returns the value of the monthsPerRow property. The initial value is 3.

Returns:

the current value of the monthsPerRow property

See Also:

setMonthsPerRow(int)

setMonthsPerRow

public void setMonthsPerRow(int value)

Sets property monthsPerRow to the new value.

Parameters:

value - the new value of the monthsPerRow property

See Also:

getMonthsPerRow()

bindSelectionMode

public void bindSelectionMode(java.lang.String path)

Binds property selectionMode to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the selectionMode property is bound

bindSelectionMode

public void bindSelectionMode(IWDAttributeInfo attributeInfo)

Binds property selectionMode to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the selectionMode property is bound

bindingOfSelectionMode

public java.lang.String bindingOfSelectionMode()

Binding path of property selectionMode.

Returns:

the path of the context attribute to which the selectionMode is currently bound

getSelectionMode

public WDDateSelectionMode getSelectionMode()

Returns the value of the selectionMode property. The initial value is WDDateSelectionMode.SINGLE.

Returns:

the current value of the selectionMode property

See Also:

setSelectionMode(WDDateSelectionMode)

setSelectionMode

public void setSelectionMode(WDDateSelectionMode value)

Sets property selectionMode to the new value.

Parameters:

value - the new value of the selectionMode property

See Also:

getSelectionMode()

bindStartsWith

public void bindStartsWith(java.lang.String path)

Binds property startsWith to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the startsWith property is bound

bindStartsWith

public void bindStartsWith(IWDAttributeInfo attributeInfo)

Binds property startsWith to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the startsWith property is bound

bindingOfStartsWith

public java.lang.String bindingOfStartsWith()

Binding path of property startsWith.

Returns:

the path of the context attribute to which the startsWith is currently bound

getStartsWith

public java.sql.Date getStartsWith()

Returns the value of the startsWith property. The initial value is new java.sql.Date(System.currentTimeMillis()).

Returns:

the current value of the startsWith property

See Also:

setStartsWith(java.sql.Date)

setStartsWith

public void setStartsWith(java.sql.Date value)

Sets property startsWith to the new value.

Parameters:

value - the new value of the startsWith property

See Also:

getStartsWith()

getLegend

public IWDDateNavigatorLegend getLegend()

Gets the Legend instance.

Returns:

the current Legend

See Also:

setLegend(IWDDateNavigatorLegend)

setLegend

public void setLegend(IWDDateNavigatorLegend legend)

Sets the Legend instance.

Parameters:

legend - the new legend

See Also:

getLegend()

destroyLegend

public void destroyLegend()

Destroys the Legend instance. Destroyed elements do not exist any longer, i.e. a new element may be created with the same ID.

getMarking

public IWDDateNavigatorMarking getMarking()

Gets the Marking instance.

Returns:

the current Marking

See Also:

setMarking(IWDDateNavigatorMarking)

setMarking

public void setMarking(IWDDateNavigatorMarking marking)

Sets the Marking instance.

Parameters:

marking - the new marking

See Also:

getMarking()

destroyMarking

public void destroyMarking()

Destroys the Marking instance. Destroyed elements do not exist any longer, i.e. a new element may be created with the same ID.