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!

Field Summary

static java.lang.String	DEFAULT_ACCESSIBILITY_DESCRIPTION Default value of property accessibilityDescription.
static double	DEFAULT_BOTTOM Default value of property bottom.
static int	DEFAULT_HEIGHT Default value of property height.
static java.lang.String	DEFAULT_IGS_URL Default value of property igsUrl.
static double	DEFAULT_LEFT Default value of property left.
static WDMoveType	DEFAULT_MOVE_TYPE Default value of property moveType.
static double	DEFAULT_RIGHT Default value of property right.
static double	DEFAULT_TOP Default value of property top.
static int	DEFAULT_WIDTH Default value of property width.
static WDZoomType	DEFAULT_ZOOM_TYPE Default value of property zoomType.

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindAccessibilityDescription(IWDAttributeInfo attributeInfo) Binds property accessibilityDescription to the context attribute specified by the given attribute info.
void	bindAccessibilityDescription(java.lang.String path) Binds property accessibilityDescription to the context attribute specified by path.
void	bindBottom(IWDAttributeInfo attributeInfo) Binds property bottom to the context attribute specified by the given attribute info.
void	bindBottom(java.lang.String path) Binds property bottom to the context attribute specified by path.
void	bindGeoObjectSource(IWDAttributeInfo attributeInfo) Binds property geoObjectSource to the context attribute specified by the given attribute info.
void	bindGeoObjectSource(java.lang.String path) Binds property geoObjectSource to the context attribute specified by path.
java.lang.String	bindingOfAccessibilityDescription() Binding path of property accessibilityDescription.
java.lang.String	bindingOfBottom() Binding path of property bottom.
java.lang.String	bindingOfGeoObjectSource() Binding path of property geoObjectSource.
java.lang.String	bindingOfLeft() Binding path of property left.
java.lang.String	bindingOfRight() Binding path of property right.
java.lang.String	bindingOfTop() Binding path of property top.
void	bindLeft(IWDAttributeInfo attributeInfo) Binds property left to the context attribute specified by the given attribute info.
void	bindLeft(java.lang.String path) Binds property left to the context attribute specified by path.
void	bindRight(IWDAttributeInfo attributeInfo) Binds property right to the context attribute specified by the given attribute info.
void	bindRight(java.lang.String path) Binds property right to the context attribute specified by path.
void	bindTop(IWDAttributeInfo attributeInfo) Binds property top to the context attribute specified by the given attribute info.
void	bindTop(java.lang.String path) Binds property top to the context attribute specified by path.
java.lang.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.
java.lang.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 to which the event onObjectAction is mapped.
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 of event onObjectAction.
void	restoreOriginalCoordinates() Restore to geo coordinates that were set by application
void	setAccessibilityDescription(java.lang.String value) Sets property accessibilityDescription to the new value.
void	setBottom(double value) Sets property bottom to the new 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	setLeft(double value) Sets property left to the new value.
void	setMoveType(WDMoveType moveType) Sets property moveType to the given value.
void	setOnObjectAction(IWDAction action) Maps the event onObjectAction to the given action.
void	setRight(double value) Sets property right to the new value.
void	setTop(double value) Sets property top to the new value.
void	setWidth(int width) Sets property width to the given value.
void	setZoomType(WDZoomType zoomType) Sets property zoomType 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

getId, getView, requestFocus

Field Detail

DEFAULT_ACCESSIBILITY_DESCRIPTION

public static final java.lang.String DEFAULT_ACCESSIBILITY_DESCRIPTION

Default value of property accessibilityDescription.

DEFAULT_BOTTOM

public static final double DEFAULT_BOTTOM

Default value of property bottom.

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_LEFT

public static final double DEFAULT_LEFT

Default value of property left.

DEFAULT_MOVE_TYPE

public static final WDMoveType DEFAULT_MOVE_TYPE

Default value of property moveType.

DEFAULT_RIGHT

public static final double DEFAULT_RIGHT

Default value of property right.

DEFAULT_TOP

public static final double DEFAULT_TOP

Default value of property top.

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

Default value of property width.

DEFAULT_ZOOM_TYPE

public static final WDZoomType DEFAULT_ZOOM_TYPE

Default value of property zoomType.

Method Detail

getOnObjectAction

public IWDAction getOnObjectAction()

Returns the action to which the event onObjectAction is mapped.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnObjectAction()

setOnObjectAction

public void setOnObjectAction(IWDAction action)

Maps the event onObjectAction to the given action.

Parameters:

action - the action for the event

See Also:

getOnObjectAction()

mappingOfOnObjectAction

public IWDParameterMapping mappingOfOnObjectAction()

Returns the parameter mapping of event onObjectAction.

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:

getOnObjectAction()

bindAccessibilityDescription

public void bindAccessibilityDescription(java.lang.String path)

Binds property accessibilityDescription to the context attribute specified by path.

Parameters:

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

bindAccessibilityDescription

public void bindAccessibilityDescription(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfAccessibilityDescription

public java.lang.String bindingOfAccessibilityDescription()

Binding path of property accessibilityDescription.

Returns:

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

getAccessibilityDescription

public java.lang.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(java.lang.String value)

Sets property accessibilityDescription to the new value.

Parameters:

value - the new value of the accessibilityDescription property

See Also:

getAccessibilityDescription()

bindBottom

public void bindBottom(java.lang.String path)

Binds property bottom to the context attribute specified by path.

Parameters:

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

bindBottom

public void bindBottom(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfBottom

public java.lang.String bindingOfBottom()

Binding path of property bottom.

Returns:

the path of the context attribute to which the bottom 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 property bottom to the new value.

Parameters:

value - the new value of the bottom property

See Also:

getBottom()

bindGeoObjectSource

public void bindGeoObjectSource(java.lang.String path)

Binds property geoObjectSource to the context attribute specified by path.

Parameters:

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

bindGeoObjectSource

public void bindGeoObjectSource(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfGeoObjectSource

public java.lang.String bindingOfGeoObjectSource()

Binding path of property geoObjectSource.

Returns:

the path of the context attribute to which the geoObjectSource 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 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 "". 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(java.lang.String igsUrl)

Sets property igsUrl to the given value.

Parameters:

igsUrl - the new igsUrl value

See Also:

getIgsUrl()

bindLeft

public void bindLeft(java.lang.String path)

Binds property left to the context attribute specified by path.

Parameters:

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

bindLeft

public void bindLeft(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfLeft

public java.lang.String bindingOfLeft()

Binding path of property left.

Returns:

the path of the context attribute to which the left 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 property left to the new 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 property moveType to the given value.

Parameters:

moveType - the new moveType value

See Also:

getMoveType()

bindRight

public void bindRight(java.lang.String path)

Binds property right to the context attribute specified by path.

Parameters:

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

bindRight

public void bindRight(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfRight

public java.lang.String bindingOfRight()

Binding path of property right.

Returns:

the path of the context attribute to which the right 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 property right to the new value.

Parameters:

value - the new value of the right property

See Also:

getRight()

bindTop

public void bindTop(java.lang.String path)

Binds property top to the context attribute specified by path.

Parameters:

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

bindTop

public void bindTop(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTop

public java.lang.String bindingOfTop()

Binding path of property top.

Returns:

the path of the context attribute to which the top 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 property top to the new 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 property width to the given value.

Parameters:

width - the new width value

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

Parameters:

zoomType - the new zoomType value

See Also:

getZoomType()

restoreOriginalCoordinates

public void restoreOriginalCoordinates()

Restore to geo coordinates that were set by application