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

Interface IWDGeoMap

All Superinterfaces:

IWDAbstractIgsElement, IWDUIElement, IWDViewElement

public interface IWDGeoMap

extends IWDAbstractIgsElement

Web Dynpro GeoMap API. You can use the GeoMap UI element to display a section of a map. GEO ROUTING IS ONLY FUNCTIONAL IF AN IGS WITH ADDITIONAL GEO-SERVICES IS INSTALLED.

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

IWDGeoMap.IWDOnObjectAction Interface defining the parameter names for event onObjectAction.

Field Summary

static String	DEFAULT_ACCESSIBILITY_DESCRIPTION Default value of the accessibilityDescription property is "".
static double	DEFAULT_BOTTOM Default value of the bottom property is 0.0.
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 double	DEFAULT_LEFT Default value of the left property is 0.0.
static WDMoveType	DEFAULT_MOVE_TYPE Default value of the moveType property is WDMoveType.NONE.
static double	DEFAULT_RIGHT Default value of the right property is 0.0.
static double	DEFAULT_TOP Default value of the top property is 0.0.
static int	DEFAULT_WIDTH Default value of the width property is 300.
static WDZoomType	DEFAULT_ZOOM_TYPE Default value of the zoomType property is WDZoomType.NONE.

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindAccessibilityDescription(IWDAttributeInfo attributeInfo) Binds the accessibilityDescription property to the context attribute specified by the given attribute info.
void	bindAccessibilityDescription(String path) Binds the accessibilityDescription property to the context attribute specified by the given path.
void	bindBottom(IWDAttributeInfo attributeInfo) Binds the bottom property to the context attribute specified by the given attribute info.
void	bindBottom(String path) Binds the bottom property to the context attribute specified by the given path.
void	bindGeoObjectSource(IWDAttributeInfo attributeInfo) Binds the geoObjectSource property to the context attribute specified by the given attribute info.
void	bindGeoObjectSource(String path) Binds the geoObjectSource property to the context attribute specified by the given path.
String	bindingOfAccessibilityDescription() Returns the binding path of the accessibilityDescription property.
String	bindingOfBottom() Returns the binding path of the bottom property.
String	bindingOfGeoObjectSource() Returns the binding path of the geoObjectSource property.
String	bindingOfLeft() Returns the binding path of the left property.
String	bindingOfRight() Returns the binding path of the right property.
String	bindingOfTop() Returns the binding path of the top property.
void	bindLeft(IWDAttributeInfo attributeInfo) Binds the left property to the context attribute specified by the given attribute info.
void	bindLeft(String path) Binds the left property to the context attribute specified by the given path.
void	bindRight(IWDAttributeInfo attributeInfo) Binds the right property to the context attribute specified by the given attribute info.
void	bindRight(String path) Binds the right property to the context attribute specified by the given path.
void	bindTop(IWDAttributeInfo attributeInfo) Binds the top property to the context attribute specified by the given attribute info.
void	bindTop(String path) Binds the top property to the context attribute specified by the given path.
String	getAccessibilityDescription() Returns the value of the accessibilityDescription property.
double	getBottom() Returns the value of the bottom property.
int	getHeight() Returns the value of the height property.
String	getIgsUrl() Returns the value of the igsUrl property.
double	getLeft() Returns the value of the left property.
WDMoveType	getMoveType() Returns the value of the moveType property.
IWDAction	getOnObjectAction() Returns the action assigned to event onObjectAction
double	getRight() Returns the value of the right property.
double	getTop() Returns the value of the top property.
int	getWidth() Returns the value of the width property.
WDZoomType	getZoomType() Returns the value of the zoomType property.
IWDParameterMapping	mappingOfOnObjectAction() Returns the parameter mapping for event onObjectAction.
void	restoreOriginalCoordinates() Restore to geo coordinates that were set by application
void	setAccessibilityDescription(String value) Sets the accessibilityDescription property to the given value.
void	setBottom(double value) Sets the bottom 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	setLeft(double value) Sets the left property to the given value.
void	setMoveType(WDMoveType moveType) Sets the moveType property to the given value.
void	setOnObjectAction(IWDAction action) Assigns the given action to event onObjectAction.
void	setRight(double value) Sets the right property to the given value.
void	setTop(double value) Sets the top property to the given value.
void	setWidth(int width) Sets the width property to the given value.
void	setZoomType(WDZoomType zoomType) Sets the zoomType property to the given value.

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_ACCESSIBILITY_DESCRIPTION

