Interfaces

Classes

Component
Dialog
Layer
Overlay
Layer
Dialog
Layer
LayoutToolbar
Overlay
Toolbar
Editable
Inspectable
Layer
LayerManager
PageInfoHelper
PreviewLayer
Layer
Overlay
Toolbar
ScaffoldingLayer
AssetDragAndDrop
ComponentDragAndDrop
ContentTree
Dialog
EditableAction
EditableDragAndDrop
Overlay
StatusBar
Toolbar
ToolbarAction

Namespaces

Granite
author
components
ContentFrame
design
developer
DialogFrame
edit
EditableActions
ToolbarActions
editableHelper
editables
EditorFrame
overlayManager
OverlayWrapper
pageDesign
pageInfo
responsive
EditableActions
selection
ui
assetFinder
componentBrowser
coralCompatibility
dropController
emulator
globalBar
helpers
SidePanel
statusBarManager

Events


cq-asset-dragend

An asset has ended being dragged

Source:
ui/ui.assetFinder.AssetDragAndDrop.js

cq-asset-dragstart

An asset has started being dragged

Source:
ui/ui.assetFinder.AssetDragAndDrop.js

cq-asset-dropped

An asset has been dropped

Source:
ui/ui.assetFinder.AssetDragAndDrop.js

cq-components-filtered

All the allowed components corresponding to the current content have been filtered

Source:
storage/components.js

cq-components-loaded

Granite.author.components module is available after this event is sent

Source:
editor.js

cq-components-store-cleaned

The Granite.author.components store has bean cleaned

Source:
storage/components.js

cq-components-store-set

The Granite.author.components store has bean set

Source:
storage/components.js

cq-content-frame-loaded

The content frame has been loaded

Source:
ContentFrame.js

cq-content-frame-unload

The content frame unloads current content. Use this event to clean up any references to the iframe document to avoid possible memory leaks.

Source:
ContentFrame.js

cq-contentframe-datatype-set

A data type has been set on the content

Source:
ContentFrame.js

cq-contexthub-toggle

The contextHub bar visibility has been toggled

Source:
ui/ui.globalBar.js

cq-editable-added

Triggered when an Editable is added to the Granite.author.editables store

Type: object
Properties:
Name Type Description
editable Granite.author.Editable

The added item

Source:
storage/editables.js

cq-editables-loaded

editables module is available after this event

Source:
ContentFrame.js

cq-editables-update

Triggered when the given Granite.author.Editables must be updated

Type: object
Properties:
Name Type Argument Description
editables Array.<Granite.author.Editable>

The editables to be updated

children Array.<Array.<Granite.author.Editable>> <optional>

The two dimensional list of child editables to also be updated. One list of children for each provided editable.

Source:
storage/editables.js

cq-editables-updated

Triggered when the Granite.author.editables store is updated

Type: object
Properties:
Name Type Description
editable Granite.author.Editable

The added item

Source:
storage/editables.js

cq-editor-content-location-changed

Triggered when the content location change

Parameters:
Name Type Description
event Object

Event object containing the location of the content

Source:
EditorFrame.js

cq-editor-loaded

The different data stores:
Granite.author.pageInfo,
Granite.author.pageDesign,
Granite.author.components and
Granite.author.editables

and the different core modules:
Granite.author.ContentFrame,
Granite.author.EditorFrame,
Granite.author.ui.SidePanel,
etc.

are being initialized and ready to be used after this event is sent

Source:
editor.js

cq-editor-statusbar-loaded

The statuses of the current resource have been loaded.

Source:
ui/ui.StatusBar.js

cq-emulatorbar-toggle

The emulator bar visibility has been toggled

Source:
ui/ui.emulator.js

cq-hide-overlays

Hides all the Granite.author.ui.Overlays

Source:
overlayManager.js

cq-history-paragraph-id-changed

The id of a paragraph has changed

Source:
history/actions/history.actions.DeleteParagraph.js

cq-history-step-committed

An history step has been committed

Source:
history/history.Step.js

cq-history-step-completed

An history step has been completed

Source:
history/history.Step.js

cq-history-step-error

An history step has failed

Source:
history/history.Step.js

cq-inspectable-added

