GuidingLayer

GuidingLayer

Component that controls the display of the guiding layer and its contents.

Constructor

new GuidingLayer()

Source:

Extends

Members

(protected) activeContentId_ :string|null

Description:

  • Active layer content id. All layer content dom elements (class layer-content) have to include the attribute data-content=id.

Source:
Overrides:

Active layer content id. All layer content dom elements (class layer-content) have to include the attribute data-content=id.

Type:
  • string | null

(protected) autoResetProvider_ :AutoResetProvider

Description:

  • Reference to AutoResetProvider to monitor and control the automatic reset of the page when the user is inactive for a specified period of time.

Source:
Overrides:

Reference to AutoResetProvider to monitor and control the automatic reset of the page when the user is inactive for a specified period of time.

Type:

(protected) closeButtons_ :NodeList

Description:

  • Dom element of the close button

Source:
Overrides:

Dom element of the close button

Type:
  • NodeList

(protected) contentSwitchers_ :NodeList

Description:

  • List of dom elements defined by the query selector button.layer-content-switcher.

Source:
Overrides:

List of dom elements defined by the query selector button.layer-content-switcher.

Type:
  • NodeList

(protected) content_ :Element

Description:

  • Active layer content element

Source:
Overrides:

Active layer content element

Type:
  • Element

(protected) contents_ :NodeList

Description:

  • List of all layer content elements

Source:
Overrides:

List of all layer content elements

Type:
  • NodeList

(protected) cursorProvider_ :CursorProvider

Description:

  • Reference to CursorProvider for monitoring and controlling the visibility of the custom mouse cursor object.

Source:
Overrides:

Reference to CursorProvider for monitoring and controlling the visibility of the custom mouse cursor object.

Type:

(protected) layerData_ :*

Description:
Source:
Overrides:

Data object which holds the values passed by the LayerEvent from the LayerProvider to this component.

Type:
  • *

(protected) layerModel_ :LayerModel

Description:
Source:
Overrides:

Layer model which is passed by the LayerEvent from the LayerProvider to this component.

Type:

(protected) layerProvider_ :LayerProvider

Description:

  • Reference to LayerProvider for monitoring and controlling layer appearance and disappearance.

Source:
Overrides:

Reference to LayerProvider for monitoring and controlling layer appearance and disappearance.

Type:

(protected) resizeProvider_ :ResizeProvider

Description:

  • Reference to ResizeProvider for monitoring device size changes

Source:
Overrides:

Reference to ResizeProvider for monitoring device size changes

Type:

(protected) type_ :string

Description:

  • Defines which type this layer component is. Use LayerType.

Source:
Overrides:

Defines which type this layer component is. Use LayerType.

Type:
  • string

Methods

(protected) activateContent_()

Description:

  • Activates all interactive elements in the active layer content.

Source:
Overrides:

(protected) activate_()

Description:

  • Activates all interactive elements in the layer. Enable all known buttons (defined by the query selector button.layer-content-switcher) that trigger a content switch.

Source:
Overrides:

(protected) checkLayerContentInitalisation_(event)

Description:

  • Checks whether a content change and thus an update of the content should take place when the layer is called up again.

Source:
Overrides:
Parameters:
Name Type Description
event LayerEvent

(protected) deactivateContent_()

Description:

  • Dectivates all interactive elements in the active layer content.

Source:
Overrides:

(protected) deactivate_()

Description:

  • Dectivates all interactive elements in the layer.

Source:
Overrides:

(protected) handleCloseClick_(event)

Description:

  • Handle layer close click

Source:
Overrides:
Parameters:
Name Type Description
event Event

(protected) handleContentSwitch_(event)

Source:
Overrides:
Parameters:
Name Type Description
event Event

(protected) handleHideLayer_(event)

Description:
Source:
Overrides:
Parameters:
Name Type Description
event LayerEvent

(protected) handleResize_()

Description:

  • Handle window resize

Source:
Overrides:

(protected) handleShowLayer_(event)

Description:

  • Hides and deactivates the layer by the LayerEvent SHOW_LAYER from the LayerProvider. Initializes dynamic content creation if the content does not already represent the desired content.

Source:
Overrides:
Parameters:
Name Type Description
event LayerEvent

(protected) handleUpdateLayer_(event)

Description:
Source:
Overrides:
Parameters:
Name Type Description
event LayerEvent

(protected) initContentElements_()

Description:

  • Builds/finds in the dom of the component the layer contents and selects/displays the active content.

Source:
Overrides:

(protected) initContent_(layer, dataopt) → {Promise}

Description:

  • Init a switch of the layer content by layer navigation elements.

Source:
Overrides:
Parameters:
Name Type Attributes Default Description
layer LayerModel
data * <optional>
 null
Returns:
Type
Promise

onInit()

Description:

  • Component is ready and had loaded all dependencies (inherit method waitFor and sub components). Init the main listeners for monitoring layer state and window size changes.

Source:
Overrides:

(protected) switchContent_(id)

Description:

  • Switches the display of the current layer content element. Id is assigned to a dom element width class layer-content and with the attribute data-content=id.

Source:
Overrides:
Parameters:
Name Type Description
id string