mapsuite Javascript API - IWToolbarControl

Class `IWToolbarControl`

Extends IWControl.

A control element to organize toolbar items.

Author: JAN

Constructor Summary
`IWToolbarControl(map)` Creates a new toolbar control.

Method Summary
`void`	`addItem(item)` Adds a new item to the toolbar.
`IWToolbarItem`	`getItem(name)` Returns the toolbar item by its name.
`void`	`removeItem(item)` Removes the specific item from the toolbar.
`String`	`toString()` Returns a string representation of this toolbar.

Event Summary
`void`	`triggerOnAppendEnd(event)` The `onAppendEnd` event is fired after a toolbar item has been appended to the toolbar control. Register an event listener with `IWEventManager.addListener(toolbarObject, 'onappendend', yourHandlerMethod(event));` to receive the `IWToolbarEvent`.
`void`	`triggerOnAppendStart(event)` The `onAppendStart` event is fired before a toolbar item is appended to the toolbar control. Register an event listener with `IWEventManager.addListener(toolbarObject, 'onappendstart', yourHandlerMethod(event));` to receive the `IWToolbarEvent`.
`void`	`triggerOnClick(event)` The `onClick` event is fired when a toolbar item is clicked. Register an event listener with `IWEventManager.addListener(toolbarObject, 'onclick', yourHandlerMethod(event));` to receive the `IWToolbarEvent`.
`void`	`triggerOnMouseOut(event)` The `onMouseOut` event is fired when the mouse pointer leaves a toolbar item. Register an event listener with `IWEventManager.addListener(toolbarObject, 'onmouseout', yourHandlerMethod(event));` to receive the `IWToolbarEvent`.
`void`	`triggerOnMouseOver(event)` The `onMouseOver` event is fired when the mouse pointer is over a toolbar item. Register an event listener with `IWEventManager.addListener(toolbarObject, 'onmouseover', yourHandlerMethod(event));` to receive the `IWToolbarEvent`.
`void`	`triggerOnRemove(event)` The `onRemove` event is fired after the item has been removed from the toolbar. Register an event listener with `IWEventManager.addListener(toolbarObject, 'onremove', yourHandlerMethod(event));` to receive the `IWToolbarEvent`.

Methods inherited from class IWDraggable

allowDraggingOutsideParent(isDraggingOutsideParentAllowed)

isDraggingOutsideParentAllowed()

setOnMouseMoveContainer(container)

getOnMouseMoveContainer()

setDraggingBounds(bounds)

getDraggingBounds()

setDraggable(isDraggable)

isDraggable()

setDraggableContainer(draggableContainer)

getDraggableContainer()

setDragButton(button)

getDragButton()

Methods inherited from class IWMapElement

isDisplayed()

getParent()

setParent(newParent)

isVisible()

setVisible(visible)

setPrintable(printable)

isPrintable()

setContainerClassname(classname)

getContainer()

setContainer(newContainer)

setId(id)

getId()

onContextMenu(event)

onMouseUp(event)

onMouseDown(event)

onMouseMove(event)

onMouseOut(event)

onMouseOver(event)

onClick(event)

onDblClick(event)

onSelect(event)

onMouseWheel(event)

beforeAppend()

afterAppend()

beforeRemove()

afterRemove()

destroyMapElement()

Methods inherited from class IWControl

isControl()

isRedrawable()

setRedrawable(isRedrawable)

getPadding()

setPadding(newPadding)

setFirstOrientation(alignment)

getFirstOrientation()

setSecondOrientation(alignment)

getSecondOrientation()

getName()

Constructor Detail

IWToolbarControl

IWToolbarControl(map)

Creates a new toolbar control.

Parameters:

IWMap map

Method Detail

addItem

void addItem(item)

Adds a new item to the toolbar.

Parameters:

IWToolbarItem item

Returns:

void

getItem

IWToolbarItem getItem(name)

Returns the toolbar item by its name.

Parameters:

name

Returns:

IWToolbarItem

removeItem

void removeItem(item)

Removes the specific item from the toolbar.

Parameters:

IWToolbarItem item

Returns:

void

toString

String toString()

Returns a string representation of this toolbar.

Returns:

String

Event Detail

triggerOnAppendEnd

void triggerOnAppendEnd(event)

onAppendEnd

Register an event listener with IWEventManager.addListener(toolbarObject, 'onappendend', yourHandlerMethod(event)); to receive the IWToolbarEvent.

Parameters:

IWToolbarEvent event

Returns:

void

triggerOnAppendStart

void triggerOnAppendStart(event)

onAppendStart

Register an event listener with IWEventManager.addListener(toolbarObject, 'onappendstart', yourHandlerMethod(event)); to receive the IWToolbarEvent.

Parameters:

IWToolbarEvent event

Returns:

void

triggerOnClick

void triggerOnClick(event)

onClick

Register an event listener with IWEventManager.addListener(toolbarObject, 'onclick', yourHandlerMethod(event)); to receive the IWToolbarEvent.

Parameters:

IWToolbarEvent event

Returns:

void

triggerOnMouseOut

void triggerOnMouseOut(event)

onMouseOut

Register an event listener with IWEventManager.addListener(toolbarObject, 'onmouseout', yourHandlerMethod(event)); to receive the IWToolbarEvent.

Parameters:

IWToolbarEvent event

Returns:

void

triggerOnMouseOver

void triggerOnMouseOver(event)

onMouseOver

Register an event listener with IWEventManager.addListener(toolbarObject, 'onmouseover', yourHandlerMethod(event)); to receive the IWToolbarEvent.

Parameters:

IWToolbarEvent event

Returns:

void

triggerOnRemove

void triggerOnRemove(event)

onRemove

Register an event listener with IWEventManager.addListener(toolbarObject, 'onremove', yourHandlerMethod(event)); to receive the IWToolbarEvent.

Parameters:

IWToolbarEvent event

Returns:

void

Class IWToolbarControl

IWToolbarControl

addItem

getItem

removeItem

toString

triggerOnAppendEnd

triggerOnAppendStart

triggerOnClick

triggerOnMouseOut

triggerOnMouseOver

triggerOnRemove

Class `IWToolbarControl`