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!

Field Summary

static java.lang.String	DEFAULT_CUSTOMIZING_I_D Default value of property customizingID.
static int	DEFAULT_DATA_BEGIN_INDEX Default value of property dataBeginIndex.
static int	DEFAULT_DATA_LENGTH Default value of property dataLength.
static java.lang.String	DEFAULT_EVENT_I_D Default value of property eventID.
static java.lang.String	DEFAULT_LABEL Default value of property label.
static java.lang.String	DEFAULT_LEAD_SELECTION_CUSTOMIZING_I_D Default value of property leadSelectionCustomizingID.
static boolean	DEFAULT_SHOW_SELECTED_ONLY Default value of property showSelectedOnly.
static java.lang.String	DEFAULT_TOOLTIP Default value of property tooltip.

Method Summary

void	bindCustomizingID(IWDAttributeInfo attributeInfo) Binds property customizingID to the context attribute specified by the given attribute info.
void	bindCustomizingID(java.lang.String path) Binds property customizingID to the context attribute specified by path.
void	bindDataBeginIndex(IWDAttributeInfo attributeInfo) Binds property dataBeginIndex to the context attribute specified by the given attribute info.
void	bindDataBeginIndex(java.lang.String path) Binds property dataBeginIndex to the context attribute specified by path.
void	bindDataLength(IWDAttributeInfo attributeInfo) Binds property dataLength to the context attribute specified by the given attribute info.
void	bindDataLength(java.lang.String path) Binds property dataLength to the context attribute specified by path.
void	bindEventID(IWDAttributeInfo attributeInfo) Binds property eventID to the context attribute specified by the given attribute info.
void	bindEventID(java.lang.String path) Binds property eventID to the context attribute specified by path.
java.lang.String	bindingOfCustomizingID() Binding path of property customizingID.
java.lang.String	bindingOfDataBeginIndex() Binding path of property dataBeginIndex.
java.lang.String	bindingOfDataLength() Binding path of property dataLength.
java.lang.String	bindingOfEventID() Binding path of property eventID.
java.lang.String	bindingOfLabel() Binding path of property label.
java.lang.String	bindingOfLeadSelectionCustomizingID() Binding path of property leadSelectionCustomizingID.
java.lang.String	bindingOfPointSource() Note: This property must be bound to the context! Binding path of property pointSource.
java.lang.String	bindingOfTooltip() Binding path of property tooltip.
void	bindLabel(IWDAttributeInfo attributeInfo) Binds property label to the context attribute specified by the given attribute info.
void	bindLabel(java.lang.String path) Binds property label to the context attribute specified by path.
void	bindLeadSelectionCustomizingID(IWDAttributeInfo attributeInfo) Binds property leadSelectionCustomizingID to the context attribute specified by the given attribute info.
void	bindLeadSelectionCustomizingID(java.lang.String path) Binds property leadSelectionCustomizingID to the context attribute specified by path.
void	bindPointSource(IWDNodeInfo nodeInfo) Note: This property must be bound to the context! Binds property pointSource to the context node specified by the given node info.
void	bindPointSource(java.lang.String path) Note: This property must be bound to the context! Binds property pointSource to the context attribute specified by path.
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.
void	destroyPoint() Destroys the Point instance.
java.lang.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.
java.lang.String	getEventID() Returns the value of the eventID property.
java.lang.String	getLabel() Returns the value of the label property.
java.lang.String	getLeadSelectionCustomizingID() Returns the value of the leadSelectionCustomizingID property.
IWDPoint	getPoint() Gets the Point instance.
boolean	getShowSelectedOnly() Returns the value of the showSelectedOnly property.
java.lang.String	getTooltip() Returns the value of the tooltip property.
void	setCustomizingID(java.lang.String value) Sets property customizingID to the new value.
void	setDataBeginIndex(int value) Sets property dataBeginIndex to the new value.
void	setDataLength(int value) Sets property dataLength to the new value.
void	setEventID(java.lang.String value) Sets property eventID to the new value.
void	setLabel(java.lang.String value) Sets property label to the new value.
void	setLeadSelectionCustomizingID(java.lang.String value) Sets property leadSelectionCustomizingID to the new value.
void	setPoint(IWDPoint point) Sets the Point instance.
void	setShowSelectedOnly(boolean showSelectedOnly) Sets property showSelectedOnly to the given value.
void	setTooltip(java.lang.String value) Sets property tooltip to the new 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

getId, getView, requestFocus

Field Detail

DEFAULT_CUSTOMIZING_I_D

public static final java.lang.String DEFAULT_CUSTOMIZING_I_D

Default value of property customizingID.

DEFAULT_DATA_BEGIN_INDEX

public static final int DEFAULT_DATA_BEGIN_INDEX

