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!

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 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_TOOLTIP Default value of the tooltip property is "".

Method Summary

void	addValue(IWDAbstractValue value) Adds the given Value at the end of the Values list.
void	addValue(IWDAbstractValue value, int index) Inserts the given Value at the specified (zero-based) index into the Values list.
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	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	bindingOfEventID() Returns the binding path of the eventID property.
String	bindingOfLabel() Returns the binding path of the label property.
String	bindingOfTooltip() Returns the binding path of the tooltip property.
String	bindingOfValueSource() Returns the binding path of the valueSource 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	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	bindValueSource(IWDNodeInfo nodeInfo) Binds the valueSource property to the context node specified by the given node info.
void	bindValueSource(String path) Binds the valueSource property to the context attribute specified by the given path.
void	destroyAllValues() Destroys all elements in the Values list.
String	getCustomizingID() Returns the value of the customizingID property.
String	getEventID() Returns the value of the eventID property.
String	getLabel() Returns the value of the label property.
IWDSeries	getSeries() Returns the Series this Point belongs to
String	getTooltip() Returns the value of the tooltip property.
IWDAbstractValue	getValue(int index) Returns the Value at the given index.
IWDAbstractValue[]	getValues() Returns the Values list as an array
boolean	hasValues() Returns true if there exists a Value.
int	indexOfValue(IWDAbstractValue value) Returns the index of the given element in the Values list, returns -1 if the element is not in the list.
Iterator	iterateValues() Returns an iterator over the Values list.
int	numberOfValues() Returns the number of Values.
void	removeAllValues() Removes all elements from the Values list.
IWDAbstractValue	removeValue(int index) Removes the Value at the given index from the Values list.
IWDAbstractValue	removeValue(String id) Removes the Value with the given ID from the Values list.
void	setCustomizingID(String value) Sets the customizingID 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	setTooltip(String value) Sets the tooltip property to the given 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

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

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

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

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

bindValueSource

public void bindValueSource(String path)

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

Parameters:

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

bindValueSource

public void bindValueSource(IWDNodeInfo nodeInfo)

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

Parameters:

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

bindingOfValueSource

public String bindingOfValueSource()

Returns the binding path of the valueSource property.

Returns:

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

addValue

public void addValue(IWDAbstractValue value)

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

Parameters:

value - the Value to be added to the list

See Also:

getValues()

addValue

public void addValue(IWDAbstractValue value,
                     int index)

Inserts the given Value at the specified (zero-based) index into the Values list.

Parameters:

value - the Value to be inserted into the list

index - (zero-based) 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 Values list as an array.

Returns:

an array containing the current Values list

getValue

public IWDAbstractValue getValue(int index)

Returns the Value at the given index.

Returns:

Value at the given index

indexOfValue

public int indexOfValue(IWDAbstractValue value)

Returns the index of the given element in the Values list, returns -1 if the element is not in the list.

numberOfValues

public int numberOfValues()

Returns the number of Values.

Returns:

the number of Values

See Also:

getValues()

hasValues

public boolean hasValues()

Returns true if there exists a Value.

Returns:

true if there exists a Value, otherwise returns false

See Also:

getValues()

iterateValues

public Iterator iterateValues()

Returns an iterator over the Values list.

Returns:

an iterator over the Values list

See Also:

getValues()

removeValue

public IWDAbstractValue removeValue(int index)

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

Parameters:

index - (zero-based) index of the removal position in the list

Returns:

the removed element

See Also:

addValue(IWDAbstractValue), getValues()

removeValue

public IWDAbstractValue removeValue(String id)

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

Parameters:

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

Returns:

the removed element

See Also:

addValue(IWDAbstractValue), getValues()

removeAllValues

public void removeAllValues()

Removes all elements from the Values list. 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 elements in the Values list. Destroyed view elements do not exist any longer in their view, i.e. new elements may be created with the same IDs.

getSeries

public IWDSeries getSeries()

Returns the Series this Point belongs to.

Returns:

the Series this Point belongs to