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

Interface IWDSeries

All Superinterfaces:

IWDAbstractSeries, IWDViewElement

public interface IWDSeries

extends IWDAbstractSeries

Web Dynpro Series 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_CUSTOMIZING_I_D Deprecated. use DEFAULT_CUSTOMIZING_ID instead
static String	DEFAULT_CUSTOMIZING_ID Default value of the customizingID property is "".
static int	DEFAULT_DATA_BEGIN_INDEX Default value of the dataBeginIndex property is 0.
static int	DEFAULT_DATA_LENGTH Default value of the dataLength property is 0.
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_LABEL Default value of the label property is "".
static String	DEFAULT_LEAD_SELECTION_CUSTOMIZING_I_D Deprecated. use DEFAULT_LEAD_SELECTION_CUSTOMIZING_ID instead
static String	DEFAULT_LEAD_SELECTION_CUSTOMIZING_ID Default value of the leadSelectionCustomizingID property is "".
static boolean	DEFAULT_SHOW_SELECTED_ONLY Default value of the showSelectedOnly property is false.
static String	DEFAULT_TOOLTIP Default value of the tooltip property is "".

Method Summary

void	bindCustomizingID(IWDAttributeInfo attributeInfo) Binds the customizingID property to the context attribute specified by the given attribute info.
void	bindCustomizingID(String path) Binds the customizingID property to the context attribute specified by the given path.
void	bindDataBeginIndex(IWDAttributeInfo attributeInfo) Binds the dataBeginIndex property to the context attribute specified by the given attribute info.
void	bindDataBeginIndex(String path) Binds the dataBeginIndex property to the context attribute specified by the given path.
void	bindDataLength(IWDAttributeInfo attributeInfo) Binds the dataLength property to the context attribute specified by the given attribute info.
void	bindDataLength(String path) Binds the dataLength 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	bindingOfCustomizingID() Returns the binding path of the customizingID property.
String	bindingOfDataBeginIndex() Returns the binding path of the dataBeginIndex property.
String	bindingOfDataLength() Returns the binding path of the dataLength property.
String	bindingOfEventID() Returns the binding path of the eventID property.
String	bindingOfLabel() Returns the binding path of the label property.
String	bindingOfLeadSelectionCustomizingID() Returns the binding path of the leadSelectionCustomizingID property.
String	bindingOfPointSource() Returns the binding path of the pointSource property.
String	bindingOfTooltip() Returns the binding path of the tooltip property.
void	bindLabel(IWDAttributeInfo attributeInfo) Binds the label property to the context attribute specified by the given attribute info.
void	bindLabel(String path) Binds the label property to the context attribute specified by the given path.
void	bindLeadSelectionCustomizingID(IWDAttributeInfo attributeInfo) Binds the leadSelectionCustomizingID property to the context attribute specified by the given attribute info.
void	bindLeadSelectionCustomizingID(String path) Binds the leadSelectionCustomizingID property to the context attribute specified by the given path.
void	bindPointSource(IWDNodeInfo nodeInfo) Binds the pointSource property to the context node specified by the given node info.
void	bindPointSource(String path) Binds the pointSource property to the context attribute specified by the given path.
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.
void	destroyPoint() Destroys the aggregated Point element.
String	getCustomizingID() Returns the value of the customizingID property.
int	getDataBeginIndex() Returns the value of the dataBeginIndex property.
int	getDataLength() Returns the value of the dataLength property.
String	getEventID() Returns the value of the eventID property.
String	getLabel() Returns the value of the label property.
String	getLeadSelectionCustomizingID() Returns the value of the leadSelectionCustomizingID property.
IWDPoint	getPoint() Returns the aggregated Point element
boolean	getShowSelectedOnly() Returns the value of the showSelectedOnly property.
String	getTooltip() Returns the value of the tooltip property.
void	setCustomizingID(String value) Sets the customizingID property to the given value.
void	setDataBeginIndex(int value) Sets the dataBeginIndex property to the given value.
void	setDataLength(int value) Sets the dataLength property to the given value.
void	setEventID(String value) Sets the eventID property to the given value.
void	setLabel(String value) Sets the label property to the given value.
void	setLeadSelectionCustomizingID(String value) Sets the leadSelectionCustomizingID property to the given value.
void	setPoint(IWDPoint point) Sets the aggregated Point element.
void	setShowSelectedOnly(boolean showSelectedOnly) Sets the showSelectedOnly 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.clientserver.uielib.graphics.api.IWDAbstractSeries

getBusinessGraphics

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

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_CUSTOMIZING_ID

public static final String DEFAULT_CUSTOMIZING_ID

Default value of the customizingID property is "".

See Also:

Constant Field Values

DEFAULT_DATA_BEGIN_INDEX

public static final int DEFAULT_DATA_BEGIN_INDEX

Default value of the dataBeginIndex property is 0.

See Also:

Constant Field Values

DEFAULT_DATA_LENGTH

public static final int DEFAULT_DATA_LENGTH

Default value of the dataLength property is 0.

See Also:

Constant Field Values

DEFAULT_EVENT_ID

public static final String DEFAULT_EVENT_ID

Default value of the eventID property is "".

See Also:

Constant Field Values

DEFAULT_LABEL

public static final String DEFAULT_LABEL

Default value of the label property is "".

See Also:

Constant Field Values

DEFAULT_LEAD_SELECTION_CUSTOMIZING_ID

public static final String DEFAULT_LEAD_SELECTION_CUSTOMIZING_ID