public static final String DEFAULT_ACCESSIBILITY_DESCRIPTION

Default value of the accessibilityDescription property is "".

See Also:

Constant Field Values

DEFAULT_BOTTOM

public static final double DEFAULT_BOTTOM

Default value of the bottom property is 0.0.

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_LEFT

public static final double DEFAULT_LEFT

Default value of the left property is 0.0.

See Also:

Constant Field Values

DEFAULT_MOVE_TYPE

public static final WDMoveType DEFAULT_MOVE_TYPE

Default value of the moveType property is WDMoveType.NONE.

DEFAULT_RIGHT

public static final double DEFAULT_RIGHT

Default value of the right property is 0.0.

See Also:

Constant Field Values

DEFAULT_TOP

public static final double DEFAULT_TOP

Default value of the top property is 0.0.

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

DEFAULT_ZOOM_TYPE

public static final WDZoomType DEFAULT_ZOOM_TYPE

Default value of the zoomType property is WDZoomType.NONE.

Method Detail

getOnObjectAction

public IWDAction getOnObjectAction()

Returns the action assigned to event onObjectAction.

Returns:

the action assigned to event onObjectAction

See Also:

mappingOfOnObjectAction()

setOnObjectAction

public void setOnObjectAction(IWDAction action)

Assigns the given action to event onObjectAction.

Parameters:

action - the action assigned to the event

See Also:

getOnObjectAction()

mappingOfOnObjectAction

public IWDParameterMapping mappingOfOnObjectAction()

Returns the parameter mapping for event onObjectAction.

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)
 {
   IWDGeoMap myGeoMap = (IWDGeoMap) view.getElement("ID-of-GeoMap");
   myGeoMap.mappingOfOnObjectAction().addSourceMapping
   (
     IWDGeoMap.IWDOnObjectAction.ID, // event parameter name
     "name-of-action-parameter" // (type String)
   ); 
 }

 

Event onObjectAction has the following parameters:

• String id
  

Returns:

the parameter mapping for event onObjectAction

See Also:

getOnObjectAction()

bindAccessibilityDescription

public void bindAccessibilityDescription(String path)

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

Parameters:

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

bindAccessibilityDescription

