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!

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

Nested Class Summary

static interface

IWDBusinessGraphics.IWDOnAction Interface defining the parameter names for event onAction.

Field Summary

static boolean	DEFAULT_ALWAYS_DISPLAY_GRAPHIC Default value of the alwaysDisplayGraphic property is false.
static String	DEFAULT_BACKGROUND_COLOR Default value of the backgroundColor property is "".
static WDBusinessGraphicsType	DEFAULT_CHART_TYPE Default value of the chartType property is WDBusinessGraphicsType.COLUMNS.
static String	DEFAULT_CUSTOMIZING Default value of the customizing property is "".
static WDBusinessGraphicsDimension	DEFAULT_DIMENSION Default value of the dimension property is WDBusinessGraphicsDimension.TWO.
static String	DEFAULT_FONT_FAMILY Default value of the fontFamily property is "".
static int	DEFAULT_HEIGHT Default value of the height property is 300.
static String	DEFAULT_IGS_URL Default value of the igsUrl property is "".
static String	DEFAULT_TRANSPARENT_COLOR Default value of the transparentColor property is "".
static int	DEFAULT_WIDTH Default value of the width property is 300.

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	addSeries(IWDAbstractSeries series) Adds the given Series at the end of the SeriesList list.
void	addSeries(IWDAbstractSeries series, int index) Inserts the given Series at the specified (zero-based) index into the SeriesList list.
void	bindAlwaysDisplayGraphic(IWDAttributeInfo attributeInfo) Binds the alwaysDisplayGraphic property to the context attribute specified by the given attribute info.
void	bindAlwaysDisplayGraphic(String path) Binds the alwaysDisplayGraphic property to the context attribute specified by the given path.
void	bindCategorySource(IWDNodeInfo nodeInfo) Binds the categorySource property to the context node specified by the given node info.
void	bindCategorySource(String path) Binds the categorySource property to the context attribute specified by the given path.
String	bindingOfAlwaysDisplayGraphic() Returns the binding path of the alwaysDisplayGraphic property.
String	bindingOfCategorySource() Returns the binding path of the categorySource property.
String	bindingOfSeriesSource() Returns the binding path of the seriesSource property.
void	bindSeriesSource(IWDNodeInfo nodeInfo) Binds the seriesSource property to the context node specified by the given node info.
void	bindSeriesSource(String path) Binds the seriesSource property to the context attribute specified by the given path.
void	destroyAllSeriesList() Destroys all elements in the SeriesList list.
void	destroyCategory() Destroys the aggregated Category element.
boolean	getAlwaysDisplayGraphic() Returns the value of the alwaysDisplayGraphic property.
String	getBackgroundColor() Returns the value of the backgroundColor property.
IWDCategory	getCategory() Returns the aggregated Category element
WDBusinessGraphicsType	getChartType() Returns the value of the chartType property.
String	getCustomizing() Returns the value of the customizing property.
WDBusinessGraphicsDimension	getDimension() Returns the value of the dimension property.
String	getFontFamily() Returns the value of the fontFamily property.
int	getHeight() Returns the value of the height property.
String	getIgsUrl() Returns the value of the igsUrl property.
IWDAction	getOnAction() Returns the action assigned to event onAction
IWDAbstractSeries	getSeries(int index) Returns the Series at the given index.
IWDAbstractSeries[]	getSeriesList() Returns the SeriesList list as an array
String	getTransparentColor() Returns the value of the transparentColor property.
int	getWidth() Returns the value of the width property.
boolean	hasSeriesList() Returns true if there exists a Series.
int	indexOfSeries(IWDAbstractSeries series) Returns the index of the given element in the SeriesList list, returns -1 if the element is not in the list.
Iterator	iterateSeriesList() Returns an iterator over the SeriesList list.
IWDParameterMapping	mappingOfOnAction() Returns the parameter mapping for event onAction.
int	numberOfSeriesList() Returns the number of SeriesList.
void	removeAllSeriesList() Removes all elements from the SeriesList list.
IWDAbstractSeries	removeSeries(int index) Removes the Series at the given index from the SeriesList list.
IWDAbstractSeries	removeSeries(String id) Removes the Series with the given ID from the SeriesList list.
void	setAlwaysDisplayGraphic(boolean value) Sets the alwaysDisplayGraphic property to the given value.
void	setBackgroundColor(String backgroundColor) Sets the backgroundColor property to the given value.
void	setCategory(IWDCategory category) Sets the aggregated Category element.
void	setChartType(WDBusinessGraphicsType chartType) Sets the chartType property to the given value.
void	setCustomizing(String customizing) Sets the customizing property to the given value.
void	setDimension(WDBusinessGraphicsDimension dimension) Sets the dimension property to the given value.
void	setDirectCustomizing(String directCustomizing) Sets the customizing directly, only available as method call.
void	setFontFamily(String fontFamily) Sets the fontFamily property to the given value.
void	setHeight(int height) Sets the height property to the given value.
void	setIgsUrl(String igsUrl) Sets the igsUrl property to the given value.
void	setOnAction(IWDAction action) Assigns the given action to event onAction.
void	setTransparentColor(String transparentColor) Sets the transparentColor property to the given value.
void	setWidth(int width) Sets the width property 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

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_ALWAYS_DISPLAY_GRAPHIC

