This documentation refers to the v0.3 released version of the Module Layout Handler code.
ModuleLayoutHandler is a Layout Handler - v0.3 used by the Layout Reorderer. It is designed to assist the Reorderer in working with arbitrary content modules, for example portlets in a portal environment.
A set of key/value pairs that describe the structural layout of the modules, as follows:
id: the string identifier of the container of the modules
columns: an array of key/value pairs describing the columns of the module layout, as follows:
id: the string identifier of the column element
children: an array of the string identifiers of the modules in the given column.
layout object may look like this:
The ModuleLayoutHandler (unlike the ListLayoutHandler - v0.3 and GridLayoutHandler - v0.3) works exclusively with the
targetPerms object, and does not query the actual DOM structure. For detailed information about the structure of the
layout object, see Layout Customizer - Layout and Permissions - v0.3
A two-dimensional array of binary flags describing the movement permissions of the modules.
For detailed information about the structure of the
targetPerms object, see Layout Customizer - Layout and Permissions - v0.3
An optional set of key/value pairs that configure the Layout Handler:
A function to be called each time the order of items has changed, to communicate the new order to the server. (see Order-Changed Callback - v0.3)
A function to be called each time the drop warning is shown. If nothing is provided, the drop warning will be displayed superimposed on the module being moved.