Web Dynpro DateNavigatorLegend API - IWDDateNavigatorLegend 

Definition

This view element allows you to add a legend to the DateNavigator UI element. You can use this view element with the DateNavigatorMarking view element to highlight calendar entries and to associate them with the legend entries. A maximum of four legend entries can be used according to the categories described below. Legend entries are stored as elements of a context node. Each highlighted selection of a date is stored in a separate context node. If the value of the category attribute equals the value of the legend entry category, the category refers to the corresponding legend entry.

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 legend entry. When doing this, you must make sure that two legend entries cannot be assigned to the same category. The category property must be bound to a context attribute, to whose multiple superordinate context nodes the dataSource property is bound.
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 colors for the selections depend 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 categories and texts of the legend entries. Each node element represents one entry in the legend. The legend entries are displayed in the order of the node elements.

·        text
Specifies the path to the context attribute which stores the texts of the legend entries. This property is used to describe a category.

Properties Overview

Name	Interface	Type	Initial Value	Bindable	Value Required
category	IWDDateNavigatorLegend	WDDateMarkingCategory	One	bindable_mandatory	Yes
dataSource	IWDDateNavigatorLegend	Object		bindable_mandatory	Yes
text	IWDDateNavigatorLegend	String (TranslatableText)		bindable	Yes

Associated Interfaces

IWDDateNavigator

Methods in the Web Dynpro IWDDateNavigatorLegend 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 dataSource property to the context node specified by a 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 context element to which the dataSource property is bound. Returns NULL if no binding exists.
bindingOfText		String	Returns the path of the context element to which the text property is bound. Returns NULL if no binding exists.
bindText	(String path)		Binds the text property to the context node specified by a path.
getCategory		WDDateMarkingCategory	Returns the value of the category property.
getDateNavigator		IWDDateNavigator	Returns the DateNavigator element that contains this DateNavigatorLegend element.
getText		String	Returns the value of the text property.
setCategory	(WDDateMarkingCategory category)		Sets the value of the category property.
setText	(String text)		Sets the value of the text property.

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