public static final boolean DEFAULT_ALWAYS_DISPLAY_GRAPHIC

Default value of the alwaysDisplayGraphic property is false.

See Also:

Constant Field Values

DEFAULT_BACKGROUND_COLOR

public static final String DEFAULT_BACKGROUND_COLOR

Default value of the backgroundColor property is "".

See Also:

Constant Field Values

DEFAULT_CHART_TYPE

public static final WDBusinessGraphicsType DEFAULT_CHART_TYPE

Default value of the chartType property is WDBusinessGraphicsType.COLUMNS.

DEFAULT_CUSTOMIZING

public static final String DEFAULT_CUSTOMIZING

Default value of the customizing property is "".

See Also:

Constant Field Values

DEFAULT_DIMENSION

public static final WDBusinessGraphicsDimension DEFAULT_DIMENSION

Default value of the dimension property is WDBusinessGraphicsDimension.TWO.

DEFAULT_FONT_FAMILY

public static final String DEFAULT_FONT_FAMILY

Default value of the fontFamily property is "".

See Also:

Constant Field Values

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT

Default value of the height property is 300.

See Also:

Constant Field Values

DEFAULT_IGS_URL

public static final String DEFAULT_IGS_URL

Default value of the igsUrl property is "".

See Also:

Constant Field Values

DEFAULT_TRANSPARENT_COLOR

public static final String DEFAULT_TRANSPARENT_COLOR

Default value of the transparentColor property is "".

See Also:

Constant Field Values

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

Default value of the width property is 300.

See Also:

Constant Field Values

Method Detail

getOnAction

public IWDAction getOnAction()

Returns the action assigned to event onAction.

Returns:

the action assigned to event onAction

See Also:

mappingOfOnAction()

setOnAction

public void setOnAction(IWDAction action)

Assigns the given action to event onAction.

Parameters:

action - the action assigned to the event

See Also:

getOnAction()

mappingOfOnAction

public IWDParameterMapping mappingOfOnAction()

Returns the parameter mapping for event onAction.

To pass UI element event parameter values into action handler parameters, a parameter mapping has to be defined. Add code like the following inside method wdDoModifyView() of the view controller:

 if (firstTime)
 {
   IWDBusinessGraphics myBusinessGraphics = (IWDBusinessGraphics) view.getElement("ID-of-BusinessGraphics");
   myBusinessGraphics.mappingOfOnAction().addSourceMapping
   (
     IWDBusinessGraphics.IWDOnAction.ID, // event parameter name
     "name-of-action-parameter" // (type String)
   ); 
 }

 

Event onAction has the following parameters:

• String id
  

Returns:

the parameter mapping for event onAction

See Also:

getOnAction()

bindAlwaysDisplayGraphic

public void bindAlwaysDisplayGraphic(String path)

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

Parameters:

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

bindAlwaysDisplayGraphic

