com.sap.tc.webdynpro.clientserver.uielib.graphics.api

Interface IWDCategory

All Superinterfaces:

IWDViewElement

public interface IWDCategory

extends IWDViewElement

Web Dynpro Category API. Part of BusinessGraphics.

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

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Field Summary

static String	DEFAULT_EVENT_I_D Deprecated. use DEFAULT_EVENT_ID instead
static String	DEFAULT_EVENT_ID Default value of the eventID property is "".
static String	DEFAULT_TOOLTIP Default value of the tooltip property is "".

Method Summary

void	bindDescription(IWDAttributeInfo attributeInfo) Binds the description property to the context attribute specified by the given attribute info.
void	bindDescription(String path) Binds the description property to the context attribute specified by the given path.
void	bindEventID(IWDAttributeInfo attributeInfo) Binds the eventID property to the context attribute specified by the given attribute info.
void	bindEventID(String path) Binds the eventID property to the context attribute specified by the given path.
String	bindingOfDescription() Returns the binding path of the description property.
String	bindingOfEventID() Returns the binding path of the eventID property.
String	bindingOfTooltip() Returns the binding path of the tooltip property.
void	bindTooltip(IWDAttributeInfo attributeInfo) Binds the tooltip property to the context attribute specified by the given attribute info.
void	bindTooltip(String path) Binds the tooltip property to the context attribute specified by the given path.
IWDBusinessGraphics	getBusinessGraphics() Returns the BusinessGraphics this Category belongs to
String	getDescription() Returns the value of the description property.
String	getEventID() Returns the value of the eventID property.
String	getTooltip() Returns the value of the tooltip property.
void	setDescription(String value) Sets the description property to the given value.
void	setEventID(String value) Sets the eventID property to the given value.
void	setTooltip(String value) Sets the tooltip property to the given value.

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

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_EVENT_ID

public static final String DEFAULT_EVENT_ID

Default value of the eventID property is "".

See Also:

Constant Field Values

DEFAULT_TOOLTIP

public static final String DEFAULT_TOOLTIP

Default value of the tooltip property is "".

See Also:

Constant Field Values

DEFAULT_EVENT_I_D

public static final String DEFAULT_EVENT_I_D

Deprecated. use DEFAULT_EVENT_ID instead

Default value of property eventID.

See Also:

Constant Field Values

Method Detail

bindDescription

public void bindDescription(String path)

Binds the description property to the context attribute specified by the given path.

Note: This property must be bound to the context!

Parameters:

path - the context path of the attribute to which the description property will be bound

bindDescription

public void bindDescription(IWDAttributeInfo attributeInfo)

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

Note: This property must be bound to the context!

Parameters:

attributeInfo - the info of the context attribute to which the description property will be bound

bindingOfDescription

public String bindingOfDescription()

Returns the binding path of the description property.

Note: This property must be bound to the context!

Returns:

the path of the context attribute to which the description property is currently bound

getDescription

public String getDescription()

Returns the value of the description property.

The initial value is "".

Note: This property must be bound to the context!

Returns:

the current value of the description property

See Also:

setDescription(String)

setDescription

public void setDescription(String value)

Sets the description property to the given value.

Note: This property must be bound to the context!

Parameters:

value - the new value of the description property

See Also:

getDescription()

bindEventID

public void bindEventID(String path)

Binds the eventID property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the eventID property will be bound

bindEventID

public void bindEventID(IWDAttributeInfo attributeInfo)

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

Parameters:

attributeInfo - the info of the context attribute to which the eventID property will be bound

bindingOfEventID

public String bindingOfEventID()

Returns the binding path of the eventID property.

Returns:

the path of the context attribute to which the eventID property is currently bound

getEventID

public String getEventID()

Returns the value of the eventID property.

The initial value is "".

Returns:

the current value of the eventID property

See Also:

setEventID(String)

setEventID

public void setEventID(String value)

Sets the eventID property to the given value.

Parameters:

value - the new value of the eventID property

See Also:

getEventID()

bindTooltip

public void bindTooltip(String path)

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

Parameters:

path - the context path of the attribute to which the tooltip property will be bound

bindTooltip

public void bindTooltip(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTooltip

public String bindingOfTooltip()

Returns the binding path of the tooltip property.

Returns:

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

getTooltip

public String getTooltip()

Returns the value of the tooltip property.

The initial value is "".

Returns:

the current value of the tooltip property

See Also:

setTooltip(String)

setTooltip

public void setTooltip(String value)

Sets the tooltip property to the given value.

Parameters:

value - the new value of the tooltip property

See Also:

getTooltip()

getBusinessGraphics

public IWDBusinessGraphics getBusinessGraphics()

Returns the BusinessGraphics this Category belongs to.

Returns:

the BusinessGraphics this Category belongs to