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

All Superinterfaces:

IWDAbstractIgsElement, IWDUIElement, IWDViewElement

public interface IWDBusinessGraphics

extends IWDAbstractIgsElement

Web Dynpro BusinessGraphics API. The BusinessGraphics UI element provides several chart types such as vertical bar charts or pie charts, that can be used for the graphical illustration of data and data relationships. In addition, there are more complex chart types such as portfolio and gantt that can help the user of your Web application to make decisions for corporate planning or find information in general.

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

Field Summary

static java.lang.String	DEFAULT_BACKGROUND_COLOR Default value of property backgroundColor.
static WDBusinessGraphicsType	DEFAULT_CHART_TYPE Default value of property chartType.
static java.lang.String	DEFAULT_CUSTOMIZING Default value of property customizing.
static WDBusinessGraphicsDimension	DEFAULT_DIMENSION Default value of property dimension.
static java.lang.String	DEFAULT_FONT_FAMILY Default value of property fontFamily.
static int	DEFAULT_HEIGHT Default value of property height.
static java.lang.String	DEFAULT_IGS_URL Default value of property igsUrl.
static java.lang.String	DEFAULT_TRANSPARENT_COLOR Default value of property transparentColor.
static int	DEFAULT_WIDTH Default value of property width.

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	addSeries(IWDAbstractSeries aAbstractSeries) Adds the given Series at the end of the list of SeriesList.
void	addSeries(IWDAbstractSeries aAbstractSeries, int index) Adds the given Series at the specified index in the list of SeriesList.
java.lang.String	bindingOfSeriesSource() Note: This property must be bound to the context! Binding path of property seriesSource.
void	bindSeriesSource(IWDNodeInfo nodeInfo) Note: This property must be bound to the context! Binds property seriesSource to the context node specified by the given node info.
void	bindSeriesSource(java.lang.String path) Note: This property must be bound to the context! Binds property seriesSource to the context attribute specified by path.
void	destroyAllSeriesList() Destroys all entries in the list of SeriesList.
void	destroyCategory() Destroys the Category instance.
java.lang.String	getBackgroundColor() Returns the value of the backgroundColor property.
IWDCategory	getCategory() Gets the Category instance.
WDBusinessGraphicsType	getChartType() Returns the value of the chartType property.
java.lang.String	getCustomizing() Returns the value of the customizing property.
WDBusinessGraphicsDimension	getDimension() Returns the value of the dimension property.
java.lang.String	getFontFamily() Returns the value of the fontFamily property.
int	getHeight() Returns the value of the height property.
java.lang.String	getIgsUrl() Returns the value of the igsUrl property.
IWDAction	getOnAction() Returns the action to which the event onAction is mapped.
IWDAbstractSeries	getSeries(int index) Returns the Series at the given index.
IWDAbstractSeries[]	getSeriesList() Returns the list of SeriesList.
java.lang.String	getTransparentColor() Returns the value of the transparentColor property.
int	getWidth() Returns the value of the width property.
boolean	hasSeriesList() Checks if there exist SeriesList.
int	indexOfSeries(IWDAbstractSeries aAbstractSeries) Returns the index of the given element in the list of SeriesList or -1 if it is not contained in the list.
java.util.Iterator	iterateSeriesList() Returns an iterator over the list of SeriesList.
IWDParameterMapping	mappingOfOnAction() Returns the parameter mapping of event onAction.
int	numberOfSeriesList() Returns the number of SeriesList.
void	removeAllSeriesList() Removes all entries from the list of SeriesList.
IWDAbstractSeries	removeSeries(int index) Removes the entry at the given index from the list of SeriesList.
IWDAbstractSeries	removeSeries(java.lang.String id) Removes the entry with the given ID from the list of SeriesList.
void	setBackgroundColor(java.lang.String backgroundColor) Sets property backgroundColor to the given value.
void	setCategory(IWDCategory category) Sets the Category instance.
void	setChartType(WDBusinessGraphicsType chartType) Sets property chartType to the given value.
void	setCustomizing(java.lang.String customizing) Sets property customizing to the given value.
void	setDimension(WDBusinessGraphicsDimension dimension) Sets property dimension to the given value.
void	setDirectCustomizing(java.lang.String directCustomizing) Sets the customizing directly, only available as method call.
void	setFontFamily(java.lang.String fontFamily) Sets property fontFamily to the given value.
void	setHeight(int height) Sets property height to the given value.
void	setIgsUrl(java.lang.String igsUrl) Sets property igsUrl to the given value.
void	setOnAction(IWDAction action) Maps the event onAction to the given action.
void	setTransparentColor(java.lang.String transparentColor) Sets property transparentColor to the given value.
void	setWidth(int width) Sets property width to the given value.
void	swapSeriesList(int i, int j) Swaps the SeriesList at the given indices.

Methods inherited from interface com.sap.tc.webdynpro.clientserver.uielib.graphics.api.IWDAbstractIgsElement