Triggered when an Inspectable/Editable is added to the Granite.author.editables store
Please use "cq-editable-added" instead

Type: object
Properties:
Name Type Description
inspectable Granite.author.Inspectable | Granite.author.Editable

The added item

Deprecated:
  • Yes
Source:
storage/editables.js

cq-interaction-blur

A blur interaction has been performed over an Granite.author.ui.Overlay

Source:
edit/edit.Interactions.js

cq-interaction-fastdblclick

A fast double click interaction has been performed over an Granite.author.ui.Overlay

Source:
edit/edit.Interactions.js

cq-interaction-focus

A focus interaction has been performed over an Granite.author.ui.Overlay

Source:
edit/edit.Interactions.js

cq-interaction-hover

An hover interaction has been performed over an Granite.author.ui.Overlay

Source:
edit/edit.Interactions.js

cq-interaction-slowdblclick

A slow double click interaction has been performed over an Granite.author.ui.Overlay

Source:
edit/edit.Interactions.js

cq-layer-activated

A layer has been activated

Type: object
Properties:
Name Type Description
layer string

Name of the layer activated

prevLayer string

Name of the previous layer

Source:
layers/LayerManager.js

cq-overlay-click

A click action has been performed over an Granite.author.ui.Overlay

Source:
overlayManager.js

cq-overlay-fast-dblclick

A fast double clicked has been performed over an Granite.author.ui.Overlay

Source:
overlayManager.js

cq-overlay-hold

A taphold action has been performed over an Granite.author.ui.Overlay

Source:
overlayManager.js

cq-overlay-hover

An hover action has been performed over an Granite.author.ui.Overlay

Source:
overlayManager.js

cq-overlay-outside-click

An outside click action has been performed over an Granite.author.ui.Overlay

Source:
overlayManager.js

cq-overlay-slow-dblclick

A slow double clicked has been performed over an Granite.author.ui.Overlay

Source:
overlayManager.js

cq-overlays-create

Create overlays based on the given list of Granite.author.Editables

Type: object
Properties:
Name Type Description
editables Array.<Granite.author.Editable>

Editables from which to create overlays

Source:
overlayManager.js

cq-overlays-repositioned

The overlays have been repositioned

Source:
overlayManager.js

cq-page-design-loaded

Granite.author.pageDesign module is available after this event is sent

Source:
editor.js

cq-page-info-loaded

Granite.author.pageInfo module is available after this event is sent

Source:
editor.js

cq-persistence-after-copy

An Granite.author.Editable has been copied

Source:
persistence/persistence.js

cq-persistence-after-create

An Granite.author.Editable has been created

Source:
persistence/persistence.js

cq-persistence-after-delete

An Granite.author.Editable has been deleted

Source:
persistence/persistence.js

cq-persistence-after-move

An Granite.author.Editable has been moved

Source:
persistence/persistence.js

cq-persistence-after-update

An Granite.author.Editable has been updated

Source:
persistence/persistence.js

cq-persistence-before-copy

An Granite.author.Editable is about to be copied

Source:
persistence/persistence.js

cq-persistence-before-create

An Granite.author.Editable is about to be created

Source:
persistence/persistence.js

cq-persistence-before-delete

An Granite.author.Editable is about to be deleted

Source:
persistence/persistence.js

cq-persistence-before-move

An Granite.author.Editable is about to be moved

Source:
persistence/persistence.js

cq-persistence-before-update

An Granite.author.Editable is about to be updated

Source:
persistence/persistence.js

cq-show-overlays

Shows all the Granite.author.ui.Overlays

Source:
overlayManager.js

cq-sidepanel-aftertoggle

The side panel has been toggled

Source:
ui/ui.SidePanel.js

cq-sidepanel-beforetoggle

The side panel is about to be toggled

Source:
ui/ui.SidePanel.js

cq-sidepanel-resized

The side panel has been resized

Source:
ui/ui.SidePanel.js

cq-sidepanel-tab-switched

Tab has been switched on the side panel

Source:
ui/ui.SidePanel.js

editor-frame-mode-changed

WCM mode has changed

Source:
edit/edit.Layer.js

inline-edit-start

The inline edition has started

Source:
editableHelper.js