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

All Superinterfaces:

IWDViewElement

public interface IWDDateNavigatorMarking

extends IWDViewElement

Web Dynpro DateNavigatorMarking API. Attach a marking to a date navigator if you want to mark one or more dates with a category and a tooltip.

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

Field Summary

static WDDateMarkingCategory	DEFAULT_CATEGORY Default value of property category.
static java.lang.String	DEFAULT_TOOLTIP Default value of property tooltip.

Method Summary

void	bindCategory(IWDAttributeInfo attributeInfo) Binds property category to the context attribute specified by the given attribute info.
void	bindCategory(java.lang.String path) Binds property category to the context attribute specified by path.
void	bindDataSource(IWDNodeInfo nodeInfo) Note: This property must be bound to the context! Binds property dataSource to the context node specified by the given node info.
void	bindDataSource(java.lang.String path) Note: This property must be bound to the context! Binds property dataSource to the context attribute specified by path.
void	bindDate(IWDAttributeInfo attributeInfo) Note: This property must be bound to the context! Binds property date to the context attribute specified by the given attribute info.
void	bindDate(java.lang.String path) Note: This property must be bound to the context! Binds property date to the context attribute specified by path.
java.lang.String	bindingOfCategory() Binding path of property category.
java.lang.String	bindingOfDataSource() Note: This property must be bound to the context! Binding path of property dataSource.
java.lang.String	bindingOfDate() Note: This property must be bound to the context! Binding path of property date.
java.lang.String	bindingOfTooltip() Binding path of property tooltip.
void	bindTooltip(IWDAttributeInfo attributeInfo) Binds property tooltip to the context attribute specified by the given attribute info.
void	bindTooltip(java.lang.String path) Binds property tooltip to the context attribute specified by path.
WDDateMarkingCategory	getCategory() Returns the value of the category property.
IWDDateNavigator	getDateNavigator() Returns the current DateNavigator.
java.lang.String	getTooltip() Returns the value of the tooltip property.
void	setCategory(WDDateMarkingCategory value) Sets property category to the new value.
void	setTooltip(java.lang.String value) Sets property tooltip to the new value.

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

getId, getView, requestFocus

Field Detail

DEFAULT_CATEGORY

public static final WDDateMarkingCategory DEFAULT_CATEGORY

Default value of property category.

DEFAULT_TOOLTIP

public static final java.lang.String DEFAULT_TOOLTIP

Default value of property tooltip.

Method Detail

bindCategory

public void bindCategory(java.lang.String path)

Binds property category to the context attribute specified by path.

Parameters:

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

bindCategory

public void bindCategory(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfCategory

public java.lang.String bindingOfCategory()

Binding path of property category.

Returns:

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

getCategory

public WDDateMarkingCategory getCategory()

Returns the value of the category property. The initial value is WDDateMarkingCategory.ONE. The marking's category determines how the date in question is marked (visually etc.). Several date markings may well share the same category. If this property is not bound to an attribute of the multiple context node that the "dataSource" property is bound to, then the category is the same for all markings.

Returns:

the current value of the category property

See Also:

setCategory(WDDateMarkingCategory)

setCategory

public void setCategory(WDDateMarkingCategory value)

Sets property category to the new value.

Parameters:

value - the new value of the category property

See Also:

getCategory()

bindDataSource

public void bindDataSource(java.lang.String path)

Note: This property must be bound to the context! Binds property dataSource to the context attribute specified by path.

Parameters:

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

bindDataSource

public void bindDataSource(IWDNodeInfo nodeInfo)

Note: This property must be bound to the context! Binds property dataSource to the context node specified by the given node info.

Parameters:

nodeInfo - the info of the context node to which the dataSource property is bound

bindingOfDataSource

public java.lang.String bindingOfDataSource()

Note: This property must be bound to the context! Binding path of property dataSource.

Returns:

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

bindDate

public void bindDate(java.lang.String path)

Note: This property must be bound to the context! Binds property date to the context attribute specified by path.

Parameters:

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

bindDate

public void bindDate(IWDAttributeInfo attributeInfo)

Note: This property must be bound to the context! Binds property date to the context attribute specified by the given attribute info.

Parameters:

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

bindingOfDate

public java.lang.String bindingOfDate()

Note: This property must be bound to the context! Binding path of property date.

Returns:

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

bindTooltip

public void bindTooltip(java.lang.String path)

Binds property tooltip to the context attribute specified by path.

Parameters:

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

bindTooltip

public void bindTooltip(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTooltip

public java.lang.String bindingOfTooltip()

Binding path of property tooltip.

Returns:

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

getTooltip

public java.lang.String getTooltip()

Returns the value of the tooltip property. The initial value is "". The marking's tooltip. If this property is not bound to an attribute of the multiple context node that the "dataSource" property is bound to, then the tooltip is the same for all markings.

Returns:

the current value of the tooltip property

See Also:

setTooltip(String)

setTooltip

public void setTooltip(java.lang.String value)

Sets property tooltip to the new value.

Parameters:

value - the new value of the tooltip property

See Also:

getTooltip()

getDateNavigator

public IWDDateNavigator getDateNavigator()

Returns the current DateNavigator.

Returns:

the current DateNavigator