forceUpdate, getHasError

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

bindEnabled, bindEnabled, bindingOfEnabled, bindingOfTooltip, bindingOfVisible, bindTooltip, bindTooltip, bindVisible, bindVisible, createLayoutData, getContainer, getEnabled, getLayoutData, getTooltip, getVisible, setEnabled, setTooltip, setVisible

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

getId, getView, requestFocus

Field Detail

DEFAULT_BACKGROUND_COLOR

public static final java.lang.String DEFAULT_BACKGROUND_COLOR

Default value of property backgroundColor.

DEFAULT_CHART_TYPE

public static final WDBusinessGraphicsType DEFAULT_CHART_TYPE

Default value of property chartType.

DEFAULT_CUSTOMIZING

public static final java.lang.String DEFAULT_CUSTOMIZING

Default value of property customizing.

DEFAULT_DIMENSION

public static final WDBusinessGraphicsDimension DEFAULT_DIMENSION

Default value of property dimension.

DEFAULT_FONT_FAMILY

public static final java.lang.String DEFAULT_FONT_FAMILY

Default value of property fontFamily.

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT

Default value of property height.

DEFAULT_IGS_URL

public static final java.lang.String DEFAULT_IGS_URL

Default value of property igsUrl.

DEFAULT_TRANSPARENT_COLOR

public static final java.lang.String DEFAULT_TRANSPARENT_COLOR

Default value of property transparentColor.

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

Default value of property width.

Method Detail

getOnAction

public IWDAction getOnAction()

Returns the action to which the event onAction is mapped.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnAction()

setOnAction

public void setOnAction(IWDAction action)

Maps the event onAction to the given action.

Parameters:

action - the action for the event

See Also:

getOnAction()

mappingOfOnAction

public IWDParameterMapping mappingOfOnAction()

Returns the parameter mapping of event onAction.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• String id -

Returns:

parameter mapping list.

See Also:

getOnAction()

getBackgroundColor

public java.lang.String getBackgroundColor()

Returns the value of the backgroundColor property. The initial value is "". The background color.

Returns:

the value of the backgroundColor property

See Also:

setBackgroundColor(String)

setBackgroundColor

public void setBackgroundColor(java.lang.String backgroundColor)

Sets property backgroundColor to the given value.

Parameters:

backgroundColor - the new backgroundColor value

See Also:

getBackgroundColor()

getChartType

public WDBusinessGraphicsType getChartType()

Returns the value of the chartType property. The initial value is WDBusinessGraphicsType.COLUMNS. Specifies the chart type.

Returns:

the value of the chartType property

See Also:

setChartType(WDBusinessGraphicsType)

setChartType

public void setChartType(WDBusinessGraphicsType chartType)

Sets property chartType to the given value.

Parameters:

chartType - the new chartType value

See Also:

getChartType()

getCustomizing

public java.lang.String getCustomizing()

Returns the value of the customizing property. The initial value is "". Describes how the chart is displayed on the screen. This property is assigned to a Web address (URL) linking to an XML file that describes the appearance of the business graphic on the screen - for example, the graphic color, the background color, fonts, and so on. It also specifies whether the graphic displays a legend or not. You can also specify these settings directly in the SAP NetWeaver Developer Studio using the Chart Designer tool. To call the tool, place the cursor on the UI element, click the right mouse button, and select the Start Chart Designer menu option in the context menu. Other attributes (e.g. dimension, fontFamily etc.) override these settings if they collide.

Returns:

the value of the customizing property

See Also:

setCustomizing(String)

setCustomizing

public void setCustomizing(java.lang.String customizing)

Sets property customizing to the given value.

Parameters:

customizing - the new customizing value

See Also:

getCustomizing()

getDimension

public WDBusinessGraphicsDimension getDimension()

Returns the value of the dimension property. The initial value is WDBusinessGraphicsDimension.TWO. Describes the dimensions of the chart. The following dimensions are available: pseudo_three A pseudo-three-dimensional chart, the z-axis is not displayed. three A real three-dimensional chart. two A two-dimensional chart (surface diagram).

Returns:

the value of the dimension property

See Also:

setDimension(WDBusinessGraphicsDimension)

setDimension

public void setDimension(WDBusinessGraphicsDimension dimension)

Sets property dimension to the given value.

Parameters:

dimension - the new dimension value

See Also:

getDimension()

getFontFamily

public java.lang.String getFontFamily()

Returns the value of the fontFamily property. The initial value is "". Specifies the font family for the graphic elements.

Returns:

the value of the fontFamily property

See Also:

setFontFamily(String)

setFontFamily

public void setFontFamily(java.lang.String fontFamily)

Sets property fontFamily to the given value.

Parameters:

fontFamily - the new fontFamily value

See Also:

getFontFamily()

getHeight

public int getHeight()

