Entering content frame

Object documentation Web Dynpro DateNavigatorMarking API – IWDDateNavigatorMarking Locate the document in its SAP Library structure

Definition

This view element allows you to highlight entries of a specific category within the DateNavigator UI element. You can also define a tooltip for the highlighted entry. You should only use this view element in conjunction with the DateNavigatorLegend element, with which you can also explain each highlighting to the user. For more information, see the DateNavigator UI element description.

Description of the View Element Properties

·        category
Specifies the path to the context attribute which stores the category of the highlighting. The property allows you to specify how the aforementioned date is highlighted and displayed in color. The highlighting in color is used to delimit individual categories. Multiple highlighted dates can share a category. You should bind the property to a context attribute of the multiple context node, because otherwise the system uses the same category for each highlighting.
The
category property can take the following values and is represented by the list type WDDateMarkingCategory:

four

Color of category four. *)

one

Color of category one. *)

three

Color of category three. *)

two

Color of category two. *)

*) The color for each highlighting depends on the respective design theme used – the documentation refers to the SAP Standard Design 2002.

·        dataSource
Specifies the path to the context node which stores the date, category, and tooltip of the highlighting.

·        date
Specifies the path to the context attribute which stores the date of the highlighting.

·        tooltip
Specifies the path to the context attribute which stores the tooltip of the highlighting. You should bind the property to a context attribute of the multiple context node, because otherwise each highlighting has the same tooltip.

Properties Overview

Name

Interface

Type

Initial Value

Bindable

Value Required

category

IWDDateNavigatorMarking

WDDateMarkingCategory

one

bindable

No

dataSource

IWDDateNavigatorMarking

Object

 

bindable_mandatory

Yes

Date

IWDDateNavigatorMarking

java.sql.Date

 

bindable_mandatory

Yes

Tooltip

IWDDateNavigatorMarking

String (TranslatableText)

 

bindable

No

Associated Interfaces

IWDDateNavigator

Methods in the Web Dynpro IWDDateNavigatorMarking API

Method Name

Parameter

Return Value

Description

bindCategory

(String path)

 

Binds the value of the category property to the content element specified in the path.

bindDataSource

(String path)

 

Binds the value of the dataSource property to the content element specified by the path.

bindDate

(String path)

 

Binds the value of the date property to the content element specified in the path.

bindingOfCategory

 

String

Returns the path of the content element to which the category property is bound. Returns NULL if no binding exists.

bindingOfDataSource

 

String

Returns the path of the content element to which the dataSource property is bound. Returns NULL if no binding exists.

bindingOfDate

 

String

Returns the path of the content element to which the date property is bound. Returns NULL if no binding exists.

bindingOfTooltip

 

String

Returns the path of the content element to which the tooltip property is bound. Returns NULL if no binding exists.

bindTooltip

(String path)

 

Binds the value of the tooltip property to the context element specified by the path.

getCategory

 

WDDateMarkingCategory

Returns the value of the category property.

getDateNavigator

 

IWDDateNavigator

Returns the DateNavigator element that contains this DateNavigatorMarking element.

getTooltip

 

String

Returns the value of the tooltip property.

setCategory

(WDDateMarkingCategory category)

 

Sets the value of the category property.

setTooltip

(String tooltip)

 

Sets the value of the tooltip property.

Additional methods described in the following APIs are available using inheritance: IWDViewElement.

   

  

 

Leaving content frame