This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%ZEN.Component.abstractDragGroupMgr

class %ZEN.Component.abstractDragGroupMgr extends %ZEN.Component.activeGroup

%ZEN.Component.abstractDragGroupMgr This is a parent class to house common functionality for all of the activeGroups that are expected to have instances of DragGroup as their only immediate children

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DEFAULTENCLOSINGCLASS = activeGroup;
To be compatible with the static layout manager the enclosing class has to be the generic activeGroup rather than the specific type of dragGroup manager such as desktopGroup. The desktopGroup (et al.) is the one used for tuning attributes of the absolutely positioned elements.
parameter INCLUDEFILES = zenCSLM.js;
Inherited description: CSV list of additional include files (either .js or .css) that should be included when this component is used on a page.
By default, the file extension (.js or .css) is used to determine whether an item in the list is a script include or a style include. You can override this behavior by adding the terms "script:" or "style:" to the beginning of the file name or names. This prefix is not used as part of the include filename.

Properties

property groupName as %ZEN.Datatype.string [ InitialExpression = "dragMgr" ];
The logical name of the manager with respect to the external JavaScript code that actually manages the space
Property methods: groupNameDisplayToLogical(), groupNameGet(), groupNameIsValid(), groupNameLogicalToDisplay(), groupNameLogicalToOdbc(), groupNameNormalize(), groupNameSet()

Methods

method %DrawHTML()
Inherited description: Static HTML display method: draw the BODY of this component as HTML.
Subclasses implement this in order to render the static HTML contents of a component.
clientmethod bringToFront(dragGroup) [ Language = javascript ]
Programmatically give the "focus" to the given drag group
clientmethod broadcast(signal, value) [ Language = javascript ]
Send one of several predefined signals to each of the active DragGroup windows associated with this group. Valid signals to pass include:

"resize" - call the onresize handler (if any) for each window
"disableCoverplate" - hide the event trapper coverplate from all windows "disableResize" - remove the resize pip from the lower right corners of the windows
"disableMaxToggle" - reset mouse clicks on the header to the default (drag) behavior
"enableCoverplate" - force an invisible event trapper to cover the window to prevent contents from seeing events
"enableMaxToggle" - redefine the window header to be a maximize button rather than a drag handle
"enableResize" - restore the resize pip to the lower right corners of the windows
"removeDragHeader" - completely hide the drag handle and resize the window to use the recovered space
"restoreDragHeader" - restore the drag handle and resize the window to account for the newly used space
"setBodyStyle" - given a JSON representation of a style object in value, add the given rules to the existing style of the drag body
"setHeaderStyle" - given a JSON representation of a style object in value, add the given rules to the existing style of the drag header
"setHeaderLayout" - set the headerLayout property of all children to the given value "processAppMessage" - simply pass the value given to the dragGroup children, subclasses of dragGroup can override the default processAppMessage() method to extend the broadcast facility to address application specific signals

clientmethod forceRefresh() [ Language = javascript ]
Force a refresh of the grid size based of the current geometries
clientmethod getGroupManager() [ Language = javascript ]
Find the client-side group manager engine for this projection
clientmethod getWallpaperDiv() [ Language = javascript ]
Return the HTML node used as the backdrop for the snapGrid.
clientmethod onloadHandler() [ Language = javascript ]
This forces the initial managerEngine pointer to null, subclasses should reinitialize this on page load.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Subclasses

Feedback