| SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A class representing a set of initialization options for the map.
Author: BRE, JAN| Constructor Summary | |
IWMapOptions(map)
Creates a new options object. |
|
| Method Summary | |
String
|
getApplicationCopyright()
Returns a application specific copyright notice which extends the copyright of the currently used map type. |
number
|
getArrowKeyAction()
Returns the map action which is bound to the arrow keys. |
number
|
getBorderTiles()
Returns the number of border tiles which are placed outside of the visible map area. |
number
|
getDoubleClickAction()
Returns the map action which is bound to double clicks. |
String
|
getLanguage()
Returns the ISO 639-1 code of the language used by the map and related classes. |
number
|
getLeftMouseAction()
Returns the map action which is bound to the left mouse button. |
IWMapType
|
getMapTypeByName(name)
Returns a map type by its name. |
IWMapType[]
|
getMapTypes()
Returns an array with all map types available for this map. |
number
|
getMouseWheelAction()
Returns the map action which is bound to the mouse wheel. |
number
|
getPlusMinusKeyAction()
Returns the map action which is bound to the plus and minus keys. |
number
|
getRightMouseAction()
Returns the map action which is bound to the right mouse button. |
IWSize
|
getSize()
Returns the current size of the map in pixel. |
Object
|
getSizeInUnit()
Returns the current size of the map. |
void
|
setApplicationCopyright(applicationCopyright)
Sets a copyright notice which is appended to the copyright of the currently used map type. |
void
|
setArrowKeyAction(action)
Sets the action for the arrow keys. disable this feature by setting the value of this attribute to IWMapOptions.CONTROL_NONE. |
void
|
setBorderTiles(tiles)
Sets the number of border tiles which are placed outside of the visible map area. |
void
|
setDoubleClickAction(action)
Sets the action for a double click on the right mouse button. IWMapOptions.CONTROL_ZOOM. You can disable this feature by setting the value of this attribute to IWMapOptions.CONTROL_NONE. |
void
|
setLanguage(language)
Sets the language used by the map and related classes. The default value is english (en). IWLanguageChangeEvent.
|
void
|
setLeftMouseAction(action)
Sets the action for the left mouse button. Other possible values are IWMapOptions.CONTROL_NONE and IWMapOptions.CONTROL_ZOOM. |
void
|
setMapTypes(types)
Sets the available map types of a map. Register an onmaptypeschange event listener to receive the IWMapTypesChangeEvent.
|
void
|
setMouseWheelAction(action)
Sets the action for the mouse wheel. want to disable this feature, then you have to set this attribute to IWMapOptions.CONTROL_NONE. |
void
|
setPlusMinusKeyAction(action)
Sets the action for the plus and minus key. You can disable this feature by setting the value of this attribute to IWMapOptions.CONTROL_NONE. |
void
|
setRightMouseAction(action)
Sets the action for the right mouse button. Other possible values are IWMapOptions.CONTROL_NONE and IWMapOptions.CONTROL_MOVE. |
void
|
setSize(size)
Resizes the map to the specified size. |
| Constructor Detail |
IWMapOptions(map)
IWMap map - the map
| Method Detail |
String getApplicationCopyright()
String
number getArrowKeyAction()
number
number getBorderTiles()
number the number of border tiles.
number getDoubleClickAction()
number
String getLanguage()
String
number getLeftMouseAction()
number
IWMapType getMapTypeByName(name)
name
IWMapType
IWMapType[] getMapTypes()
IWMapType[]
number getMouseWheelAction()
number
number getPlusMinusKeyAction()
number
number getRightMouseAction()
number
IWSize getSize()
IWSize the map size in pixel
Object getSizeInUnit()
Object Object.size: IWSize, Object.unit: String
void setApplicationCopyright(applicationCopyright)
String applicationCopyright - the copyright string
void
void setArrowKeyAction(action)
int action - the new map action
void
void setBorderTiles(tiles)
int tiles - the number of border tiles.
void
void setDoubleClickAction(action)
int action - the new map action
void
void setLanguage(language)
onlanguagechange event listener to receive the
IWLanguageChangeEvent.
String language - the ISO 639-1 code of the language, e.g. en, de, fr
void
void setLeftMouseAction(action)
int action - the new map action
void
void setMapTypes(types)
onmaptypeschange event listener to receive the IWMapTypesChangeEvent.
IWMapType[] types - an array with all desired map types
void
void setMouseWheelAction(action)
int action - the new map action
void
void setPlusMinusKeyAction(action)
int action - the new map action
void
void setRightMouseAction(action)
int action - the new map action
void
void setSize(size)
IWSize size - the new size of the map
void