Default value of the leadSelectionCustomizingID property is "".

See Also:

Constant Field Values

DEFAULT_SHOW_SELECTED_ONLY

public static final boolean DEFAULT_SHOW_SELECTED_ONLY

Default value of the showSelectedOnly property is false.

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_CUSTOMIZING_I_D

public static final String DEFAULT_CUSTOMIZING_I_D

Deprecated. use DEFAULT_CUSTOMIZING_ID instead

Default value of property customizingID.

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

DEFAULT_LEAD_SELECTION_CUSTOMIZING_I_D

public static final String DEFAULT_LEAD_SELECTION_CUSTOMIZING_I_D

Deprecated. use DEFAULT_LEAD_SELECTION_CUSTOMIZING_ID instead

Default value of property leadSelectionCustomizingID.

See Also:

Constant Field Values

Method Detail

bindCustomizingID

public void bindCustomizingID(String path)

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

Parameters:

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

bindCustomizingID

public void bindCustomizingID(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfCustomizingID

public String bindingOfCustomizingID()

Returns the binding path of the customizingID property.

Returns:

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

getCustomizingID

public String getCustomizingID()

Returns the value of the customizingID property.

The initial value is "".

Returns:

the current value of the customizingID property

See Also:

setCustomizingID(String)

setCustomizingID

public void setCustomizingID(String value)

Sets the customizingID property to the given value.

Parameters:

value - the new value of the customizingID property

See Also:

getCustomizingID()

bindDataBeginIndex

public void bindDataBeginIndex(String path)

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

Parameters:

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

bindDataBeginIndex

public void bindDataBeginIndex(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDataBeginIndex

public String bindingOfDataBeginIndex()

Returns the binding path of the dataBeginIndex property.

Returns:

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

getDataBeginIndex

public int getDataBeginIndex()

Returns the value of the dataBeginIndex property.

The initial value is 0.

Returns:

the current value of the dataBeginIndex property

See Also:

setDataBeginIndex(int)

setDataBeginIndex

public void setDataBeginIndex(int value)

Sets the dataBeginIndex property to the given value.

Parameters:

value - the new value of the dataBeginIndex property

See Also:

getDataBeginIndex()

bindDataLength

public void bindDataLength(String path)

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

Parameters:

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

bindDataLength

public void bindDataLength(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDataLength

public String bindingOfDataLength()

Returns the binding path of the dataLength property.

Returns:

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

getDataLength

public int getDataLength()

Returns the value of the dataLength property.

The initial value is 0.

Returns:

the current value of the dataLength property

See Also:

setDataLength(int)

setDataLength

public void setDataLength(int value)

Sets the dataLength property to the given value.

Parameters:

value - the new value of the dataLength property

See Also:

getDataLength()

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()

bindLabel

public void bindLabel(String path)

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

Parameters:

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

bindLabel

public void bindLabel(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfLabel

public String bindingOfLabel()

Returns the binding path of the label property.

Returns:

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

getLabel

public String getLabel()

Returns the value of the label property.

The initial value is "".

Returns:

the current value of the label property

See Also:

setLabel(String)

setLabel

public void setLabel(String value)

Sets the label property to the given value.

Parameters:

value - the new value of the label property

See Also:

getLabel()

bindLeadSelectionCustomizingID

public void bindLeadSelectionCustomizingID(String path)

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

Parameters:

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

bindLeadSelectionCustomizingID

public void bindLeadSelectionCustomizingID(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfLeadSelectionCustomizingID

public String bindingOfLeadSelectionCustomizingID()

Returns the binding path of the leadSelectionCustomizingID property.

Returns:

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

getLeadSelectionCustomizingID

public String getLeadSelectionCustomizingID()

Returns the value of the leadSelectionCustomizingID property.

The initial value is "".

Returns:

the current value of the leadSelectionCustomizingID property

See Also:

setLeadSelectionCustomizingID(String)

setLeadSelectionCustomizingID

public void setLeadSelectionCustomizingID(String value)

Sets the leadSelectionCustomizingID property to the given value.

Parameters:

value - the new value of the leadSelectionCustomizingID property

See Also:

getLeadSelectionCustomizingID()

bindPointSource

public void bindPointSource(String path)

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

Parameters:

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

bindPointSource

public void bindPointSource(IWDNodeInfo nodeInfo)

Binds the pointSource property to the context node specified by the given node info.

Parameters:

nodeInfo - the info of the context node to which the pointSource property will be bound

bindingOfPointSource

public String bindingOfPointSource()

Returns the binding path of the pointSource property.

Returns:

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

getShowSelectedOnly

public boolean getShowSelectedOnly()

Returns the value of the showSelectedOnly property. The initial value is false.

Returns:

the value of the showSelectedOnly property

See Also:

setShowSelectedOnly(boolean)

setShowSelectedOnly

public void setShowSelectedOnly(boolean showSelectedOnly)

Sets the showSelectedOnly property to the given value.

Parameters:

showSelectedOnly - the new value of the showSelectedOnly property

See Also:

getShowSelectedOnly()

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()

getPoint

public IWDPoint getPoint()

Returns the aggregated Point element.

Returns:

the aggregated Point element

See Also:

setPoint(IWDPoint)

setPoint

public void setPoint(IWDPoint point)

Sets the aggregated Point element.

Parameters:

point - the new point

See Also:

getPoint()

destroyPoint

public void destroyPoint()

Destroys the aggregated Point element. Destroyed view elements do not exist any longer in their view, i.e. a new element may be created with the same ID.