mapsuite Javascript API - IWWindowControl

Class `IWWindowControl`

Extends IWControl.

A class providing an window panel control. The control uses a IWPanelControl for the body container.

Author: KUN, JAN

Constructor Summary
`IWWindowControl(map, titel, size)` Creates an info window

Method Summary
`void`	`afterAppend()` We use this callback method for redrawing the control after it is appended to the map.
`void`	`afterClose()` Callback method. This method will be called after the window has been set to invisible. event.
`void`	`afterOpen()` Callback method. This method will be called after the window has been set to visible. event.
`void`	`beforeClose()` Callback method. This method will be called before the window will be set to invisible. event.
`void`	`beforeOpen()` Callback method. This method will be called before the window will be set to visible. event.
`void`	`buildBody()` Callback method. Override this method to build the body of the window control. appended to the DOM.
`void`	`close()` Sets the window to invisible.
`IWPanelControl`	`getContentPanel()` Returns the body part of the window
`IWSize`	`getSize()` Returns the size of the body part of the window.
`String`	`getTitle()` Returns the title of the window
`boolean`	`isCloseable()` Returns `true` if the window is closeable, otherwise it returns `false`.
`void`	`open()` Sets the window to visible.
`void`	`setCloseable(isCloseable)` Enables or disables the close button of the window.
`void`	`setSize(newSize)` Sets the size of the window control.
`void`	`setTitle(title)` Sets the title of the window.

Event Summary
`void`	`triggerOnCloseEnd()` The `onCloseEnd` event is fired before the window control is hide. Register an event listener with `IWEventManager.addListener(theWindowControl, 'oncloseend', yourHandlerMethod());` to receive the event.
`void`	`triggerOnCloseStart()` The `onCloseStart` event is fired before the window control is hide. Register an event listener with `IWEventManager.addListener(theWindowControl, 'onclosestart', yourHandlerMethod());` to receive the event.
`void`	`triggerOnOpenEnd()` The `onOpenEnd` is fired after the window control is shown. Register an event listener with `IWEventManager.addListener(theWindowControl, 'onopenend', yourHandlerMethod());` to receive the event.
`void`	`triggerOnOpenStart()` The `onOpenStart` event is fired before the window control is shown. Register an event listener with `IWEventManager.addListener(theWindowControl, 'onopenstart', yourHandlerMethod());` to receive the event.

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

beforeRemove()

afterRemove()

destroyMapElement()

Methods inherited from class IWControl

isControl()

isRedrawable()

setRedrawable(isRedrawable)

getPadding()

setPadding(newPadding)

setFirstOrientation(alignment)

getFirstOrientation()

setSecondOrientation(alignment)

getSecondOrientation()

getName()

toString()

Constructor Detail

IWWindowControl

IWWindowControl(map, titel, size)

Creates an info window

Parameters:

IWMap map

String titel

IWSize size

Method Detail

afterAppend

void afterAppend()

We use this callback method for redrawing the control after it is appended to the map.

Returns:

void

afterClose

void afterClose()

Callback method. This method will be called after the window has been set to invisible. Overwrite this method to react on this event.

Returns:

void

afterOpen

void afterOpen()

Callback method. This method will be called after the window has been set to visible. Overwrite this method to react on this event.

Returns:

void

beforeClose

void beforeClose()

Callback method. This method will be called before the window will be set to invisible. Overwrite this method to react on this event.

Returns:

void

beforeOpen

void beforeOpen()

Callback method. This method will be called before the window will be set to visible. Overwrite this method to react on this event.

Returns:

void

buildBody

void buildBody()

Callback method. Override this method to build the body of the window control. The method is called after the window control is appended to the DOM.

Parameters:

Returns:

void

close

void close()

onclosestart

oncloseend

Returns:

void

getContentPanel

IWPanelControl getContentPanel()

Returns the body part of the window

Returns:

IWPanelControl

getSize

IWSize getSize()

Returns the size of the body part of the window. The total height is plus twentyfive pixels.

Returns:

IWSize

getTitle

String getTitle()

Returns the title of the window

Returns:

String

isCloseable

boolean isCloseable()

true

false

Returns:

boolean

open

void open()

onopenstart

onopenend

Returns:

void

setCloseable

void setCloseable(isCloseable)

Enables or disables the close button of the window.

Parameters:

boolean isCloseable

Returns:

void

setSize

void setSize(newSize)

Sets the size of the window control.

Parameters:

IWSize newSize

Returns:

void

setTitle

void setTitle(title)

Sets the title of the window.

Parameters:

String title

Returns:

void

Event Detail

triggerOnCloseEnd

void triggerOnCloseEnd()

onCloseEnd

Register an event listener with IWEventManager.addListener(theWindowControl, 'oncloseend', yourHandlerMethod()); to receive the event.

Returns:

void

triggerOnCloseStart

void triggerOnCloseStart()

onCloseStart

Register an event listener with IWEventManager.addListener(theWindowControl, 'onclosestart', yourHandlerMethod()); to receive the event.

Returns:

void

triggerOnOpenEnd

void triggerOnOpenEnd()

onOpenEnd

Register an event listener with IWEventManager.addListener(theWindowControl, 'onopenend', yourHandlerMethod()); to receive the event.

Returns:

void

triggerOnOpenStart

void triggerOnOpenStart()

onOpenStart

Register an event listener with IWEventManager.addListener(theWindowControl, 'onopenstart', yourHandlerMethod()); to receive the event.

Returns:

void

Class IWWindowControl

IWWindowControl

afterAppend

afterClose

afterOpen

beforeClose

beforeOpen

buildBody

close

getContentPanel

getSize

getTitle

isCloseable

open

setCloseable

setSize

setTitle

triggerOnCloseEnd

triggerOnCloseStart

triggerOnOpenEnd

triggerOnOpenStart

Class `IWWindowControl`