public void bindAlwaysDisplayGraphic(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfAlwaysDisplayGraphic

public String bindingOfAlwaysDisplayGraphic()

Returns the binding path of the alwaysDisplayGraphic property.

Returns:

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

getAlwaysDisplayGraphic

public boolean getAlwaysDisplayGraphic()

Returns the value of the alwaysDisplayGraphic property.

The initial value is false.

Determines the rendering behavior of the Business Graphic in the accessibility mode. Either the base data of the Business Graphic are automatically displayed as a table (alwaysDisplayGraphic = false) or it is rendered as a graphic (identical to the non accessibility mode). In future versions of Web Dynpro the automatic table rendering mode is deprecated. It's recommend to set alwaysDisplayGraphic = true and choose a suitable way to present the data of the Business Graphic in an accessible way.

Returns:

the current value of the alwaysDisplayGraphic property

See Also:

setAlwaysDisplayGraphic(boolean)

setAlwaysDisplayGraphic

public void setAlwaysDisplayGraphic(boolean value)

Sets the alwaysDisplayGraphic property to the given value.

Parameters:

value - the new value of the alwaysDisplayGraphic property

See Also:

getAlwaysDisplayGraphic()

getBackgroundColor

public 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(String backgroundColor)

Sets the backgroundColor property to the given value.

Parameters:

backgroundColor - the new value of the backgroundColor property

See Also:

getBackgroundColor()

bindCategorySource

public void bindCategorySource(String path)

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

Parameters:

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

bindCategorySource

public void bindCategorySource(IWDNodeInfo nodeInfo)

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

Parameters:

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

bindingOfCategorySource

public String bindingOfCategorySource()

Returns the binding path of the categorySource property.

Returns:

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

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 the chartType property to the given value.

Parameters:

chartType - the new value of the chartType property

See Also:

getChartType()

getCustomizing

public 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(String customizing)

Sets the customizing property to the given value.

Parameters:

customizing - the new value of the customizing property

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 the dimension property to the given value.

Parameters:

dimension - the new value of the dimension property

See Also:

getDimension()

getFontFamily

public 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(String fontFamily)

Sets the fontFamily property to the given value.

Parameters:

fontFamily - the new value of the fontFamily property

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 the height property to the given value.

Parameters:

height - the new value of the height property

See Also:

getHeight()

getIgsUrl

public 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(String igsUrl)

Sets the igsUrl property to the given value.

Parameters:

igsUrl - the new value of the igsUrl property

See Also:

getIgsUrl()

bindSeriesSource

public void bindSeriesSource(String path)

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

Note: This property must be bound to the context!

Parameters:

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

bindSeriesSource

public void bindSeriesSource(IWDNodeInfo nodeInfo)

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

Note: This property must be bound to the context!

Parameters:

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

bindingOfSeriesSource

public String bindingOfSeriesSource()

Returns the binding path of the seriesSource property.

Note: This property must be bound to the context!

Returns:

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

getTransparentColor

public 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(String transparentColor)

Sets the transparentColor property to the given value.

Parameters:

transparentColor - the new value of the transparentColor property

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 the width property to the given value.

Parameters:

width - the new value of the width property

See Also:

getWidth()

getCategory

public IWDCategory getCategory()

Returns the aggregated Category element.

Returns:

the aggregated Category element

See Also:

setCategory(IWDCategory)

setCategory

public void setCategory(IWDCategory category)

Sets the aggregated Category element.

Parameters:

category - the new category

See Also:

getCategory()

destroyCategory

public void destroyCategory()

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

addSeries

public void addSeries(IWDAbstractSeries series)

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

Parameters:

series - the Series to be added to the list

See Also:

getSeriesList()

addSeries

public void addSeries(IWDAbstractSeries series,
                      int index)

Inserts the given Series at the specified (zero-based) index into the SeriesList list.

Parameters:

series - the Series to be inserted into the list

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

Returns:

an array containing the current SeriesList list

getSeries

public IWDAbstractSeries getSeries(int index)

Returns the Series at the given index.

Returns:

Series at the given index

indexOfSeries

public int indexOfSeries(IWDAbstractSeries series)

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

numberOfSeriesList

public int numberOfSeriesList()

Returns the number of SeriesList.

Returns:

the number of SeriesList

See Also:

getSeriesList()

hasSeriesList

public boolean hasSeriesList()

Returns true if there exists a Series.

Returns:

true if there exists a Series, otherwise returns false

See Also:

getSeriesList()

iterateSeriesList

public Iterator iterateSeriesList()

Returns an iterator over the SeriesList list.

Returns:

an iterator over the SeriesList list

See Also:

getSeriesList()

removeSeries

public IWDAbstractSeries removeSeries(int index)

Removes the Series at the given index from the SeriesList 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:

addSeries(IWDAbstractSeries), getSeriesList()

removeSeries

public IWDAbstractSeries removeSeries(String id)

Removes the Series with the given ID from the SeriesList 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:

addSeries(IWDAbstractSeries), getSeriesList()

removeAllSeriesList

public void removeAllSeriesList()

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

setDirectCustomizing

public void setDirectCustomizing(String directCustomizing)

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