Default value of property dataBeginIndex.

DEFAULT_DATA_LENGTH

public static final int DEFAULT_DATA_LENGTH

Default value of property dataLength.

DEFAULT_EVENT_I_D

public static final java.lang.String DEFAULT_EVENT_I_D

Default value of property eventID.

DEFAULT_LABEL

public static final java.lang.String DEFAULT_LABEL

Default value of property label.

DEFAULT_LEAD_SELECTION_CUSTOMIZING_I_D

public static final java.lang.String DEFAULT_LEAD_SELECTION_CUSTOMIZING_I_D

Default value of property leadSelectionCustomizingID.

DEFAULT_SHOW_SELECTED_ONLY

public static final boolean DEFAULT_SHOW_SELECTED_ONLY

Default value of property showSelectedOnly.

DEFAULT_TOOLTIP

public static final java.lang.String DEFAULT_TOOLTIP

Default value of property tooltip.

Method Detail

bindCustomizingID

public void bindCustomizingID(java.lang.String path)

Binds property customizingID to the context attribute specified by path.

Parameters:

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

bindCustomizingID

public void bindCustomizingID(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfCustomizingID

public java.lang.String bindingOfCustomizingID()

Binding path of property customizingID.

Returns:

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

getCustomizingID

public java.lang.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(java.lang.String value)

Sets property customizingID to the new value.

Parameters:

value - the new value of the customizingID property

See Also:

getCustomizingID()

bindDataBeginIndex

public void bindDataBeginIndex(java.lang.String path)

Binds property dataBeginIndex to the context attribute specified by path.

Parameters:

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

bindDataBeginIndex

public void bindDataBeginIndex(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDataBeginIndex

public java.lang.String bindingOfDataBeginIndex()

Binding path of property dataBeginIndex.

Returns:

the path of the context attribute to which the dataBeginIndex 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 property dataBeginIndex to the new value.

Parameters:

value - the new value of the dataBeginIndex property

See Also:

getDataBeginIndex()

bindDataLength

public void bindDataLength(java.lang.String path)

Binds property dataLength to the context attribute specified by path.

Parameters:

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

bindDataLength

public void bindDataLength(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDataLength

public java.lang.String bindingOfDataLength()

Binding path of property dataLength.

Returns:

the path of the context attribute to which the dataLength 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 property dataLength to the new value.

Parameters:

value - the new value of the dataLength property

See Also:

getDataLength()

bindEventID

public void bindEventID(java.lang.String path)

Binds property eventID to the context attribute specified by path.

Parameters:

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

bindEventID

public void bindEventID(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfEventID

public java.lang.String bindingOfEventID()

Binding path of property eventID.

Returns:

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

getEventID

public java.lang.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(java.lang.String value)

Sets property eventID to the new value.

Parameters:

value - the new value of the eventID property

See Also:

getEventID()

bindLabel

public void bindLabel(java.lang.String path)

Binds property label to the context attribute specified by path.

Parameters:

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

bindLabel

public void bindLabel(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfLabel

public java.lang.String bindingOfLabel()

Binding path of property label.

Returns:

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

getLabel

public java.lang.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(java.lang.String value)

Sets property label to the new value.

Parameters:

value - the new value of the label property

See Also:

getLabel()

bindLeadSelectionCustomizingID

public void bindLeadSelectionCustomizingID(java.lang.String path)

Binds property leadSelectionCustomizingID to the context attribute specified by path.

Parameters:

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

bindLeadSelectionCustomizingID

public void bindLeadSelectionCustomizingID(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfLeadSelectionCustomizingID

public java.lang.String bindingOfLeadSelectionCustomizingID()

Binding path of property leadSelectionCustomizingID.

Returns:

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

getLeadSelectionCustomizingID

public java.lang.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(java.lang.String value)

Sets property leadSelectionCustomizingID to the new value.

Parameters:

value - the new value of the leadSelectionCustomizingID property

See Also:

getLeadSelectionCustomizingID()

bindPointSource

public void bindPointSource(java.lang.String path)

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

Parameters:

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

bindPointSource

public void bindPointSource(IWDNodeInfo nodeInfo)

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

Parameters:

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

bindingOfPointSource

public java.lang.String bindingOfPointSource()

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

Returns:

the path of the context attribute to which the pointSource 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 property showSelectedOnly to the given value.

Parameters:

showSelectedOnly - the new showSelectedOnly value

See Also:

getShowSelectedOnly()

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 "".

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

getPoint

public IWDPoint getPoint()

Gets the Point instance.

Returns:

the current Point

See Also:

setPoint(IWDPoint)

setPoint

public void setPoint(IWDPoint point)

Sets the Point instance.

Parameters:

point - the new point

See Also:

getPoint()

destroyPoint

public void destroyPoint()

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