org.opencms.ade.containerpage.client.CmsContainerpageDNDController Maven / Gradle / Ivy
Show all versions of opencms-gwt Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.ade.containerpage.client;
import org.opencms.ade.containerpage.client.ui.CmsContainerPageContainer;
import org.opencms.ade.containerpage.client.ui.CmsContainerPageElementPanel;
import org.opencms.ade.containerpage.client.ui.CmsDroppedElementModeSelectionDialog;
import org.opencms.ade.containerpage.client.ui.CmsElementOptionBar;
import org.opencms.ade.containerpage.client.ui.CmsGroupContainerElementPanel;
import org.opencms.ade.containerpage.client.ui.CmsToolbarAllGalleriesMenu;
import org.opencms.ade.containerpage.client.ui.I_CmsDropContainer;
import org.opencms.ade.containerpage.client.ui.css.I_CmsLayoutBundle;
import org.opencms.ade.containerpage.shared.CmsCntPageData.ElementReuseMode;
import org.opencms.ade.containerpage.shared.CmsContainer;
import org.opencms.ade.containerpage.shared.CmsContainerElement;
import org.opencms.ade.containerpage.shared.CmsContainerElementData;
import org.opencms.ade.contenteditor.client.Messages;
import org.opencms.ade.contenteditor.shared.CmsEditorConstants;
import org.opencms.ade.galleries.client.ui.CmsResultListItem;
import org.opencms.gwt.client.CmsCoreProvider;
import org.opencms.gwt.client.dnd.CmsDNDHandler;
import org.opencms.gwt.client.dnd.CmsDNDHandler.Orientation;
import org.opencms.gwt.client.dnd.I_CmsDNDController;
import org.opencms.gwt.client.dnd.I_CmsDraggable;
import org.opencms.gwt.client.dnd.I_CmsDropTarget;
import org.opencms.gwt.client.ui.CmsErrorDialog;
import org.opencms.gwt.client.ui.CmsHighlightingBorder;
import org.opencms.gwt.client.ui.CmsList;
import org.opencms.gwt.client.ui.CmsListItem;
import org.opencms.gwt.client.ui.CmsListItemWidget;
import org.opencms.gwt.client.ui.CmsPushButton;
import org.opencms.gwt.client.ui.CmsToolbar;
import org.opencms.gwt.client.ui.I_CmsButton;
import org.opencms.gwt.client.ui.I_CmsButton.ButtonStyle;
import org.opencms.gwt.client.ui.I_CmsButton.Size;
import org.opencms.gwt.client.util.CmsDebugLog;
import org.opencms.gwt.client.util.CmsDomUtil;
import org.opencms.gwt.client.util.CmsPositionBean;
import org.opencms.gwt.client.util.I_CmsSimpleCallback;
import org.opencms.gwt.shared.CmsGwtLog;
import org.opencms.gwt.shared.CmsListInfoBean;
import org.opencms.gwt.shared.CmsTemplateContextInfo;
import org.opencms.util.CmsStringUtil;
import org.opencms.util.CmsUUID;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import com.google.common.base.Objects;
import com.google.common.collect.ComparisonChain;
import com.google.gwt.core.client.Scheduler;
import com.google.gwt.core.client.Scheduler.ScheduledCommand;
import com.google.gwt.dom.client.Document;
import com.google.gwt.dom.client.Element;
import com.google.gwt.dom.client.Style;
import com.google.gwt.dom.client.Style.Display;
import com.google.gwt.dom.client.Style.Position;
import com.google.gwt.dom.client.Style.Unit;
import com.google.gwt.dom.client.Style.Visibility;
import com.google.gwt.event.dom.client.ClickEvent;
import com.google.gwt.event.dom.client.ClickHandler;
import com.google.gwt.event.dom.client.HasClickHandlers;
import com.google.gwt.event.dom.client.HasMouseOutHandlers;
import com.google.gwt.event.dom.client.HasMouseOverHandlers;
import com.google.gwt.event.dom.client.KeyCodes;
import com.google.gwt.event.dom.client.MouseOutEvent;
import com.google.gwt.event.dom.client.MouseOutHandler;
import com.google.gwt.event.dom.client.MouseOverEvent;
import com.google.gwt.event.dom.client.MouseOverHandler;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.user.client.DOM;
import com.google.gwt.user.client.Event;
import com.google.gwt.user.client.Window;
import com.google.gwt.user.client.rpc.AsyncCallback;
import com.google.gwt.user.client.ui.FlowPanel;
import com.google.gwt.user.client.ui.RootPanel;
import com.google.gwt.user.client.ui.Widget;
import elemental2.dom.DOMRect;
import elemental2.dom.DomGlobal;
import elemental2.dom.HTMLDivElement;
import elemental2.dom.Node;
import elemental2.dom.NodeList;
import jsinterop.base.Any;
import jsinterop.base.Js;
import jsinterop.base.JsPropertyMap;
/**
* The container-page editor drag and drop controller.
*
* @since 8.0.0
*/
public class CmsContainerpageDNDController implements I_CmsDNDController {
/**
* The Class CmsPlacementModeContext.
*/
class CmsPlacementModeContext {
/**
* Buttons used to place elements in placement mode.
*/
class PlacementButton extends FlowPanel implements HasClickHandlers, HasMouseOverHandlers, HasMouseOutHandlers {
/** The associated container. */
private CmsContainerPageContainer m_container;
/** The height. */
private int m_height;
/** The internal index (used for sorting). */
private int m_index;
/** The left. */
private int m_left;
/** Thetop. */
private int m_top;
/** The width. */
private int m_width;
/**
* Creates a new instance.
*
* @param size the size
*/
public PlacementButton(int size) {
addStyleName(OC_PLACEMENT_BUTTON);
String alpha = "abcdefghijklmnopqrstuvwxyz";
String id = "pb_";
for (int i = 0; i < 5; i++) {
int index = (int)Math.floor(Math.random() * alpha.length());
id = id + alpha.charAt(index);
}
getElement().setId(id);
m_width = size;
m_height = size;
m_index = m_buttonCounter++;
}
/**
* @see com.google.gwt.event.dom.client.HasClickHandlers#addClickHandler(com.google.gwt.event.dom.client.ClickHandler)
*/
@Override
public HandlerRegistration addClickHandler(ClickHandler handler) {
ClickHandler handler2 = event -> {
event.stopPropagation();
handler.onClick(event);
};
return addDomHandler(handler2, ClickEvent.getType());
}
/**
* @see com.google.gwt.event.dom.client.HasMouseOutHandlers#addMouseOutHandler(com.google.gwt.event.dom.client.MouseOutHandler)
*/
@Override
public HandlerRegistration addMouseOutHandler(MouseOutHandler handler) {
return addDomHandler(handler, MouseOutEvent.getType());
}
/**
* @see com.google.gwt.event.dom.client.HasMouseOverHandlers#addMouseOverHandler(com.google.gwt.event.dom.client.MouseOverHandler)
*/
@Override
public HandlerRegistration addMouseOverHandler(MouseOverHandler handler) {
return addDomHandler(handler, MouseOverEvent.getType());
}
/**
* Gets the associated container.
*
* @return the associated container
*/
public CmsContainerPageContainer getContainer() {
return m_container;
}
/**
* Gets the height.
*
* @return the height
*/
public int getHeight() {
return m_height;
}
/**
* Gets the index.
*
* @return the index
*/
public int getIndex() {
return m_index;
}
/**
* Gets the left.
*
* @return the left
*/
public int getLeft() {
return m_left;
}
/**
* Gets the top.
*
* @return the top
*/
public int getTop() {
return m_top;
}
/**
* Gets the width.
*
* @return the width
*/
public int getWidth() {
return m_width;
}
/**
* Checks if other placement button's position intersects this one's.
*
* @param other the other placement button
* @return true if the buttons intersect
*/
public boolean intersects(PlacementButton other) {
int t = m_collisionTolerance;
return segmentIntersect(m_left + t, m_width - (2 * t), other.m_left + t, other.m_width - (2 * t))
&& segmentIntersect(m_top + t, m_height - (2 * t), other.m_top + t, other.m_height - (2 * t));
}
/**
* Checks if this button is fully before another (taking into account the tolerance zones of both).
*
* @param second the other button
* @return true if this button (except tolerance zones) is fully before the other button (except for its tolerance zones)
*
*/
public boolean isFullyBefore(PlacementButton second) {
return ((getLeft() + getWidth()) - m_collisionTolerance) <= (second.getLeft() + m_collisionTolerance);
}
/**
* Moves this button to the right of another button.
*
* @param second the other button
*/
public void moveToRightOf(PlacementButton second) {
m_left = (second.getLeft() + second.getWidth()) - (2 * m_collisionTolerance);
}
/**
* Sets the container.
*
* @param container the new container
*/
public void setContainer(CmsContainerPageContainer container) {
m_container = container;
}
/**
* Sets the left.
*
* @param left the new left
*/
public void setLeft(int left) {
m_left = left;
}
/**
* Actually sets the position on the DOM element.
*/
public void setPosition() {
getElement().getStyle().setLeft(m_left, Unit.PX);
getElement().getStyle().setTop(m_top, Unit.PX);
}
/**
* Sets the top.
*
* @param top the new top
*/
public void setTop(int top) {
m_top = top;
}
/**
* @see com.google.gwt.user.client.ui.UIObject#toString()
*/
public String toString() {
return getElement().getId() + ":(" + getLeft() + ", " + getTop() + ")";
}
}
/** Single-element array holding the currently visible highlighting element. */
private CmsHighlightingBorder m_activeBorder;
/** The list of active buttons. */
private List m_buttons = new ArrayList<>();
/** The placemenet button size (width or height). */
private int m_buttonSize;
/** The callback to call when an element is placed. */
private I_PlacementCallback m_callback;
/** The tolerance for button collisions. */
private int m_collisionTolerance;
/** Numeric rank for containers, used for resolving button collisions. */
private Map m_containerIndexes = new HashMap<>();
/** The set of available container names. */
private Set m_containers;
/** The DND handler. */
private CmsDNDHandler m_dndHandler;
/** The current draggable. */
private I_CmsDraggable m_draggable;
/** The special layer used to display placement buttons and block click events for the rest of the page. */
private PlacementLayer m_layer;
/** The container page handler. */
private CmsContainerpageHandler m_pageHandler;
/** The placement mode toolbar. */
private CmsToolbar m_toolbar;
/** A widget to display in the toolbar. */
private Widget m_toolbarWidget;
/**
* Creates a new placement mode context.
*
* @param containers the set of ids of available containers
* @param toolbarWidget the additional widget to display in the toolbar
* @param dndHandler the drag/drop handler
* @param draggable the current draggable
* @param callback the callback to call when placing an element
*/
public CmsPlacementModeContext(
Set containers,
Widget toolbarWidget,
CmsDNDHandler dndHandler,
I_CmsDraggable draggable,
I_PlacementCallback callback) {
m_containers = containers;
m_callback = callback;
m_pageHandler = m_controller.getHandler();
m_dndHandler = dndHandler;
m_toolbarWidget = toolbarWidget;
m_draggable = draggable;
m_collisionTolerance = getTolerance();
}
/**
* Cleans up everything related to the placement mode.
*/
public void destroy() {
if (m_layer != null) {
m_layer.removeFromParent();
}
NodeList placeholders = DomGlobal.document.querySelectorAll(
"." + OC_PLACEMENT_PLACEHOLDER);
for (int i = 0; i < placeholders.length; i++) {
elemental2.dom.Element placeholder = placeholders.getAt(i);
placeholder.remove();
}
NodeList selectedContainerElements = DomGlobal.document.querySelectorAll(
"." + OC_PLACEMENT_SELECTED_ELEMENT);
for (int i = 0; i < selectedContainerElements.length; i++) {
selectedContainerElements.getAt(i).classList.remove(OC_PLACEMENT_SELECTED_ELEMENT);
}
RootPanel.get().removeStyleName(OC_PLACEMENT_MODE);
m_pageHandler.setEditButtonsVisible(true);
m_controller.getHandler().enableToolbarButtons();
m_toolbar.removeFromParent();
Map containerMap = m_controller.getContainerTargets();
for (CmsContainerPageContainer container : containerMap.values()) {
container.checkEmptyContainers();
}
m_controller.setPreviewHandler(null);
}
/**
* Initializes the placement mode.
*/
public void init() {
m_controller.hideEditableListButtons();
m_controller.getHandler().disableToolbarButtons();
m_controller.getHandler().hideMenu();
initToolbar();
m_pageHandler.setEditButtonsVisible(false);
RootPanel.get().addStyleName(OC_PLACEMENT_MODE);
if (CmsCoreProvider.TOUCH_ONLY.matches()) {
m_buttonSize = PLACEMENT_BUTTON_BIG;
} else {
m_buttonSize = PLACEMENT_BUTTON_SMALL;
}
initPlacementLayer();
m_controller.setPreviewHandler(event -> {
Event nativeEvent = Event.as(event.getNativeEvent());
if (event.getTypeInt() == Event.ONKEYDOWN) {
int keyCode = nativeEvent.getKeyCode();
if ((keyCode == KeyCodes.KEY_CTRL)
|| (keyCode == KeyCodes.KEY_SHIFT)
|| (keyCode == KeyCodes.KEY_ALT)) {
// In a VM, when the user presses Ctrl+E, the keydown event for the Ctrl event may or may not wait to be fired until the E key is pressed, depending on the settings.
// To get consistent behavior, we ignore keydown events with keycodes that are just modifier keys.
return;
} else {
stopDrag(m_dndHandler);
}
} else if ((event.getTypeInt() == Event.ONMOUSEOVER)
|| (event.getTypeInt() == Event.ONMOUSEDOWN)
|| (event.getTypeInt() == Event.ONCLICK)
|| (event.getTypeInt() == Event.ONMOUSEUP)) {
// ignore likely mouse events on floating headers etc.
try {
boolean isChildOfLayer = (m_layer != null)
&& m_layer.getElement().isOrHasChild(Element.as(event.getNativeEvent().getEventTarget()));
boolean isChildOfToolbar = (m_toolbar != null)
&& m_toolbar.getElement().isOrHasChild(Element.as(event.getNativeEvent().getEventTarget()));
if (!isChildOfLayer && !isChildOfToolbar) {
event.cancel();
event.getNativeEvent().preventDefault();
event.getNativeEvent().stopPropagation();
}
} catch (Exception e) {
}
}
});
}
/**
* Adds a new placement button.
*
* @param container the container
* @return the placement button
*/
private PlacementButton addButton(CmsContainerPageContainer container) {
PlacementButton button = new PlacementButton(m_buttonSize);
m_buttons.add(button);
m_layer.add(button);
button.setContainer(container);
addHighlightingMouseHandlers(container, button);
return button;
}
/**
* Adds mouse handlers for showing/hiding container borders when hovering over placement buttons.
*
* @param container the container to which the button belongs
* @param button the button
*/
private void addHighlightingMouseHandlers(CmsContainerPageContainer container, PlacementButton button) {
button.addMouseOverHandler(event -> {
if (m_activeBorder != null) {
m_activeBorder.getElement().getStyle().setVisibility(Visibility.HIDDEN);
}
m_activeBorder = container.getHighlighting();
m_activeBorder.getElement().getStyle().setVisibility(Visibility.VISIBLE);
});
button.addMouseOutHandler(event -> {
if (m_activeBorder != null) {
m_activeBorder.getElement().getStyle().setVisibility(Visibility.HIDDEN);
m_activeBorder = null;
}
container.getHighlighting().getElement().getStyle().setVisibility(Visibility.HIDDEN);
});
}
/**
* Creates a push button for the edit tool-bar.
*
* @param title the button title
* @param imageClass the image class
*
* @return the button
*/
private CmsPushButton createButton(String title, String imageClass) {
CmsPushButton result = new CmsPushButton();
result.setTitle(title);
result.setImageClass(imageClass);
result.setButtonStyle(ButtonStyle.FONT_ICON, null);
result.setSize(Size.big);
return result;
}
/**
* Gets the drag-and-drop handler.
*
* @return the drag and drop handler
*/
private CmsDNDHandler getDNDHandler() {
return m_dndHandler;
}
/**
* Gets the placement button size (Width or height).
*
* @return the placement button size
*/
private int getPlacementButtonSize() {
return m_buttonSize;
}
/**
* Gets the width of the 'tolerance zone' in pixels around the sides of the placement button which does not count for collision detection.
*
* @return the width of the tolerance zone
*/
private int getTolerance() {
if (CmsCoreProvider.TOUCH_ONLY.matches()) {
return 0;
}
JsPropertyMap window = Js.cast(DomGlobal.window);
Any tolerance = window.getAsAny("ocPlacementButtonTolerance");
if (tolerance != null) {
return tolerance.asInt();
} else {
return 1;
}
}
/**
* Does all placement mode initializations related to the button layer.
*/
private void initPlacementLayer() {
if (m_layer != null) {
m_layer.removeFromParent();
}
m_layer = new PlacementLayer();
m_layer.addStyleName(OC_PLACEMENT_LAYER);
RootPanel.get().add(m_layer);
m_layer.addClickHandler(event -> {
stopDrag(m_dndHandler);
});
Map containerMap = m_controller.getContainerTargets();
List usedContainers = new ArrayList<>();
for (CmsContainerPageContainer container : containerMap.values()) {
if (m_containers.contains(container.getContainerId())) {
if (container.getElement().getOffsetParent() == null) {
// offsetParent == null means element or its ancestor has display: none
continue;
}
if (container.isDetailView()) {
continue;
}
usedContainers.add(container);
}
}
// Sort containers in DOM pre-order. That means parents come before their children.
// The indexes of that list are used later for adjusting positions of colliding buttons.
usedContainers.sort(new Comparator() {
@Override
public int compare(CmsContainerPageContainer o1, CmsContainerPageContainer o2) {
if (o1 == o2) {
return 0;
}
elemental2.dom.Element e1 = Js.cast(o1.getElement());
elemental2.dom.Element e2 = Js.cast(o2.getElement());
int cmpResult = e1.compareDocumentPosition(e2);
if ((cmpResult & Node.DOCUMENT_POSITION_PRECEDING) != 0) {
return 1;
} else {
return -1;
}
}
});
int containerIndex = 0;
for (CmsContainerPageContainer container : usedContainers) {
m_containerIndexes.put(container.getContainerId(), Integer.valueOf(containerIndex));
containerIndex += 1;
}
for (CmsContainerPageContainer container : usedContainers) {
List offsets = null;
if (container.getHighlighting() != null) {
offsets = container.getHighlighting().getClientVerticalOffsets();
}
List elements = container.getAllDragElements();
if (elements.size() == 0) {
installPlacementElement(container);
} else {
if ((offsets == null) || (offsets.size() != (elements.size() + 1))) {
for (int i = 0; i < elements.size(); i++) {
if (!isMovedElement(elements.get(i))) {
installButtons(container, i, elements.get(i));
}
}
} else {
installPlacementButtonsWithMidpoints(container, offsets);
}
}
}
positionButtons(m_buttons);
}
/**
* Generates the button bar displayed beneath the editable fields.
*/
private void initToolbar() {
m_toolbar = new CmsToolbar();
m_toolbar.setAppTitle(
org.opencms.ade.containerpage.client.Messages.get().key(
org.opencms.ade.containerpage.client.Messages.GUI_TOOLBAR_PLACE_ELEMENT_0));
m_toolbar.getToolbarCenter().clear();
m_toolbar.getToolbarCenter().add(m_toolbarWidget);
CmsPushButton cancelButton = createButton(
Messages.get().key(Messages.GUI_TOOLBAR_RESET_0),
I_CmsButton.ButtonData.RESET_BUTTON.getIconClass());
cancelButton.addClickHandler(new ClickHandler() {
public void onClick(ClickEvent event) {
stopDrag(m_dndHandler);
}
});
m_toolbar.addRight(cancelButton);
m_toolbar.addStyleName(
org.opencms.gwt.client.ui.css.I_CmsLayoutBundle.INSTANCE.toolbarCss().toolbarPlacementMode());
RootPanel.get().add(m_toolbar);
}
/**
* Installs the placement buttons for a container element in the button layer.
*
* @param container the container
* @param position the position
* @param element the container element
*/
private void installButtons(
CmsContainerPageContainer container,
int position,
CmsContainerPageElementPanel element) {
int bw = getPlacementButtonSize();
container.getHighlighting().getElement().getStyle().setVisibility(Visibility.HIDDEN);
elemental2.dom.Element elem = Js.cast(element.getElement());
elemental2.dom.Element layerElem = Js.cast(m_layer.getElement());
DOMRect layerRect = layerElem.getBoundingClientRect();
DOMRect elemRect = elem.getBoundingClientRect();
if ((elemRect.width == 0) || (elemRect.height == 0)) {
return;
}
PlacementButton before = addButton(container);
PlacementButton after = addButton(container);
before.addClickHandler(e -> m_callback.place(container, element, 0));
after.addClickHandler(e -> m_callback.place(container, element, 1));
before.addStyleName(OC_PLACEMENT_BUTTON);
after.addStyleName(OC_PLACEMENT_BUTTON);
boolean leftRight = !CmsDomUtil.hasClass(OC_PLACEMENT_BUTTONS_VERTICAL, container.getElement());
if (leftRight) {
before.addStyleName(OC_PLACEMENT_LEFT);
after.addStyleName(OC_PLACEMENT_RIGHT);
double top = ((elemRect.top - layerRect.top) + (elemRect.height / 2.0)) - (bw / 2.0);
double left = elemRect.left - layerRect.left;
before.setLeft((int)left);
before.setTop((int)top);
after.setLeft((int)Math.round((left + elemRect.width) - m_buttonSize));
after.setTop((int)top);
} else {
before.addStyleName(OC_PLACEMENT_UP);
after.addStyleName(OC_PLACEMENT_DOWN);
int top = (int)Math.round(elemRect.top - layerRect.top);
int left = (int)Math.round(((elemRect.left - layerRect.left) + (0.5 * elemRect.width)) - (0.5 * bw));
before.setLeft(left);
before.setTop(top);
after.setLeft(left);
after.setTop((int)Math.round(((top + elemRect.height) - bw)));
}
}
/**
* Installs placement buttons aligned with the highlighting separators between container elements (except for the first and last button).
*
* @param container the container for which to install the buttons
* @param offsets the offsets relative to the viewport of the midpoints
*/
private void installPlacementButtonsWithMidpoints(CmsContainerPageContainer container, List offsets) {
int bw = getPlacementButtonSize();
List elements = container.getAllDragElements();
elemental2.dom.Element layerElem = Js.cast(m_layer.getElement());
DOMRect layerRect = layerElem.getBoundingClientRect();
container.getHighlighting().getElement().getStyle().setVisibility(Visibility.HIDDEN);
elemental2.dom.Element containerElem = Js.cast(container.getElement());
DOMRect containerRect = containerElem.getBoundingClientRect();
double middle = (containerRect.left - layerRect.left) + (0.5 * containerRect.width);
for (int j = 0; j < offsets.size(); j++) {
if (j == 0) {
CmsContainerPageElementPanel element = elements.get(0);
if (!isMovedElement(element)) {
PlacementButton button = addButton(container);
elemental2.dom.Element realElement = Js.cast(element.getElement());
button.addClickHandler(e -> m_callback.place(container, element, 0));
button.addStyleName(OC_PLACEMENT_UP);
DOMRect elemRect = realElement.getBoundingClientRect();
int top = (int)Math.round(elemRect.top - layerRect.top);
int left = (int)Math.round(middle - (0.5 * bw));
button.setLeft(left);
button.setTop(top);
}
} else if (j == (offsets.size() - 1)) {
CmsContainerPageElementPanel element = elements.get(elements.size() - 1);
if (!isMovedElement(element)) {
PlacementButton button = addButton(container);
elemental2.dom.Element realElement = Js.cast(element.getElement());
button.addClickHandler(e -> m_callback.place(container, element, 1));
button.addStyleName(OC_PLACEMENT_DOWN);
DOMRect elemRect = realElement.getBoundingClientRect();
int top = (int)Math.round((elemRect.top + elemRect.height) - layerRect.top - bw);
int left = (int)Math.round(middle - (0.5 * bw));
button.setLeft(left);
button.setTop(top);
}
} else {
CmsContainerPageElementPanel element = elements.get(j);
CmsContainerPageElementPanel previousElement = elements.get(j - 1);
if (!isMovedElement(element) && !isMovedElement(previousElement)) {
PlacementButton button = addButton(container);
button.addClickHandler(e -> m_callback.place(container, element, 0));
button.addStyleName(OC_PLACEMENT_MIDDLE);
int top = (int)Math.round(offsets.get(j) - layerRect.top - (0.5 * bw));
int left = (int)Math.round(middle - (0.5 * bw));
button.setLeft(left);
button.setTop(top);
}
}
}
}
/**
* Installs the placement button for an empty container in the button layer.
*
* @param container the container
*/
private void installPlacementElement(CmsContainerPageContainer container) {
int bw = getPlacementButtonSize();
HTMLDivElement placeholder = Js.cast(DomGlobal.document.createElement("div"));
placeholder.classList.add(OC_PLACEMENT_PLACEHOLDER);
elemental2.dom.Element layerElem = Js.cast(m_layer.getElement());
elemental2.dom.Element containerElem = Js.cast(container.getElement());
container.getHighlighting().getElement().getStyle().setVisibility(Visibility.HIDDEN);
DOMRect containerRect = containerElem.getBoundingClientRect();
if (containerRect.height < 50.0) {
containerElem.appendChild(placeholder);
}
DOMRect layerRect = layerElem.getBoundingClientRect();
PlacementButton plus = addButton(container);
plus.addStyleName(OC_PLACEMENT_MIDDLE);
int top = (int)Math.round(
((containerRect.top - layerRect.top) + (0.5 * containerRect.height)) - (0.5 * bw));
int left = (int)Math.round(
((containerRect.left - layerRect.left) + (0.5 * containerRect.width)) - (0.5 * bw));
plus.setLeft(left);
plus.setTop(top);
plus.addClickHandler(e -> m_callback.place(container, null, 0));
}
/**
* Checks if a container element is the container element for which placement mode was initially started.
*
* @param element a container element
* @return true if the given element is the element for which placement mode was started
*/
private boolean isMovedElement(CmsContainerPageElementPanel element) {
return element == m_draggable;
}
/**
* Positions buttons so that they don't collide.
*
* @param originalButtons the list of buttons to position
*/
private void positionButtons(List originalButtons) {
// First split buttons into vertically separated groups. Since we only move things around horizontally, we can do it independently for each of these groups, reducing the total amount of collision tests.
originalButtons.sort((a, b) -> Integer.compare(a.getTop(), b.getTop()));
List> groups = new ArrayList<>();
groups.add(new ArrayList<>());
PlacementButton lastButton = null;
for (PlacementButton button : originalButtons) {
// ignoring collision tolerance here, because the point of collision tolerance is mostly controlling horizontal separation
if ((lastButton != null) && ((lastButton.getTop() + lastButton.getHeight()) <= button.getTop())) { // because all buttons have the same height, we only need to check the last one
groups.add(new ArrayList<>());
}
groups.get(groups.size() - 1).add(button);
lastButton = button;
}
for (List group : groups) {
int iterations = 0;
while ((group.size() > 1) && (iterations < 1000)) {
// In each iteration of the main loop, try to find and resolve one collision. Resolving one collision may cause further collisions in later iterations of the loop.
iterations += 1;
// Sort buttons by increasing x coordinate of left corner, so we can limit the potential candidates for collisions with a given button.
group.sort((a, b) -> {
return Integer.compare(a.getLeft(), b.getLeft());
});
int collisionIndex = -1;
PlacementButton[] collisionPair = null;
for (int i = 0; i < group.size(); i++) {
collisionPair = null;
PlacementButton first = group.get(i);
int j = i + 1;
for (j = i + 1; j < group.size(); j++) {
PlacementButton second = group.get(j);
if (first.isFullyBefore(second)) {
break;
}
if (first.intersects(second)) {
collisionPair = new PlacementButton[] {first, second};
collisionIndex = i;
break;
}
}
if (collisionPair != null) {
break;
}
}
if (collisionIndex != -1) {
PlacementButton first = collisionPair[0];
PlacementButton second = collisionPair[1];
int ci1 = m_containerIndexes.get(first.getContainer().getContainerId()).intValue();
int ci2 = m_containerIndexes.get(second.getContainer().getContainerId()).intValue();
/*
* By using the combination of document position of the container and button index of the button, we impose a complete total ordering on the buttons
* so that buttons which are lower in the ordering are moved when they collide with buttons that are higher in the ordering. This means that for a button
* involved in any collisions, if it has the highest position in that ordering, all other buttons involved in collisions with it will move to its right, and
* after that, will never collide with it again. The same reasoning can be applied to the element with next-highest position now to its right, and so on.
* This means we can't run into 'infinite loops' where groups of elements keep pushing each other to the right ad infinitum.
*/
if (ComparisonChain.start().compare(ci1, ci2).compare(
second.getIndex(), /* Use reverse order for index - prefer moving 'insert after' buttons rather than 'insert before' for a single container if they collide */
first.getIndex()).result() == -1) {
first.moveToRightOf(second);
} else {
second.moveToRightOf(first);
}
// everything before first collision becomes irrelevant for the next iteration; we only move stuff to the right
group = new ArrayList<>(group.subList(collisionIndex, group.size()));
} else {
// no collisions; we're done
group = new ArrayList<>();
}
}
}
for (PlacementButton button : originalButtons) {
button.setPosition();
}
}
}
/**
* Callback interface for the placement mode.
*/
interface I_PlacementCallback {
/**
* Called to place an element at a specific position.
* @param container the target container
* @param referenceElement the reference element (may be null for an empty container)
* @param offset the offset (0 means insert before the reference element, 1 means after)
*/
void place(CmsContainerPageContainer container, CmsContainerPageElementPanel referenceElement, int offset);
}
/**
* Layer for displaying placement buttons, covering everything else on the page.
*/
static class PlacementLayer extends FlowPanel implements HasClickHandlers {
/**
* @see com.google.gwt.event.dom.client.HasClickHandlers#addClickHandler(com.google.gwt.event.dom.client.ClickHandler)
*/
@Override
public HandlerRegistration addClickHandler(ClickHandler handler) {
return addDomHandler(handler, ClickEvent.getType());
}
};
/** The container highlighting offset. */
public static final int HIGHLIGHTING_OFFSET = 4;
/** CSS class. */
public static final String OC_PLACEMENT_BUTTON = "oc-placement-button";
/** CSS class. */
public static final String OC_PLACEMENT_BUTTONS_VERTICAL = "oc-placement-buttons-vertical";
/** CSS class. */
public static final String OC_PLACEMENT_DOWN = "oc-placement-down";
/** CSS class. */
public static final String OC_PLACEMENT_LAYER = "oc-placement-layer";
/** CSS class. */
public static final String OC_PLACEMENT_LEFT = "oc-placement-left";
/** CSS class. */
public static final String OC_PLACEMENT_MODE = "oc-placement-mode";
/** CSS class. */
public static final String OC_PLACEMENT_PLACEHOLDER = "oc-placement-placeholder";
/** CSS class. */
public static final String OC_PLACEMENT_RIGHT = "oc-placement-right";
/** CSS class. */
public static final String OC_PLACEMENT_SELECTED_ELEMENT = "oc-placement-selected-element";
/** CSS class. */
public static final String OC_PLACEMENT_UP = "oc-placement-up";
/** The bigger size for the placement buttons. */
public static final int PLACEMENT_BUTTON_BIG = 30;
/** The smaller size for the placement buttons. */
public static final int PLACEMENT_BUTTON_SMALL = 20;
/** The button counter for placement mode. */
private static int m_buttonCounter;
/** The minimum margin set to empty containers. */
private static final int MINIMUM_CONTAINER_MARGIN = 10;
/** CSS class. */
private static final String OC_PLACEMENT_MIDDLE = "oc-placement-middle";
/** The container page controller. */
protected CmsContainerpageController m_controller;
/** The id of the dragged element. */
protected String m_draggableId;
/** The id of the container from which an element was dragged. */
String m_originalContainerId;
/** Tracks whether an element has been added to the page (rather than just moved around). */
private boolean m_added;
/** The copy group id. */
private String m_copyGroupId;
/** The current place holder index. */
private int m_currentIndex = -1;
/** The current drop target. */
private I_CmsDropTarget m_currentTarget;
/** Map of current drag info beans. */
private Map m_dragInfos;
/** The drag overlay. */
private Element m_dragOverlay;
/** DND controller for images. We set this in onDragStart if we are dragging an image, and then delegate most of the other method calls to it if it is set.*/
private CmsImageDndController m_imageDndController;
/** The ionitial drop target. */
private I_CmsDropTarget m_initialDropTarget;
/** The original position of the draggable. */
private int m_originalIndex;
/** The placement context. */
private CmsPlacementModeContext m_placementContext;
/**
* Constructor.
*
* @param controller the container page controller
*/
public CmsContainerpageDNDController(CmsContainerpageController controller) {
m_controller = controller;
m_dragInfos = new HashMap();
Window.addResizeHandler(event -> {
if (m_placementContext != null) {
stopDrag(m_placementContext.getDNDHandler());
}
});
}
/**
* Placement button big.
*
* @return the string
*/
public static final String placementButtonBig() {
return PLACEMENT_BUTTON_BIG + "px";
}
/**
* Placement button small.
*
* @return the string
*/
public static final String placementButtonSmall() {
return PLACEMENT_BUTTON_SMALL + "px";
}
/**
* Checks if a 1D line segment comes before a position.
*
* @param start the start position of the segment
* @param size the width of the segment
* @param pos the position to check
* @return true, if successful
*/
public static boolean segmentBefore(int start, int size, int pos) {
return (start + size) <= pos;
}
/**
* Checks if two 1D line segments with given start positions and sizes intersect.
*
* @param start1 start position of the first segment
* @param size1 size of the first segment
* @param start2 start position of the second segment
* @param size2 size of the second segment
* @return true, if successful
*/
public static boolean segmentIntersect(int start1, int size1, int start2, int size2) {
return !segmentBefore(start1, size1, start2) && !segmentBefore(start2, size2, start1);
}
/**
* Checks if the given id is a new id.
*
* @param id the id
*
* @return true if the id is a new id
*/
private static boolean isNewId(String id) {
if (id.contains("#")) {
id = id.substring(0, id.indexOf("#"));
}
return !CmsUUID.isValidUUID(id);
}
/**
* @see org.opencms.gwt.client.dnd.I_CmsDNDController#onAnimationStart(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget, org.opencms.gwt.client.dnd.CmsDNDHandler)
*/
public void onAnimationStart(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler) {
// remove highlighting
for (I_CmsDropTarget dropTarget : m_dragInfos.keySet()) {
if (dropTarget instanceof I_CmsDropContainer) {
((I_CmsDropContainer)dropTarget).removeHighlighting();
}
}
}
/**
* @see org.opencms.gwt.client.dnd.I_CmsDNDController#onBeforeDrop(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget, org.opencms.gwt.client.dnd.CmsDNDHandler)
*/
public boolean onBeforeDrop(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler) {
return true;
}
/**
* @see org.opencms.gwt.client.dnd.I_CmsDNDController#onDragCancel(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget, org.opencms.gwt.client.dnd.CmsDNDHandler)
*/
public void onDragCancel(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler) {
if (m_imageDndController != null) {
m_imageDndController.onDragCancel(draggable, target, handler);
removeDragOverlay();
m_imageDndController = null;
return;
}
stopDrag(handler);
}
/**
* @see org.opencms.gwt.client.dnd.I_CmsDNDController#onDragStart(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget, org.opencms.gwt.client.dnd.CmsDNDHandler)
*/
public boolean onDragStart(final I_CmsDraggable draggable, I_CmsDropTarget target, final CmsDNDHandler handler) {
installDragOverlay();
m_currentTarget = null;
m_currentIndex = -1;
m_draggableId = draggable.getId();
m_originalIndex = -1;
m_initialDropTarget = target;
handler.setOrientation(Orientation.ALL);
m_controller.hideEditableListButtons();
if (isImage(draggable)) {
if (m_controller.isGroupcontainerEditing()) {
// don't allow image DND while editing group containers
return false;
}
// We are going to delegate further method calls to this, and set it to null again if the image is dragged or the
// DND operation is cancelled
m_imageDndController = new CmsImageDndController(CmsContainerpageController.get());
return m_imageDndController.onDragStart(draggable, target, handler);
}
if (!m_controller.isGroupcontainerEditing()) {
m_controller.lockContainerpage(new I_CmsSimpleCallback() {
public void execute(Boolean arg) {
if (!arg.booleanValue()) {
handler.cancel();
}
}
});
}
String containerId = null;
if (target instanceof CmsContainerPageContainer) {
containerId = ((CmsContainerPageContainer)target).getContainerId();
} else {
// set marker id
containerId = CmsContainerElement.MENU_CONTAINER_ID;
}
m_originalContainerId = containerId;
if (target != null) {
handler.addTarget(target);
if (target instanceof I_CmsDropContainer) {
prepareTargetContainer((I_CmsDropContainer)target, draggable, handler.getPlaceholder());
Element helper = handler.getDragHelper();
handler.setCursorOffsetX(helper.getOffsetWidth() - 15);
handler.setCursorOffsetY(20);
}
}
m_dragInfos.put(target, handler.getPlaceholder());
m_controller.getHandler().hideMenu();
String clientId = draggable.getId();
if (CmsStringUtil.isEmptyOrWhitespaceOnly(clientId)) {
CmsDebugLog.getInstance().printLine("draggable has no id, canceling drop");
return false;
}
final I_CmsSimpleCallback callback = new I_CmsSimpleCallback() {
/**
* Execute on success.
*
* @param arg the container element data
*/
public void execute(CmsContainerElementData arg) {
prepareHelperElements(arg, handler, draggable);
handler.updatePosition();
}
};
if (isNewId(clientId)) {
// for new content elements dragged from the gallery menu, the given id contains the resource type name
m_controller.getNewElement(clientId, callback);
} else {
m_controller.getElementForDragAndDropFromContainer(clientId, m_originalContainerId, false, callback);
}
if (!(target instanceof CmsContainerPageContainer)) {
handler.setStartPosition(-1, 0);
}
m_controller.sendDragStarted(isNew(draggable));
return true;
}
/**
* @see org.opencms.gwt.client.dnd.I_CmsDNDController#onDrop(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget, org.opencms.gwt.client.dnd.CmsDNDHandler)
*/
public void onDrop(final I_CmsDraggable draggable, final I_CmsDropTarget target, CmsDNDHandler handler) {
if (m_imageDndController != null) {
m_imageDndController.onDrop(draggable, target, handler);
removeDragOverlay();
m_imageDndController = null;
return;
}
m_added = (draggable instanceof CmsListItem) && (target instanceof CmsContainerPageContainer);
if (target != m_initialDropTarget) {
if (target instanceof I_CmsDropContainer) {
final I_CmsDropContainer container = (I_CmsDropContainer)target;
final int index = container.getPlaceholderIndex();
final String modelReplaceId = container instanceof CmsContainerPageContainer
? ((CmsContainerPageContainer)container).getCopyModelReplaceId()
: null;
if (!isNew(draggable) && (draggable instanceof CmsListItem)) {
// existing element from add menu
final String copyGroupId = m_copyGroupId;
AsyncCallback modeCallback = new AsyncCallback() {
public void onFailure(Throwable caught) {
if (caught != null) {
CmsErrorDialog.handleException(caught);
}
}
public void onSuccess(String result) {
if (Objects.equal(result, CmsEditorConstants.MODE_COPY)) {
final CmsContainerpageController controller = CmsContainerpageController.get();
if (copyGroupId == null) {
CmsContainerElementData data = controller.getCachedElement(m_draggableId);
final Map settings = data.getSettings();
controller.copyElement(
CmsContainerpageController.getServerId(m_draggableId),
new I_CmsSimpleCallback() {
public void execute(CmsUUID resultId) {
controller.getElementWithSettings(
"" + resultId,
settings,
new I_CmsSimpleCallback() {
public void execute(CmsContainerElementData newData) {
insertDropElement(
newData,
container,
index,
draggable,
modelReplaceId);
container.removePlaceholder();
}
});
}
});
} else {
controller.getElementForDragAndDropFromContainer(
copyGroupId,
m_originalContainerId,
true,
new I_CmsSimpleCallback() {
public void execute(CmsContainerElementData arg) {
insertDropElement(arg, container, index, draggable, modelReplaceId);
container.removePlaceholder();
}
});
}
} else if (Objects.equal(result, CmsEditorConstants.MODE_REUSE)) {
insertDropElement(
m_controller.getCachedElement(m_draggableId),
container,
index,
draggable,
modelReplaceId);
container.removePlaceholder();
}
}
};
CmsUUID structureId = new CmsUUID(CmsContainerpageController.getServerId(m_draggableId));
CmsContainerElementData cachedElementData = m_controller.getCachedElement(m_draggableId);
ElementReuseMode reuseMode = isCopyModel(draggable)
? ElementReuseMode.copy
: (((cachedElementData != null) && !cachedElementData.isCopyInModels())
? ElementReuseMode.reuse
: CmsContainerpageController.get().getData().getElementReuseMode());
if ((!handler.isPlacementMode()) && handler.hasModifierCTRL()) {
reuseMode = ElementReuseMode.ask;
}
if (reuseMode != ElementReuseMode.reuse) {
if ((cachedElementData != null)
&& (!cachedElementData.hasWritePermission()
|| cachedElementData.isModelGroup()
|| cachedElementData.isCopyDisabled()
|| cachedElementData.isWasModelGroup())) {
// User is not allowed to create this element in current view, so reuse the element instead
reuseMode = ElementReuseMode.reuse;
}
}
switch (reuseMode) {
case ask:
// when dropping elements from the into the page, we ask the user if the dropped element should
// be used, or a copy of it. If the user wants a copy, we copy the corresponding resource and replace the element
// in the page
CmsDroppedElementModeSelectionDialog.showDialog(structureId, modeCallback);
break;
case copy:
modeCallback.onSuccess(CmsEditorConstants.MODE_COPY);
break;
case reuse:
default:
modeCallback.onSuccess(CmsEditorConstants.MODE_REUSE);
break;
}
} else {
// new article or moved from different container
insertDropElement(m_controller.getCachedElement(m_draggableId), container, index, draggable, null);
}
} else if (target instanceof CmsList) {
m_controller.addToFavoriteList(m_draggableId);
}
} else if ((target instanceof I_CmsDropContainer)
&& (draggable instanceof CmsContainerPageElementPanel)
&& isChangedPosition(target)) {
CmsDomUtil.showOverlay(draggable.getElement(), false);
I_CmsDropContainer container = (I_CmsDropContainer)target;
int count = container.getWidgetCount();
if (!handler.isPlacementMode()) {
handler.getPlaceholder().getStyle().setDisplay(Display.NONE);
}
if (container.getPlaceholderIndex() >= count) {
container.add((CmsContainerPageElementPanel)draggable);
} else {
container.insert((CmsContainerPageElementPanel)draggable, container.getPlaceholderIndex());
}
m_controller.addToRecentList(m_draggableId, null);
m_controller.sendElementMoved((CmsContainerPageElementPanel)draggable);
// changes are only relevant to the container page if not group-container editing
if (!m_controller.isGroupcontainerEditing()) {
m_controller.setPageChanged();
}
} else if (draggable instanceof CmsContainerPageElementPanel) {
CmsDomUtil.showOverlay(draggable.getElement(), false);
// to reset mouse over state remove and attach the option bar
CmsContainerPageElementPanel containerElement = (CmsContainerPageElementPanel)draggable;
CmsElementOptionBar optionBar = containerElement.getElementOptionBar();
optionBar.removeFromParent();
containerElement.setElementOptionBar(optionBar);
}
stopDrag(handler);
}
/**
* @see org.opencms.gwt.client.dnd.I_CmsDNDController#onPositionedPlaceholder(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget, org.opencms.gwt.client.dnd.CmsDNDHandler)
*/
public void onPositionedPlaceholder(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler) {
if (m_imageDndController != null) {
m_imageDndController.onPositionedPlaceholder(draggable, target, handler);
return;
}
if (hasChangedPosition(target)) {
checkPlaceholderVisibility(target);
updateHighlighting(false, false);
}
}
/**
* @see org.opencms.gwt.client.dnd.I_CmsDNDController#onTargetEnter(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget, org.opencms.gwt.client.dnd.CmsDNDHandler)
*/
public boolean onTargetEnter(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler) {
if (m_imageDndController != null) {
return m_imageDndController.onTargetEnter(draggable, target, handler);
}
if (target instanceof CmsContainerPageContainer) {
CmsContainerPageContainer container = (CmsContainerPageContainer)target;
if (container.isShowingEmptyContainerElement()) {
CmsContainerPageContainer.newResizeHelper(container).initHeight();
}
}
Element placeholder = m_dragInfos.get(target);
if (placeholder != null) {
handler.getPlaceholder().getStyle().setDisplay(Display.NONE);
handler.setPlaceholder(placeholder);
placeholder.getStyle().clearDisplay();
if ((target != m_initialDropTarget) && (target instanceof I_CmsDropContainer)) {
((I_CmsDropContainer)target).checkMaxElementsOnEnter();
}
}
return true;
}
/**
* @see org.opencms.gwt.client.dnd.I_CmsDNDController#onTargetLeave(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget, org.opencms.gwt.client.dnd.CmsDNDHandler)
*/
public void onTargetLeave(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler) {
if (m_imageDndController != null) {
m_imageDndController.onTargetLeave(draggable, target, handler);
return;
}
CmsContainerPageContainer.clearResizeHelper();
m_currentTarget = null;
m_currentIndex = -1;
Element placeholder = m_dragInfos.get(m_initialDropTarget);
if (placeholder != null) {
handler.getPlaceholder().getStyle().setDisplay(Display.NONE);
handler.setPlaceholder(placeholder);
placeholder.getStyle().setDisplay(Display.NONE);
if ((target != m_initialDropTarget) && (target instanceof I_CmsDropContainer)) {
((I_CmsDropContainer)target).checkMaxElementsOnLeave();
}
}
updateHighlighting(false, false);
}
/**
* @see org.opencms.gwt.client.dnd.I_CmsDNDController#postClear(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget)
*/
@Override
public void postClear(I_CmsDraggable draggable, I_CmsDropTarget target) {
Element dragElem = null;
if (draggable != null) {
dragElem = draggable.getElement();
}
Element targetElem = null;
if (target != null) {
targetElem = target.getElement();
}
m_controller.sendDragFinished(dragElem, targetElem, isNew(draggable));
}
/**
* Starts placement mode for the given draggable.
*
* @param draggable the draggable element
* @param handler the handler
* @return true, if successful
*/
public boolean startPlacementMode(I_CmsDraggable draggable, CmsDNDHandler handler) {
if (draggable instanceof CmsListItem) {
// ensure button doesn't remain visible
((CmsListItem)draggable).getListItemWidget().forceMouseOut();
} else if (draggable instanceof CmsContainerPageElementPanel) {
((CmsContainerPageElementPanel)draggable).removeHighlighting();
}
if (!m_controller.getData().isPlacementModeEnabled()) {
return false;
}
if (isImage(draggable)) {
return false;
}
if (m_controller.isGroupcontainerEditing()) {
return false;
}
final I_CmsSimpleCallback callback = new I_CmsSimpleCallback() {
/**
* Execute on success.
*
* @param elem the container element data
*/
public void execute(CmsContainerElementData elem) {
Set containerIds = new HashSet<>();
for (String containerId : elem.getContents().keySet()) {
CmsContainerPageContainer container = m_controller.getContainerTarget(containerId);
if (draggable instanceof CmsContainerPageElementPanel) {
if ((container != null) && draggable.getElement().isOrHasChild(container.getElement())) {
// can't move an element into one of its own nested containers
continue;
}
}
String content = elem.getContents().get(containerId);
// check if content is valid HTML
Element testElement = null;
if (content != null) {
try {
testElement = CmsDomUtil.createElement(content);
} catch (Exception e) {
CmsGwtLog.log(
"Invalid formatter output for element of type "
+ elem.getResourceType()
+ ": ["
+ content
+ "]");
}
}
if (testElement != null) {
containerIds.add(containerId);
}
}
CmsListInfoBean info = null;
if (draggable instanceof CmsListItem) {
CmsListItem item = (CmsListItem)draggable;
info = item.getListItemWidget().getInfoBean();
} else {
info = elem.getListInfo();
}
if (info == null) {
// should never happen
info = new CmsListInfoBean("???", "", new ArrayList<>());
}
CmsListItemWidget newItem = new CmsListItemWidget(info);
newItem.setWidth("500px");
if (newItem.getOpenClose() != null) {
newItem.getOpenClose().removeFromParent();
}
prepareHelperElements(elem, handler, draggable);
setPlacementContext(
new CmsPlacementModeContext(containerIds, newItem, handler, draggable, (cnt, reference, offset) -> {
if (reference != null) {
placeElement(handler, draggable, elem, reference, offset);
} else {
placeNewElement(handler, draggable, elem, cnt);
}
}));
}
};
// we need to reset this so highlighting works correctly
m_initialDropTarget = null;
String clientId = draggable.getId();
if (isNewId(clientId)) {
// for new content elements dragged from the gallery menu, the given id contains the resource type name
if (draggable instanceof CmsContainerPageElementPanel) {
CmsContainerPageElementPanel containerElement = ((CmsContainerPageElementPanel)draggable);
containerElement.addStyleName(OC_PLACEMENT_SELECTED_ELEMENT);
}
m_controller.getNewElement(clientId, callback);
} else {
String originContainer = CmsContainerElement.MENU_CONTAINER_ID;
if (draggable instanceof CmsContainerPageElementPanel) {
CmsContainerPageElementPanel containerElement = ((CmsContainerPageElementPanel)draggable);
containerElement.addStyleName(OC_PLACEMENT_SELECTED_ELEMENT);
I_CmsDropContainer dropContainer = containerElement.getParentTarget();
if (dropContainer instanceof CmsContainerPageContainer) {
String realOrigin = ((CmsContainerPageContainer)dropContainer).getContainerId();
if (realOrigin != null) {
originContainer = realOrigin;
}
}
}
m_controller.getElementForDragAndDropFromContainer(clientId, originContainer, false, callback);
}
return true;
}
/**
* Prepares all helper elements for the different drop targets.
*
* @param elementData the element data
* @param handler the drag and drop handler
* @param draggable the draggable
*/
protected void prepareHelperElements(
CmsContainerElementData elementData,
CmsDNDHandler handler,
I_CmsDraggable draggable) {
if (elementData == null) {
CmsDebugLog.getInstance().printLine("elementData == null!");
if (!handler.isPlacementMode()) {
handler.cancel();
}
return;
}
if (!handler.isPlacementMode() && !handler.isDragging()) {
return;
}
if (elementData.isGroup()) {
m_copyGroupId = m_draggableId;
} else {
m_copyGroupId = null;
}
if ((elementData.getDndId() != null) && (m_controller.getCachedElement(elementData.getDndId()) != null)) {
m_draggableId = elementData.getDndId();
elementData = m_controller.getCachedElement(m_draggableId);
} else {
m_draggableId = elementData.getClientId();
}
if (!elementData.isGroupContainer() && !elementData.isInheritContainer()) {
for (CmsContainerPageContainer container : m_controller.getContainerTargets().values()) {
String containerId = container.getContainerId();
loadCss(elementData, containerId);
}
}
if (m_controller.isGroupcontainerEditing()) {
CmsGroupContainerElementPanel groupContainer = m_controller.getGroupcontainer();
if ((groupContainer != m_initialDropTarget)
&& !(elementData.isGroupContainer() || elementData.isInheritContainer())
&& (elementData.getContents().get(groupContainer.getContainerId()) != null)) {
Element placeholder = null;
String containerId = groupContainer.getContainerId();
loadCss(elementData, containerId);
placeholder = createPlaceholderFromHtmlForContainer(elementData, placeholder, containerId);
if (placeholder != null) {
prepareDragInfo(placeholder, groupContainer, handler);
groupContainer.highlightContainer(false);
}
}
return;
}
if (!m_controller.isEditingDisabled()) {
for (CmsContainerPageContainer container : m_controller.getContainerTargets().values()) {
if (draggable.getElement().isOrHasChild(container.getElement())) {
// skip containers that are children of the draggable element
continue;
}
if ((container != m_initialDropTarget)
&& !container.isDetailView()
&& (m_controller.getData().isModelGroup() || !container.hasModelGroupParent())
&& (elementData.getContents().get(container.getContainerId()) != null)) {
Element placeholder = null;
if (elementData.isGroupContainer() || elementData.isInheritContainer()) {
placeholder = DOM.createDiv();
String content = "";
for (String groupId : elementData.getSubItems()) {
CmsContainerElementData subData = m_controller.getCachedElement(groupId);
if (subData != null) {
if (subData.isShowInContext(
CmsContainerpageController.get().getData().getTemplateContextInfo().getCurrentContext())) {
if ((subData.getContents().get(container.getContainerId()) != null)) {
content += subData.getContents().get(container.getContainerId());
}
} else {
content += "
";
}
}
}
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(content)) {
placeholder.setInnerHTML(content);
// ensure any embedded flash players are set opaque so UI elements may be placed above them
CmsDomUtil.fixFlashZindex(placeholder);
} else {
placeholder.addClassName(
I_CmsLayoutBundle.INSTANCE.containerpageCss().emptyGroupContainer());
}
} else {
placeholder = createPlaceholderFromHtmlForContainer(
elementData,
placeholder,
container.getContainerId());
}
if (placeholder != null) {
prepareDragInfo(placeholder, container, handler);
}
}
}
}
initNestedContainers();
// add highlighting after all drag targets have been initialized
updateHighlighting(true, handler.isPlacementMode());
}
/**
* Inserts e new container element into the container once the drag and drop is finished.
*
* @param elementData the element data to create the element from
* @param container the target container
* @param index the element index
* @param draggable the original drag element
* @param modelReplaceId the model replace id
*/
void insertDropElement(
CmsContainerElementData elementData,
I_CmsDropContainer container,
int index,
I_CmsDraggable draggable,
String modelReplaceId) {
try {
CmsContainerPageElementPanel containerElement = m_controller.getContainerpageUtil().createElement(
elementData,
container,
isNew(draggable));
if (isNew(draggable)) {
containerElement.setNewType(CmsContainerpageController.getServerId(m_draggableId));
} else {
m_controller.addToRecentList(elementData.getClientId(), null);
}
if (index >= container.getWidgetCount()) {
container.add(containerElement);
} else {
container.insert(containerElement, index);
}
if (draggable instanceof CmsContainerPageElementPanel) {
((CmsContainerPageElementPanel)draggable).removeFromParent();
}
m_controller.initializeSubContainers(containerElement);
if (modelReplaceId != null) {
m_controller.executeCopyModelReplace(
modelReplaceId,
((CmsContainerPageContainer)container).getFormerModelGroupParent(),
m_controller.getCachedElement(m_draggableId));
}
if (!m_controller.isGroupcontainerEditing()) {
if (containerElement.hasReloadMarker()) {
m_controller.setPageChanged(new Runnable() {
public void run() {
CmsContainerpageController.get().reloadPage();
}
});
} else {
m_controller.setPageChanged();
}
if (m_added) {
m_controller.sendElementAdded(containerElement);
} else {
m_controller.sendElementMoved(containerElement);
}
}
if (m_controller.isGroupcontainerEditing()) {
container.getElement().removeClassName(
I_CmsLayoutBundle.INSTANCE.containerpageCss().emptyGroupContainer());
}
} catch (Exception e) {
CmsErrorDialog.handleException(e.getMessage(), e);
}
}
/**
* Checks and sets if the place holder should be visible.
*
* @param target the target container
*/
private void checkPlaceholderVisibility(I_CmsDropTarget target) {
if (target instanceof I_CmsDropContainer) {
I_CmsDropContainer container = (I_CmsDropContainer)target;
container.setPlaceholderVisibility(
(container != m_initialDropTarget)
|| ((m_currentIndex - m_originalIndex) > 1)
|| ((m_originalIndex - m_currentIndex) > 0));
}
}
/**
* Creates a placeholder for an element and a specific container.
*
* @param elementData the element data
* @param placeholder the previous placeholder
* @param containerId the container id
* @return the element
*/
private Element createPlaceholderFromHtmlForContainer(
CmsContainerElementData elementData,
Element placeholder,
String containerId) {
try {
String htmlContent = elementData.getContents().get(containerId);
placeholder = CmsDomUtil.createElement(htmlContent);
// ensure any embedded flash players are set opaque so UI elements may be placed above them
CmsDomUtil.fixFlashZindex(placeholder);
placeholder.addClassName(I_CmsLayoutBundle.INSTANCE.dragdropCss().dragPlaceholder());
} catch (Exception e) {
CmsDebugLog.getInstance().printLine(e.getMessage());
}
return placeholder;
}
/**
* Checks if the placeholder position has changed.
*
* @param target the current drop target
*
* @return true if the placeholder position has changed
*/
private boolean hasChangedPosition(I_CmsDropTarget target) {
if ((m_currentTarget != target) || (m_currentIndex != target.getPlaceholderIndex())) {
m_currentTarget = target;
m_currentIndex = target.getPlaceholderIndex();
return true;
}
return false;
}
/**
* Initializes the nested container infos.
*/
private void initNestedContainers() {
for (CmsContainer container : m_controller.getContainers().values()) {
if (container.isSubContainer()) {
CmsContainerPageContainer containerWidget = m_controller.m_targetContainers.get(container.getName());
// check if the sub container is a valid drop targets
if (m_dragInfos.keySet().contains(containerWidget)) {
CmsContainer parentContainer = m_controller.getContainers().get(container.getParentContainerName());
// add the container to all it's ancestors as a dnd child
while (parentContainer != null) {
if (m_dragInfos.keySet().contains(
m_controller.m_targetContainers.get(parentContainer.getName()))) {
m_controller.m_targetContainers.get(parentContainer.getName()).addDndChild(containerWidget);
}
if (parentContainer.isSubContainer()) {
parentContainer = m_controller.getContainers().get(
parentContainer.getParentContainerName());
} else {
parentContainer = null;
}
}
}
}
}
}
/**
* Installs the drag overlay to avoid any mouse over issues or similar.
*/
private void installDragOverlay() {
if (m_dragOverlay != null) {
m_dragOverlay.removeFromParent();
}
m_dragOverlay = DOM.createDiv();
m_dragOverlay.addClassName(I_CmsLayoutBundle.INSTANCE.dragdropCss().dragOverlay());
Document.get().getBody().appendChild(m_dragOverlay);
}
/**
* Checks whether the current placeholder position represents a change to the original draggable position within the tree.
*
* @param target the current drop target
*
* @return true if the position changed
*/
private boolean isChangedPosition(I_CmsDropTarget target) {
// if the new index is not next to the old one, the position has changed
if ((target != m_initialDropTarget)
|| !((target.getPlaceholderIndex() == (m_originalIndex + 1))
|| (target.getPlaceholderIndex() == m_originalIndex))) {
return true;
}
return false;
}
/**
* Checks if the draggable item is a copy model.
*
* @param draggable the draggable item
*
* @return true if the item is a copy model
*/
private boolean isCopyModel(I_CmsDraggable draggable) {
if (!(draggable instanceof CmsResultListItem)) {
return false;
}
return ((CmsResultListItem)draggable).getResult().isCopyModel();
}
/**
* Checks if the given draggable item is an image.
*
* @param draggable the item to check
*
* @return true if the given item is an image
*/
private boolean isImage(I_CmsDraggable draggable) {
return (draggable instanceof CmsResultListItem)
&& CmsToolbarAllGalleriesMenu.DND_MARKER.equals(((CmsResultListItem)draggable).getData());
}
/**
* Checks if the given draggable is new.
*
* @param draggable the draggable
* @return true if the given draggable is new
*/
private boolean isNew(I_CmsDraggable draggable) {
boolean result = isNewId(draggable.getId());
return result;
}
/**
* Ensures that the CSS is loaded for the given element data and container.
*
* @param elementData the element data
* @param containerId he container id
*/
private void loadCss(CmsContainerElementData elementData, String containerId) {
Set cssResources = elementData.getCssResources(containerId);
if ((cssResources != null) && !cssResources.isEmpty()) {
// the element requires certain CSS resources, check if present and include if necessary
for (String cssResourceLink : cssResources) {
CmsDomUtil.ensureStyleSheetIncluded(cssResourceLink);
}
}
}
/**
* Placces an element relative to an existing element in placement mode.
*
* @param handler the handler
* @param draggable the element to be placed
* @param elem the data for the element
* @param reference the element relative to which the placed element should be inserted
* @param offset the index offset for the new element relative to the reference element (0 means 'before the reference element'!)
*/
private void placeElement(
CmsDNDHandler handler,
I_CmsDraggable draggable,
CmsContainerElementData elem,
CmsContainerPageElementPanel reference,
int offset) {
CmsContainerPageContainer cnt = (CmsContainerPageContainer)reference.getParentTarget();
int index = cnt.getWidgetIndex(reference) + offset;
if (index < 0) {
index = 0;
}
cnt.setPlaceholderIndex(index);
onDrop(draggable, cnt, handler);
// Placeholder index is not reset by onDrop for container -> container transfer
cnt.removePlaceholder();
handler.clearPlacement();
}
/**
* Places an element into an empty container in placement mode.
*
* @param handler the handler
* @param draggable the draggable for the element
* @param elem the data for the element
* @param cnt the target container
*/
private void placeNewElement(
CmsDNDHandler handler,
I_CmsDraggable draggable,
CmsContainerElementData elem,
CmsContainerPageContainer cnt) {
cnt.setPlaceholderIndex(0);
onDrop(draggable, cnt, handler);
// Placeholder index is not reset by onDrop for container -> container transfer
cnt.removePlaceholder();
handler.clearPlacement();
}
/**
* Sets styles of helper elements, appends the to the drop target and puts them into a drag info bean.
*
* @param placeholder the placeholder element
* @param target the drop target
* @param handler the drag and drop handler
*/
private void prepareDragInfo(Element placeholder, I_CmsDropContainer target, CmsDNDHandler handler) {
target.getElement().addClassName(I_CmsLayoutBundle.INSTANCE.dragdropCss().dragging());
String positioning = CmsDomUtil.getCurrentStyle(
target.getElement(),
org.opencms.gwt.client.util.CmsDomUtil.Style.position);
// set target relative, if not absolute or fixed
if (!Position.ABSOLUTE.getCssName().equals(positioning) && !Position.FIXED.getCssName().equals(positioning)) {
target.getElement().getStyle().setPosition(Position.RELATIVE);
// check for empty containers that don't have a minimum top and bottom margin to avoid containers overlapping
if (target.getElement().getFirstChildElement() == null) {
if (CmsDomUtil.getCurrentStyleInt(
target.getElement(),
CmsDomUtil.Style.marginTop) < MINIMUM_CONTAINER_MARGIN) {
target.getElement().getStyle().setMarginTop(MINIMUM_CONTAINER_MARGIN, Unit.PX);
}
if (CmsDomUtil.getCurrentStyleInt(
target.getElement(),
CmsDomUtil.Style.marginBottom) < MINIMUM_CONTAINER_MARGIN) {
target.getElement().getStyle().setMarginBottom(MINIMUM_CONTAINER_MARGIN, Unit.PX);
}
}
}
m_dragInfos.put(target, placeholder);
if (!handler.isPlacementMode()) {
handler.addTarget(target);
}
}
/**
* Prepares the target container.
*
* @param targetContainer the container
* @param draggable the draggable
* @param placeholder the placeholder
*/
private void prepareTargetContainer(
I_CmsDropContainer targetContainer,
I_CmsDraggable draggable,
Element placeholder) {
String positioning = CmsDomUtil.getCurrentStyle(
targetContainer.getElement(),
org.opencms.gwt.client.util.CmsDomUtil.Style.position);
// set target relative, if not absolute or fixed
if (!Position.ABSOLUTE.getCssName().equals(positioning) && !Position.FIXED.getCssName().equals(positioning)) {
targetContainer.getElement().getStyle().setPosition(Position.RELATIVE);
}
m_originalIndex = targetContainer.getWidgetIndex((Widget)draggable);
targetContainer.getElement().insertBefore(placeholder, draggable.getElement());
targetContainer.getElement().addClassName(I_CmsLayoutBundle.INSTANCE.dragdropCss().dragging());
CmsDomUtil.showOverlay(draggable.getElement(), true);
targetContainer.highlightContainer(false);
}
/**
* Removes the drag overlay.
*/
private void removeDragOverlay() {
if (m_dragOverlay != null) {
m_dragOverlay.removeFromParent();
m_dragOverlay = null;
}
}
/**
* Sets the placement context and initializes it, but cleans up the previous placement context, if any.
*
* @param newContext the placement context (can be null)
*/
private void setPlacementContext(CmsPlacementModeContext newContext) {
CmsPlacementModeContext oldContext = m_placementContext;
m_placementContext = null;
if (oldContext != null) {
oldContext.destroy();
}
m_placementContext = newContext;
if (m_placementContext != null) {
m_placementContext.init();
}
}
/**
* Function which is called when the drag process is stopped, either by cancelling or dropping.
*
* @param handler the drag and drop handler
*/
private void stopDrag(final CmsDNDHandler handler) {
removeDragOverlay();
setPlacementContext(null);
CmsContainerPageContainer.clearResizeHelper();
for (I_CmsDropTarget target : m_dragInfos.keySet()) {
target.getElement().removeClassName(I_CmsLayoutBundle.INSTANCE.dragdropCss().dragging());
target.getElement().removeClassName(I_CmsLayoutBundle.INSTANCE.dragdropCss().clearFix());
Style targetStyle = target.getElement().getStyle();
if (!(target instanceof CmsGroupContainerElementPanel)) {
targetStyle.clearPosition();
}
targetStyle.clearMarginTop();
targetStyle.clearMarginBottom();
if (target instanceof I_CmsDropContainer) {
((I_CmsDropContainer)target).removeHighlighting();
}
}
if ((!handler.isPlacementMode()) && (handler.getDragHelper() != null)) {
handler.getDragHelper().removeFromParent();
}
m_copyGroupId = null;
m_currentTarget = null;
m_currentIndex = -1;
m_controller.getHandler().deactivateMenuButton();
final List dragTargets = new ArrayList(m_dragInfos.keySet());
m_dragInfos.clear();
Scheduler.get().scheduleDeferred(new ScheduledCommand() {
/**
* @see com.google.gwt.user.client.Command#execute()
*/
public void execute() {
if (!handler.isPlacementMode()) {
handler.clearTargets();
}
m_controller.resetEditButtons();
// in case of group editing, this will refresh the container position and size
for (I_CmsDropTarget target : dragTargets) {
if (target instanceof I_CmsDropContainer) {
((I_CmsDropContainer)target).refreshHighlighting();
// reset the nested container infos
((I_CmsDropContainer)target).clearDnDChildren();
}
}
}
});
if ((!handler.isPlacementMode()) && (handler.getDraggable() instanceof CmsContainerPageElementPanel)) {
((CmsContainerPageElementPanel)(handler.getDraggable())).removeHighlighting();
}
if (handler.isPlacementMode()) {
handler.clearPlacement();
}
}
/**
* Updates the drag target highlighting.
*
* @param initial true when initially highlighting the drop containers
* @param placementMode when we're in placement mode
*/
private void updateHighlighting(boolean initial, boolean placementMode) {
Map containers = new HashMap();
for (I_CmsDropTarget target : m_dragInfos.keySet()) {
if ((target instanceof I_CmsDropContainer) && (target.getElement().getOffsetParent() != null)) {
if (initial && (target != m_initialDropTarget)) {
((I_CmsDropContainer)target).highlightContainer(placementMode);
} else {
((I_CmsDropContainer)target).updatePositionInfo();
}
containers.put((I_CmsDropContainer)target, ((I_CmsDropContainer)target).getPositionInfo());
}
}
List containersToMatch = new ArrayList(containers.keySet());
if (!placementMode) {
// in placement mode, only one container is highlighted at a time, so we don't need to run the collision avoidance
for (I_CmsDropContainer contA : containers.keySet()) {
containersToMatch.remove(contA);
for (I_CmsDropContainer contB : containersToMatch) {
CmsPositionBean posA = containers.get(contA);
CmsPositionBean posB = containers.get(contB);
if (CmsPositionBean.checkCollision(posA, posB, HIGHLIGHTING_OFFSET * 3)) {
if (contA.hasDnDChildren() && contA.getDnDChildren().contains(contB)) {
if (!posA.isInside(posB, HIGHLIGHTING_OFFSET)) {
// the nested container is not completely inside the other
// increase the size of the outer container
posA.ensureSurrounds(posB, HIGHLIGHTING_OFFSET);
}
} else if (contB.hasDnDChildren() && contB.getDnDChildren().contains(contA)) {
if (!posB.isInside(posA, HIGHLIGHTING_OFFSET)) {
// the nested container is not completely inside the other
// increase the size of the outer container
posB.ensureSurrounds(posA, HIGHLIGHTING_OFFSET);
}
} else {
CmsPositionBean.avoidCollision(posA, posB, HIGHLIGHTING_OFFSET * 3);
}
}
}
}
}
for (Entry containerEntry : containers.entrySet()) {
containerEntry.getKey().refreshHighlighting(containerEntry.getValue());
}
}
}