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

All Superinterfaces:

IWDViewElement

public interface IWDDateNavigatorLegend

extends IWDViewElement

Web Dynpro DateNavigatorLegend API. Attach a legend to a date navigator if you want to explain the meaning of categories used for markings.

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

Field Summary

static java.lang.String	DEFAULT_TEXT Default value of property text.
static WDTextDirection	DEFAULT_TEXT_DIRECTION Default value of property textDirection.

Method Summary

void	bindCategory(IWDAttributeInfo attributeInfo) Note: This property must be bound to the context! Binds property category to the context attribute specified by the given attribute info.
void	bindCategory(java.lang.String path) Note: This property must be bound to the context! 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.
java.lang.String	bindingOfCategory() Note: This property must be bound to the context! 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	bindingOfText() Binding path of property text.
java.lang.String	bindingOfTextDirection() Binding path of property textDirection.
void	bindText(IWDAttributeInfo attributeInfo) Binds property text to the context attribute specified by the given attribute info.
void	bindText(java.lang.String path) Binds property text to the context attribute specified by path.
void	bindTextDirection(IWDAttributeInfo attributeInfo) Binds property textDirection to the context attribute specified by the given attribute info.
void	bindTextDirection(java.lang.String path) Binds property textDirection to the context attribute specified by path.
WDDateMarkingCategory	getCategory() Note: This property must be bound to the context! Returns the value of the category property.
IWDDateNavigator	getDateNavigator() Returns the current DateNavigator.
java.lang.String	getText() Returns the value of the text property.
WDTextDirection	getTextDirection() Returns the value of the textDirection property.
void	setCategory(WDDateMarkingCategory value) Note: This property must be bound to the context! Sets property category to the new value.
void	setText(java.lang.String value) Sets property text to the new value.
void	setTextDirection(WDTextDirection value) Sets property textDirection to the new value.

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

getId, getView, requestFocus

Field Detail

DEFAULT_TEXT

public static final java.lang.String DEFAULT_TEXT

Default value of property text.

DEFAULT_TEXT_DIRECTION

public static final WDTextDirection DEFAULT_TEXT_DIRECTION

Default value of property textDirection.

Method Detail

bindCategory

public void bindCategory(java.lang.String path)

Note: This property must be bound to the context! 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)

Note: This property must be bound to the context! 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()

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

Returns:

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

getCategory

public WDDateMarkingCategory getCategory()

Note: This property must be bound to the context! Returns the value of the category property. The initial value is WDDateMarkingCategory.ONE. The category you want to explain via some descriptive text. No two legend entries must have the same category. This property must be bound to an attribute of the same multiple context node that the "dataSource" property is bound to.

Returns:

the current value of the category property

See Also:

setCategory(WDDateMarkingCategory)

setCategory

public void setCategory(WDDateMarkingCategory value)

Note: This property must be bound to the context! 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

bindText

public void bindText(java.lang.String path)

Binds property text to the context attribute specified by path.

Parameters:

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

bindText

public void bindText(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfText

public java.lang.String bindingOfText()

Binding path of property text.

Returns:

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

getText

public java.lang.String getText()

Returns the value of the text property. The initial value is "". The descriptive text used to explain the category of this legend entry. If this property is not bound to an attribute of the multiple context node that the "dataSource" property is bound to, then the text is the same for all category entries. This is probably not useful, though.

Returns:

the current value of the text property

See Also:

setText(String)

setText

public void setText(java.lang.String value)

Sets property text to the new value.

Parameters:

value - the new value of the text property

See Also:

getText()

bindTextDirection

public void bindTextDirection(java.lang.String path)

Binds property textDirection to the context attribute specified by path.

Parameters:

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

bindTextDirection

public void bindTextDirection(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTextDirection

public java.lang.String bindingOfTextDirection()

Binding path of property textDirection.

Returns:

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

getTextDirection

public WDTextDirection getTextDirection()

Returns the value of the textDirection property. The initial value is WDTextDirection.INHERIT. Determines the direction of displayed text.

Returns:

the current value of the textDirection property

See Also:

setTextDirection(WDTextDirection)

setTextDirection

public void setTextDirection(WDTextDirection value)

Sets property textDirection to the new value.

Parameters:

value - the new value of the textDirection property

See Also:

getTextDirection()

getDateNavigator

public IWDDateNavigator getDateNavigator()

Returns the current DateNavigator.

Returns:

the current DateNavigator