Returns the value of the height property. The initial value is 300. Specifies the height of the chart and can be specified in relative CSS units like em, ex, or percentage.

Returns:

the value of the height property

See Also:

setHeight(int)

setHeight

public void setHeight(int height)

Sets property height to the given value.

Parameters:

height - the new height value

See Also:

getHeight()

getIgsUrl

public java.lang.String getIgsUrl()

Returns the value of the igsUrl property. The initial value is "". This property can specify the Web address (URL) of the server on which the Internet Graphics Service should run. You can use it to overwrite the global URL for which the Web Dynpro System Configuration in the default.properties file has been set.

Returns:

the value of the igsUrl property

See Also:

setIgsUrl(String)

setIgsUrl

public void setIgsUrl(java.lang.String igsUrl)

Sets property igsUrl to the given value.

Parameters:

igsUrl - the new igsUrl value

See Also:

getIgsUrl()

bindSeriesSource

public void bindSeriesSource(java.lang.String path)

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

Parameters:

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

bindSeriesSource

public void bindSeriesSource(IWDNodeInfo nodeInfo)

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

Parameters:

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

bindingOfSeriesSource

public java.lang.String bindingOfSeriesSource()

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

Returns:

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

getTransparentColor

public java.lang.String getTransparentColor()

Returns the value of the transparentColor property. The initial value is "". The color that is to be handled as transparent. Colors can be specified as RGB, HSB or X11-like. e.g. "rgb(255,0,0)" or "slateblue".

Returns:

the value of the transparentColor property

See Also:

setTransparentColor(String)

setTransparentColor

public void setTransparentColor(java.lang.String transparentColor)

Sets property transparentColor to the given value.

Parameters:

transparentColor - the new transparentColor value

See Also:

getTransparentColor()

getWidth

public int getWidth()

Returns the value of the width property. The initial value is 300. Specifies the width of the chart and can be specified in relative CSS units like em, ex, or percentage.

Returns:

the value of the width property

See Also:

setWidth(int)

setWidth

public void setWidth(int width)

Sets property width to the given value.

Parameters:

width - the new width value

See Also:

getWidth()

getCategory

public IWDCategory getCategory()

Gets the Category instance.

Returns:

the current Category

See Also:

setCategory(IWDCategory)

setCategory

public void setCategory(IWDCategory category)

Sets the Category instance.

Parameters:

category - the new category

See Also:

getCategory()

destroyCategory

public void destroyCategory()

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

addSeries

public void addSeries(IWDAbstractSeries aAbstractSeries)

Adds the given Series at the end of the list of SeriesList.

Parameters:

aAbstractSeries - the Series to be added into the list

See Also:

getSeriesList()

addSeries

public void addSeries(IWDAbstractSeries aAbstractSeries,
                      int index)

Adds the given Series at the specified index in the list of SeriesList.

Parameters:

aAbstractSeries - the Series to be added into the list

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

See Also:

getSeriesList()

swapSeriesList

public void swapSeriesList(int i,
                           int j)

Swaps the SeriesList at the given indices.

Parameters:

i - index of the first Series to swap

j - index of the second Series to swap

Throws:

IndexOutOfBoundsException - If one of the indices is out of bounds

getSeriesList

public IWDAbstractSeries[] getSeriesList()

Returns the list of SeriesList.

Returns:

an array containing references to the current SeriesList

getSeries

public IWDAbstractSeries getSeries(int index)

Returns the Series at the given index.

Returns:

Series at the given index

indexOfSeries

public int indexOfSeries(IWDAbstractSeries aAbstractSeries)

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

numberOfSeriesList

public int numberOfSeriesList()

Returns the number of SeriesList.

Returns:

the current number of SeriesList.

See Also:

getSeriesList()

hasSeriesList

public boolean hasSeriesList()

Checks if there exist SeriesList.

Returns:

true if there are SeriesList; false otherwise.

See Also:

getSeriesList()

iterateSeriesList

public java.util.Iterator iterateSeriesList()

Returns an iterator over the list of SeriesList.

Returns:

an iterator over the current SeriesList

See Also:

getSeriesList()

removeSeries

public IWDAbstractSeries removeSeries(int index)

Removes the entry at the given index from the list of SeriesList. 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:

addSeries(IWDAbstractSeries), getSeriesList()

removeSeries

public IWDAbstractSeries removeSeries(java.lang.String id)

Removes the entry with the given ID from the list of SeriesList. 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:

addSeries(IWDAbstractSeries), getSeriesList()

removeAllSeriesList

public void removeAllSeriesList()

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

See Also:

addSeries(IWDAbstractSeries), getSeriesList()

destroyAllSeriesList

public void destroyAllSeriesList()

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

setDirectCustomizing

public void setDirectCustomizing(java.lang.String directCustomizing)

Sets the customizing directly, only available as method call. Overwrites customizing from branding, ChartDesigner and convenience properties

Parameters:

directCustomzing -