Class CQ.WCM

<static> Clears the clipboard.

<static> Copies an item to the clipboard and marks it for deletion after pasting (if the clipboard is cleared before, the item will not be deleted). Shorthand for copy (with move parameter true implicitly).

<static> Shorthand for makeEditable.

<static> Returns the items in the clipboard as Records. This method does not remove cut items from the clipboard and should therefore only be used for viewing purposes. For actual processing of clipboard items, use paste.

<static> Returns a ComponentList object for the specified page. If path is null, the component list of the current page is returned.

<static> Returns the Content Finder (or null if none is available).

<static> Returns the window of the content page, independent of the presence of the Content Finder.

<static> Creates and/or returns a Dialog using the specified configuration (which may also be a URL serving one of the configurations below).

Single Panel:

"jcr:primaryType": "cq:Panel",
items: {
    "jcr:primaryType": "cq:WidgetCollection",
    field1: {
        fieldLabel: "Title",
        name: "./jcr:title",
    }
}

Add a title to create a TabPanel with a single Panel:

"jcr:primaryType": "cq:Panel",
title: "Tab 1"
items: {
    ...
}

An entire TabPanel:

"jcr:primaryType": "cq:TabPanel",
items: {
    "jcr:primaryType": "cq:WidgetCollection",
    tab1 : {
        "jcr:primaryType": "cq:Panel",
        title: "Tab 1",
        items: {
            "jcr:primaryType": "cq:WidgetCollection",
            field1: {
                ...
            }
        }
    }
    tab2: {
        ...
    }
}

An entire Dialog (e.g. with a Tab Panel):

"jcr:primaryType": "cq:Dialog",
items: {
    "jcr:primaryType": "cq:TabPanel",
    items: {
        "jcr:primaryType": "cq:WidgetCollection",
        tab1 : {
            "jcr:primaryType": "cq:Panel",
            title: "Tab 1",
            items: {
                ...
            }
        }
    }
}

The entire dialog config accepts all dialog specific config options:

"jcr:primaryType": "cq:Dialog",
okText: "Custom OK",
cancelText: "Custom Cancel",
buttons: CQ.Dialog.CANCEL,
params: {
    hiddenField1: "hiddenValue1",
    hiddenField2: "hiddenValue2"
}

<static> Returns all dialogs of the content page.

<static> Returns the edit component for the specified content path. Example:

var editBar = CQ.WCM.getEditable("/content/mysite/en/parsys/0001");

Edit components must be registered using makeEditable.

Finds the path of the next editable which "contains" the given element. This will return the path even if an editable is already registered using makeEditable but not yet fully built as ext component. In this case a following call to CQ.WCM.getEditable(foundPath) would return null, since the final editable has not been created yet.

<static> Returns the available languages as options. This method can be used directly as CQ.Selection.optionsProvider to draw a language selector.

<static> Returns either the current WCM mode: MODE_EDIT, MODE_PREVIEW and MODE_DESIGN, or MODE_TIMEWARP if the TIMEWARP_COOKIE is set.

<static> Returns a page object for the specified path.

Returns the content language of the page.

<static> Returns the path of the current page usually set by launchSidekick. If it is not set the path will be retrieved from the current window location.

<static> Returns the items in the selection for processing. This will not clear the selection, so this method can be called multiple times for processing the selected items.

<static> Returns the styles defined by the design of the component at the specified content path as options. This method can be used directly as CQ.Selection.optionsProvider to draw a style selector.

<static> Hides all edit components of the content page (i.e. switching to preview mode).

<static> Hides the placeholders for the specified element.

<static> Returns true if the specified window is the window displaying the content page, independent of the presence of the Content Finder. If no window is specified, the current window will be checked.

<static> Returns true if the current WCM mode equals MODE_DESIGN.

<static> Returns true if the current WCM mode equals MODE_PREVIEW.

<static> Returns true if the specified layer is currently shown.

<static> Returns true if the TIMEWARP_COOKIE is set.

<static> Loads the global editing toolbar with the specified CQ.Ext.Toolbar (or a toolbar config object}. This will override the default set of toolbar actions. Note that you must create the toolbar in the right context (for example: CQ.WCM.getTopWindow().CQ.Ext.Toolbar), if you specify a toolbar instead of a config object.

<static> Adds a listener to track clipboard changes.

<static> Adds a listener that is called as soon as the specified edit component is ready.

<static> Returns the items in the clipboard as an array for processing. For copied items, this method can be called multiple times, whereas cut items can only be processed once: those must be removed after the first paste (see remove).

Registers the specified Ext component that is neither part of a dialog, nor an editable, but should nevertheless work as a drop target.

If a component is used inside a CQ.Dialog, you must not use this method, as the component is automatically detected as a valid drop target.

Note that you should always explicitly unregister any component you previously registered.

<static> Adds an item to the selection.

<static> Sets the WCM preview mode. Supported preview modes are: PREVIEW_RESPONSIVE or NULL.

<static> Shows the specified layer.

Starts the queue mode for makeEditable: all subsequent calls to makeEditable will be queued. Only a call to endMakeEditablesQueue will create the editables.

Removes the specified listener from clipboard change listeners.

<static> Restores the default set of toolbar actions to the global editing toolbar.

Unregisters the specified component as an external drop target (= a drop target that is neither part of a dialog, nor an editable).

If the specified component has not been registered before, the call to this method is ignored silently.