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

All Superinterfaces:

IWDViewElement

public interface IWDPoint

extends IWDViewElement

Web Dynpro Point 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 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_TOOLTIP Default value of property tooltip.

Method Summary

void	addValue(IWDAbstractValue aAbstractValue) Adds the given Value at the end of the list of Values.
void	addValue(IWDAbstractValue aAbstractValue, int index) Adds the given Value at the specified index in the list of Values.
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	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	bindingOfEventID() Binding path of property eventID.
java.lang.String	bindingOfLabel() Binding path of property label.
java.lang.String	bindingOfTooltip() Binding path of property tooltip.
java.lang.String	bindingOfValueSource() Note: This property must be bound to the context! Binding path of property valueSource.
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	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	bindValueSource(IWDNodeInfo nodeInfo) Note: This property must be bound to the context! Binds property valueSource to the context node specified by the given node info.
void	bindValueSource(java.lang.String path) Note: This property must be bound to the context! Binds property valueSource to the context attribute specified by path.
void	destroyAllValues() Destroys all entries in the list of Values.
java.lang.String	getCustomizingID() Returns the value of the customizingID property.
java.lang.String	getEventID() Returns the value of the eventID property.
java.lang.String	getLabel() Returns the value of the label property.
IWDSeries	getSeries() Returns the current Series.
java.lang.String	getTooltip() Returns the value of the tooltip property.
IWDAbstractValue	getValue(int index) Returns the Value at the given index.
IWDAbstractValue[]	getValues() Returns the list of Values.
boolean	hasValues() Checks if there exist Values.
int	indexOfValue(IWDAbstractValue aAbstractValue) Returns the index of the given element in the list of Values or -1 if it is not contained in the list.
java.util.Iterator	iterateValues() Returns an iterator over the list of Values.
int	numberOfValues() Returns the number of Values.
void	removeAllValues() Removes all entries from the list of Values.
IWDAbstractValue	removeValue(int index) Removes the entry at the given index from the list of Values.
IWDAbstractValue	removeValue(java.lang.String id) Removes the entry with the given ID from the list of Values.
void	setCustomizingID(java.lang.String value) Sets property customizingID 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	setTooltip(java.lang.String value) Sets property tooltip to the new value.
void	swapValues(int i, int j) Swaps the Values at the given indices.

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

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

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

bindValueSource

public void bindValueSource(java.lang.String path)

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

Parameters:

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

bindValueSource

public void bindValueSource(IWDNodeInfo nodeInfo)

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

Parameters:

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

bindingOfValueSource

public java.lang.String bindingOfValueSource()

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

Returns:

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

addValue

public void addValue(IWDAbstractValue aAbstractValue)

Adds the given Value at the end of the list of Values.

Parameters:

aAbstractValue - the Value to be added into the list

See Also:

getValues()

addValue

public void addValue(IWDAbstractValue aAbstractValue,
                     int index)

Adds the given Value at the specified index in the list of Values.

Parameters:

aAbstractValue - the Value to be added into the list

index - zero based index of the insertion position in the list

See Also:

getValues()

swapValues

public void swapValues(int i,
                       int j)

Swaps the Values at the given indices.

Parameters:

i - index of the first Value to swap

j - index of the second Value to swap

Throws:

IndexOutOfBoundsException - If one of the indices is out of bounds

getValues

public IWDAbstractValue[] getValues()

Returns the list of Values.

Returns:

an array containing references to the current Values

getValue

public IWDAbstractValue getValue(int index)

Returns the Value at the given index.

Returns:

Value at the given index

indexOfValue

public int indexOfValue(IWDAbstractValue aAbstractValue)

Returns the index of the given element in the list of Values or -1 if it is not contained in the list.

numberOfValues

public int numberOfValues()

Returns the number of Values.

Returns:

the current number of Values.

See Also:

getValues()

hasValues

public boolean hasValues()

Checks if there exist Values.

Returns:

true if there are Values; false otherwise.

See Also:

getValues()

iterateValues

public java.util.Iterator iterateValues()

Returns an iterator over the list of Values.

Returns:

an iterator over the current Values

See Also:

getValues()

removeValue

public IWDAbstractValue removeValue(int index)

Removes the entry at the given index from the list of Values. This does not destroy the removed element, i.e. it may be added again!

Parameters:

index - zero based index of the deletion position in the list

Returns:

the removed element

See Also:

addValue(IWDAbstractValue), getValues()

removeValue

public IWDAbstractValue removeValue(java.lang.String id)

Removes the entry with the given ID from the list of Values. This does not destroy the removed element, i.e. it may be added again!

Parameters:

id - unique ID of the element to be deleted from the list

Returns:

the removed element

See Also:

addValue(IWDAbstractValue), getValues()

removeAllValues

public void removeAllValues()

Removes all entries from the list of Values. This does not destroy the removed elements, i.e. they may be added again!

See Also:

addValue(IWDAbstractValue), getValues()

destroyAllValues

public void destroyAllValues()

Destroys all entries in the list of Values. Destroyed elements do not exist any longer, i.e. new elements may be created with the same IDs.

getSeries

public IWDSeries getSeries()

Returns the current Series.

Returns:

the current Series