new OperationsWindow()
A loading window for long-running operations. Use L.ALS.OperationsWindow#addOperation
and L.ALS.OperationsWindow#removeOperation
to add and remove operation descriptions.
This window will be shown when the first item is added and closed when last item is removed.
This window doesn't provide any label like "List of running operations:", so make your descriptions verbose.
Don't use this class directly, use its instance at L.ALS.operationsWindow
!
Extends
Members
-
<protected> buttonsGroup
-
Button group for this window
- Inherited From:
-
<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
- Inherited From:
-
windowContainer :HTMLDivElement
-
Container for the window which should be added to the page
Type:
- HTMLDivElement
- Inherited From:
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.
- Inherited From:
Returns:
Added button
- Type
- L.ALS.Widgets.Button
-
addOperation(id, text)
-
Adds a new operation to this window
Parameters:
Name Type Description id
string ID of an operation. Pass it to
L.ALS.OperationsWindow#removeOperation
to remove this operation when it's complete.text
string An operation description. Pass locale property to localize it.
-
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
- Inherited From:
-
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()
-
- Inherited From:
Returns:
Buttons group to which you can add your own buttons
-
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.
-
removeAllWidgets()
-
Removes all widgets from the container
- Inherited From:
Returns:
This
- Type
- L.ALS.Widgetable
-
removeOperation(id)
-
Removes an operation with given ID.
Parameters:
Name Type Description id
string ID of an operation to remove
-
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: