ALS

Class: WidgetableWindow

.ALS. WidgetableWindow

new WidgetableWindow(button)

Customizable widgetable window. Creation of the window is a very slow process, so please, reuse existing windows as much as possible.

Some important properties:

  1. L.ALS.WidgetableWindow#windowContainer - container for the window which should be added to the page
  2. L.ALS.WidgetableWindow#window - actual window. It contains only one child: L.ALS.Widgetable's container (L.ALS.Widgetable#container property). You can add custom elements to the window at L.ALS.WidgetableWindow#initialize.
  3. L.ALS.WidgetableWindow#container - Widgetable's container.
Parameters:
Name Type Description
button Element | undefined

Button which will activate this window. Don't pass anything if you'll add this functionality later.

Extends

Members

<protected> buttonsGroup

Button group for this window

<protected> constructorArguments :Array.<any>

Contains arguments passed to this constructor

Type:
  • Array.<any>
Inherited From:

container :HTMLDivElement

Container to add widgets to. This element must be added to the page.

Type:
  • HTMLDivElement
Inherited From:

<protected> serializationIgnoreList :Array.<string>

Contains properties that won't be serialized. Append your properties at the constructor.

Type:
  • Array.<string>
Inherited From:

window :HTMLDivElement

Window which contains Widgetable's container

Type:
  • HTMLDivElement

windowContainer :HTMLDivElement

Container for the window which should be added to the page

Type:
  • HTMLDivElement

Methods

addCloseButton(id, text, icon, callbackObject, callback)

Adds close button to this window. You should add this button after you've added all your own buttons.

Parameters:
Name Type Description
id string

Button ID
text string

Button label
icon string

Button icon - a RemixIcon class.
callbackObject Object | L.ALS.Serializable

Just pass "this". If you plan to use serialization, this object MUST be instance of L.ALS.Serializable.
callback string

Name of a method of callbackObject that will be called when button will be pressed.
Returns:

Added button

Type
L.ALS.Widgets.Button

addWidget(widget)

Adds widget to this widgetable

Parameters:
Name Type Description
widget L.ALS.Widgets.BaseWidget

Widget to add
Inherited From:
Returns:

This

Type
L.ALS.Widgetable

addWidgets(widgets)

Adds all widgets to this widgetable

Parameters:
Name Type Description
widgets L.ALS.Widgets.BaseWidget

Widgets to add
Inherited From:
Returns:

This

Type
L.ALS.Widgetable

bindButton(button)

Binds a button that will open and close this window

Parameters:
Name Type Description
button HTMLElement

Button to bind

deserializeWidgets(serializedWidgets, seenObjects)

Deserializes widgets and adds them to this object. Removes all previously added widgets. Use this if you want to deserialize only widgets in your own Widgetable.

Parameters:
Name Type Description
serializedWidgets Object

Result of L.ALS.Widgetable#serializeWidgets
seenObjects Object

Already seen objects' ids. Intended only for internal use.
Inherited From:

getButtonsGroup()

Returns:

Buttons group to which you can add your own buttons

Type
L.ALS.Widgets.ButtonsGroup

getObjectToSerializeTo(newObject, seenObjects)

Registers this object for serialization and deserialization. Returns an object to serialize custom properties to.

Call it first, if you implement your own algrorithm, and serialize to the returned object!

Parameters:
Name Type Description
newObject Object

Object to where you'll serialize
seenObjects Object

Already seen objects
Inherited From:
Returns:

Object to serialize to.

Type
Object

getWidgetById(id)

Finds widget by ID

Parameters:
Name Type Description
id string

ID of a control to find
Inherited From:
Returns:

Widget with given ID.

Type
L.ALS.Widgets.BaseWidget

removeAllWidgets()

Removes all widgets from the container

Inherited From:
Returns:

This

Type
L.ALS.Widgetable

removeWidget(id)

Removes widget from the container

Parameters:
Name Type Description
id string

ID of a widget to remove
Inherited From:
Returns:

This

Type
L.ALS.Widgetable

serialize(seenObjects)

Serializes this object to JSON. If overridden, you MUST perform following operations before returning JSON:

let json = {} // Your JSON
... // Perform serialization
json.constructorArguments = this.serializeConstrutorArguments(); // Serialize constructor arguments
json.serializableClassName = this.serializableClassName; // Add class name to JSON
return json; // Finally return JSON
Parameters:
Name Type Description
seenObjects Object

Already seen objects
Inherited From:
Returns:

This serialized object

Type
Object

serializeConstructorArguments()

Serializes constructor arguments. If your constructor is not empty, result of this method MUST be added to json at L.ALS.Serializable#serialize as "_construtorArgs" property.

Deprecated in favor of L.ALS.Serializable#getObjectFromSerialized which uses this function under-the-hood.

Inherited From:
Deprecated:
  • Yes
Returns:

Serialized constructor arguments

Type
Array

serializeWidgets(seenObjects)

Serializes widgets.

If you're serializing L.ALS.Layer, you don't need to call this method, L.ALS.Layer#getObjectToSerializeTo already does that.

Parameters:
Name Type Description
seenObjects Object

Already seen objects' ids. Intended only for internal use.
Inherited From:
Returns:

Object where keys are widget's ids and values are serialized widgets themselves

Type
Object

setConstructorArguments(args)

Sets constructor arguments for serialization

Parameters:
Name Type Description
args

Arguments to set
Inherited From: