mapsuite Javascript API - IWSlideInMenuControl

Class `IWSlideInMenuControl`

Extends IWControl.

A class providing a slide-in menu. It can add other control elements, using the IWLayoutManager.

Author: KUN, JAN

Constructor Summary
`IWSlideInMenuControl(map, size, direction)` Creates a new slide-in menu.

Method Summary
`void`	`adjustBackground(size)` Adjusts the size of the Background if Panelsize has changed.
`void`	`close()` Sets the menu to closed (without movement)
`void`	`collapse()` Closes the menu smoothly
`void`	`expand()` Opens the menu smoothly
`string`	`getBackgroundColor()` Returns the background color.
`IWLayoutManager`	`getLayoutManager()` Returns the LayoutManager for this menu.
`float`	`getOpacity()` Returns the opacity.
`IWSize`	`getSize()` Returns the size of the menu.
`boolean`	`isOpen()` Returns `true` if the slide-in menu is open otherwise `false`.
`void`	`open()` Sets the menu to opened (without movement)
`void`	`setBackgroundColor(color)` Sets the background color. There are three possible notations: Hexadecimal notation, e.g.
`void`	`setHorizontalScroll(scroll)` Sets the horizontal scroll attribute of the content panel.
`void`	`setOpacity(alpha)` Sets the opacity.
	`setSize(size)` Sets the size of the slideInMenu.
`void`	`setVerticalScroll(scroll)` Sets the vertical scroll attribute of the content panel.
`String`	`toString()` Returns a string representation of this SlideInMenu.

Event Summary
`void`	`triggerOnCloseStart()` The `onCloseStart` event is fired before the slide-in menu is closed. Register an event listener with `IWEventManager.addListener(theSlideInMenu, 'onclosestart', yourHandlerMethod(event));` to receive the event.
`void`	`triggerOnOpenStart()` The `onOpenStart` event is fired before the slide-in menu is opened. Register an event listener with `IWEventManager.addListener(theSlideInMenu, 'onopenstart', yourHandlerMethod(event));` 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()

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

IWSlideInMenuControl

IWSlideInMenuControl(map, size, direction)

Creates a new slide-in menu.

Parameters:

IWMap map

IWSize size

IWAlignment direction

Method Detail

adjustBackground

void adjustBackground(size)

Adjusts the size of the Background if Panelsize has changed.

Parameters:

IWSize size

Returns:

void

close

void close()

Sets the menu to closed (without movement)

Returns:

void

collapse

void collapse()

Closes the menu smoothly

Returns:

void

expand

void expand()

Opens the menu smoothly

Returns:

void

getBackgroundColor

string getBackgroundColor()

Returns the background color.

Returns:

string

getLayoutManager

IWLayoutManager getLayoutManager()

Returns the LayoutManager for this menu.

Returns:

IWLayoutManager

getOpacity

float getOpacity()

Returns the opacity.

Returns:

float

getSize

IWSize getSize()

Returns the size of the menu.

Returns:

IWSize

isOpen

boolean isOpen()

true

false

Returns:

boolean

open

void open()

Sets the menu to opened (without movement)

Returns:

void

setBackgroundColor

void setBackgroundColor(color)

#FF0000

rgb(255,0,0)

red

Parameters:

string color

Returns:

void

setHorizontalScroll

void setHorizontalScroll(scroll)

IWPanelControl.setHorizontalScroll()

Parameters:

String scroll

Returns:

void

setOpacity

void setOpacity(alpha)

Sets the opacity.

Parameters:

float alpha

Returns:

void

setSize

setSize(size)

Sets the size of the slideInMenu.

Parameters:

IWSize size

setVerticalScroll

void setVerticalScroll(scroll)

IWPanelControl.setVerticalScroll()

Parameters:

String scroll

Returns:

void

toString

String toString()

Returns a string representation of this SlideInMenu.

Returns:

String

Event Detail

triggerOnCloseStart

void triggerOnCloseStart()

onCloseStart

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

Returns:

void

triggerOnOpenStart

void triggerOnOpenStart()

onOpenStart

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

Returns:

void

Class IWSlideInMenuControl

IWSlideInMenuControl

adjustBackground

close

collapse

expand

getBackgroundColor

getLayoutManager

getOpacity

getSize

isOpen

open

setBackgroundColor

setHorizontalScroll

setOpacity

setSize

setVerticalScroll

toString

triggerOnCloseStart

triggerOnOpenStart

Class `IWSlideInMenuControl`