Java tutorial
/* * Copyright 2015 John Ahlroos * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except * in compliance with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software distributed under the License * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express * or implied. See the License for the specific language governing permissions and limitations under * the License. */ package fi.jasoft.dragdroplayouts; import java.util.Map; import com.vaadin.event.Transferable; import com.vaadin.event.dd.DropHandler; import com.vaadin.event.dd.DropTarget; import com.vaadin.event.dd.TargetDetails; import com.vaadin.event.dd.TargetDetailsImpl; import com.vaadin.server.PaintException; import com.vaadin.server.PaintTarget; import com.vaadin.shared.MouseEventDetails; import com.vaadin.shared.ui.dd.HorizontalDropLocation; import com.vaadin.ui.Component; import com.vaadin.ui.HorizontalLayout; import com.vaadin.ui.LegacyComponent; import fi.jasoft.dragdroplayouts.client.ui.Constants; import fi.jasoft.dragdroplayouts.client.ui.LayoutDragMode; import fi.jasoft.dragdroplayouts.client.ui.horizontallayout.DDHorizontalLayoutState; import fi.jasoft.dragdroplayouts.client.ui.util.IframeCoverUtility; import fi.jasoft.dragdroplayouts.events.LayoutBoundTransferable; import fi.jasoft.dragdroplayouts.interfaces.DragFilter; import fi.jasoft.dragdroplayouts.interfaces.DragFilterSupport; import fi.jasoft.dragdroplayouts.interfaces.DragImageProvider; import fi.jasoft.dragdroplayouts.interfaces.DragImageReferenceSupport; import fi.jasoft.dragdroplayouts.interfaces.LayoutDragSource; import fi.jasoft.dragdroplayouts.interfaces.ShimSupport; /** * Horizontal layout with drag and drop support * * @author John Ahlroos / www.jasoft.fi * @since 0.4.0 */ @SuppressWarnings("serial") public class DDHorizontalLayout extends HorizontalLayout implements LayoutDragSource, DropTarget, ShimSupport, LegacyComponent, DragFilterSupport, DragImageReferenceSupport { /** * The drop handler which handles dropped components in the layout. */ private DropHandler dropHandler; // A filter for dragging components. private DragFilter dragFilter = DragFilter.ALL; private DragImageProvider dragImageProvider; /** * Contains the component over which the drop was made and the index on * which the drop was made. */ public class HorizontalLayoutTargetDetails extends TargetDetailsImpl { private Component over; private int index = -1; protected HorizontalLayoutTargetDetails(Map<String, Object> rawDropData) { super(rawDropData, DDHorizontalLayout.this); // Get over which component (if any) the drop was made and the // index of it if (getData(Constants.DROP_DETAIL_TO) != null) { index = Integer.valueOf(getData(Constants.DROP_DETAIL_TO).toString()); if (index >= 0 && index < components.size()) { over = components.get(index); } } // Was the drop over no specific cell if (over == null) { over = DDHorizontalLayout.this; } } /** * The component over which the drop was made. * * @return Null if the drop was not over a component, else the component */ public Component getOverComponent() { return over; } /** * The index over which the drop was made. If the drop was not made over * any component then it returns -1. * * @return The index of the component or -1 if over no component. */ public int getOverIndex() { return index; } /** * Some details about the mouse event * * @return details about the actual event that caused the event details. * Practically mouse move or mouse up. */ public MouseEventDetails getMouseEvent() { return MouseEventDetails.deSerialize(getData(Constants.DROP_DETAIL_MOUSE_EVENT).toString()); } /** * Get the horizontal position of the dropped component within the * underlying cell. * * @return The drop location */ public HorizontalDropLocation getDropLocation() { if (getData(Constants.DROP_DETAIL_HORIZONTAL_DROP_LOCATION) != null) { return HorizontalDropLocation .valueOf(getData(Constants.DROP_DETAIL_HORIZONTAL_DROP_LOCATION).toString()); } else { return null; } } } /** * Construct a new horizontal layout */ public DDHorizontalLayout() { super(); } /** * Construct a new horizontal layout with children * * @param components * the child components to add */ public DDHorizontalLayout(Component... components) { super(components); } /** * {@inheritDoc} * */ public void paintContent(PaintTarget target) throws PaintException { if (dropHandler != null && isEnabled()) { dropHandler.getAcceptCriterion().paint(target); } // Drop ratios target.addAttribute(Constants.ATTRIBUTE_HORIZONTAL_DROP_RATIO, getState().cellLeftRightDropRatio); // Drag mode if (isEnabled()) { target.addAttribute(Constants.DRAGMODE_ATTRIBUTE, getState().ddState.dragMode.ordinal()); } else { target.addAttribute(Constants.DRAGMODE_ATTRIBUTE, LayoutDragMode.NONE.ordinal()); } // Shims target.addAttribute(IframeCoverUtility.SHIM_ATTRIBUTE, getState().ddState.iframeShims); } /* * (non-Javadoc) * * @see * com.vaadin.event.dd.DropTarget#translateDropTargetDetails(java.util.Map) */ public TargetDetails translateDropTargetDetails(Map<String, Object> clientVariables) { return new HorizontalLayoutTargetDetails(clientVariables); } /** * Get the transferable created by a drag event. */ public Transferable getTransferable(Map<String, Object> rawVariables) { return new LayoutBoundTransferable(this, rawVariables); } /** * Returns the drop handler which handles drop events from dropping * components on the layout. Returns Null if dropping is disabled. */ public DropHandler getDropHandler() { return dropHandler; } /** * Sets the current handler which handles dropped components on the layout. * By setting a drop handler dropping components on the layout is enabled. * By setting the dropHandler to null dropping is disabled. * * @param dropHandler * The drop handler to handle drop events or null to disable * dropping */ public void setDropHandler(DropHandler dropHandler) { DDUtil.verifyHandlerType(this, dropHandler); if (this.dropHandler != dropHandler) { this.dropHandler = dropHandler; markAsDirty(); } } /** * Returns the mode of which dragging is visualized. * * @return */ public LayoutDragMode getDragMode() { return getState().ddState.dragMode; } /** * Enables dragging components from the layout. * * @param mode * The mode of which how the dragging should be visualized. */ public void setDragMode(LayoutDragMode mode) { getState().ddState.dragMode = mode; } /** * Sets the ratio which determines how a cell is divided into drop zones. * The ratio is measured from the left and right borders. For example, * setting the ratio to 0.3 will divide the drop zone in three equal parts * (left,middle,right). Setting the ratio to 0.5 will disable dropping in * the middle and setting it to 0 will disable dropping at the sides. * * @param ratio * A ratio between 0 and 0.5. Default is 0.2 */ public void setComponentHorizontalDropRatio(float ratio) { if (getState().cellLeftRightDropRatio != ratio) { if (ratio >= 0 && ratio <= 0.5) { getState().cellLeftRightDropRatio = ratio; } else { throw new IllegalArgumentException("Ratio must be between 0 and 0.5"); } } } /** * {@inheritDoc} */ public void setShim(boolean shim) { getState().ddState.iframeShims = shim; } /** * {@inheritDoc} */ public boolean isShimmed() { return getState().ddState.iframeShims; } /** * {@inheritDoc} */ public DragFilter getDragFilter() { return dragFilter; } /** * {@inheritDoc} */ public void setDragFilter(DragFilter dragFilter) { this.dragFilter = dragFilter; } @Override public DDHorizontalLayoutState getState() { return (DDHorizontalLayoutState) super.getState(); } @Override public void beforeClientResponse(boolean initial) { super.beforeClientResponse(initial); DDUtil.onBeforeClientResponse(this, getState()); } @Override public void changeVariables(Object source, Map<String, Object> variables) { // TODO Auto-generated method stub } @Override public void setDragImageProvider(DragImageProvider provider) { this.dragImageProvider = provider; markAsDirty(); } @Override public DragImageProvider getDragImageProvider() { return this.dragImageProvider; } }