public void bindAccessibilityDescription(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfAccessibilityDescription

public String bindingOfAccessibilityDescription()

Returns the binding path of the accessibilityDescription property.

Returns:

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

getAccessibilityDescription

public String getAccessibilityDescription()

Returns the value of the accessibilityDescription property.

The initial value is "".

Accessibility description for the GeoMap. It is only used if accessibility mode (508) is switched on and will be included into the tooltip. Its read by the screen reader when the whole UI element gets the focus.

Returns:

the current value of the accessibilityDescription property

See Also:

setAccessibilityDescription(String)

setAccessibilityDescription

public void setAccessibilityDescription(String value)

Sets the accessibilityDescription property to the given value.

Parameters:

value - the new value of the accessibilityDescription property

See Also:

getAccessibilityDescription()

bindBottom

public void bindBottom(String path)

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

Parameters:

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

bindBottom

public void bindBottom(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfBottom

public String bindingOfBottom()

Returns the binding path of the bottom property.

Returns:

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

getBottom

public double getBottom()

Returns the value of the bottom property.

The initial value is 0.0.

You can use this property to specify the value of a geographical coordinate in decimal numbers according to the standard World Geodetic System - 1984 (WGS84). Together with the value of the right property, the lower right position of the section is specified.

Returns:

the current value of the bottom property

See Also:

setBottom(double)

setBottom

public void setBottom(double value)

Sets the bottom property to the given value.

Parameters:

value - the new value of the bottom property

See Also:

getBottom()

bindGeoObjectSource

public void bindGeoObjectSource(String path)

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

Parameters:

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

bindGeoObjectSource

public void bindGeoObjectSource(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfGeoObjectSource

public String bindingOfGeoObjectSource()

Returns the binding path of the geoObjectSource property.

Returns:

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

getHeight

public int getHeight()

Returns the value of the height property. The initial value is 300. Specifies the height of the UI element in pixels.

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 "". You can use this property to specify the Web address (URL) of the server on which the Internet Graphics Service is to run. This means that you can 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()

bindLeft

public void bindLeft(String path)

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

Parameters:

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

bindLeft

public void bindLeft(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfLeft

public String bindingOfLeft()

Returns the binding path of the left property.

Returns:

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

getLeft

public double getLeft()

Returns the value of the left property.

The initial value is 0.0.

You can use this property to specify the value of a geographical coordinate in decimal numbers according to the standard World Geodetic System - 1984 (WGS84). Together with the value of the top property, the upper left position of the section is specified.

Returns:

the current value of the left property

See Also:

setLeft(double)

setLeft

public void setLeft(double value)

Sets the left property to the given value.

Parameters:

value - the new value of the left property

See Also:

getLeft()

getMoveType

public WDMoveType getMoveType()

Returns the value of the moveType property. The initial value is WDMoveType.NONE. This property specifies whether the geographical border of a map can be interactively changed by the user. The moveType property can be filled with the following values and is represented by the enumeration type WDMoveType: none You cannot change the geographical border. panel Control elements allow you to change the geographical border.

Returns:

the value of the moveType property

See Also:

setMoveType(WDMoveType)

setMoveType

public void setMoveType(WDMoveType moveType)

Sets the moveType property to the given value.

Parameters:

moveType - the new value of the moveType property

See Also:

getMoveType()

bindRight

public void bindRight(String path)

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

Parameters:

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

bindRight

public void bindRight(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfRight

public String bindingOfRight()

Returns the binding path of the right property.

Returns:

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

getRight

public double getRight()

Returns the value of the right property.

The initial value is 0.0.

You can use this property to specify the value of a geographical coordinate in decimal numbers according to the standard World Geodetic System - 1984 (WGS84). Together with the value of the bottom property, the lower right position of the section is specified.

Returns:

the current value of the right property

See Also:

setRight(double)

setRight

public void setRight(double value)

Sets the right property to the given value.

Parameters:

value - the new value of the right property

See Also:

getRight()

bindTop

public void bindTop(String path)

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

Parameters:

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

bindTop

public void bindTop(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTop

public String bindingOfTop()

Returns the binding path of the top property.

Returns:

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

getTop

public double getTop()

Returns the value of the top property.

The initial value is 0.0.

You can use this property to specify the value of a geographical coordinate in decimal numbers according to the standard World Geodetic System - 1984 (WGS84). Together with the value of the left property, the upper left position of the section is specified.

Returns:

the current value of the top property

See Also:

setTop(double)

setTop

public void setTop(double value)

Sets the top property to the given value.

Parameters:

value - the new value of the top property

See Also:

getTop()

getWidth

public int getWidth()

Returns the value of the width property. The initial value is 300. Specifies the width of the UI element in pixels.

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

getZoomType

public WDZoomType getZoomType()

Returns the value of the zoomType property. The initial value is WDZoomType.NONE. Specifies the zoom behavior of the map. The zoomType property can be filled with the following values and is represented by the enumeration type WDZoomType: none Zooming within the map is not possible, and no control elements for zooming are available. panel Zooming within the map is possible.

Returns:

the value of the zoomType property

See Also:

setZoomType(WDZoomType)

setZoomType

public void setZoomType(WDZoomType zoomType)

Sets the zoomType property to the given value.

Parameters:

zoomType - the new value of the zoomType property

See Also:

getZoomType()

restoreOriginalCoordinates

public void restoreOriginalCoordinates()

Restore to geo coordinates that were set by application