Package io.jmix.ui.widget.client.addon.dragdroplayouts.ui.csslayout

Class VDDCssLayout

java.lang.Object
com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.google.gwt.user.client.ui.Panel
com.google.gwt.user.client.ui.ComplexPanel
com.google.gwt.user.client.ui.FlowPanel
com.vaadin.client.ui.VCssLayout
io.jmix.ui.widget.client.addon.dragdroplayouts.ui.csslayout.VDDCssLayout
All Implemented Interfaces:
com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.InsertPanel, com.google.gwt.user.client.ui.InsertPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, com.vaadin.client.ui.dd.VHasDropHandler, VDDHasDropHandler<VDDCssLayoutDropHandler>, VHasDragCaptionProvider, VHasDragFilter, VHasDragImageReferenceSupport, VHasDragMode, VHasGrabFilter, VHasIframeShims, VLayoutDragDropMouseHandler.DragStartListener, Iterable<com.google.gwt.user.client.ui.Widget>
public class VDDCssLayout extends com.vaadin.client.ui.VCssLayout implements VHasDragMode, VDDHasDropHandler<VDDCssLayoutDropHandler>, VLayoutDragDropMouseHandler.DragStartListener, VHasDragFilter, VHasIframeShims, VHasDragImageReferenceSupport, VHasGrabFilter, VHasDragCaptionProvider
Client side implementation for DDCssLayout
Since:
0.7.0

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

    com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

    Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

    com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

    Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

    com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

    Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.InsertPanel

    com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DRAG_SHADOW_STYLE_NAME
     

    Fields inherited from class com.vaadin.client.ui.VCssLayout

    CLASSNAME

    Fields inherited from class com.google.gwt.user.client.ui.UIObject

    DEBUG_ID_PREFIX

  • Constructor Summary

    Constructors
    Constructor
    Description
    VDDCssLayout()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    attachDragImageToLayout(com.vaadin.client.ui.dd.VDragEvent drag)
     
    void
    detachDragImageFromLayout(com.vaadin.client.ui.dd.VDragEvent drag)
     
    boolean
    dragStart(com.google.gwt.user.client.ui.Widget widget, LayoutDragMode mode)
    Can be used to listen to drag start events, must return true for the drag to commence.
    VDragCaptionProvider
    getDragCaptionProvider()
     
    VDragFilter
    getDragFilter()
    Returns the drag filter used by the layout
    LayoutDragMode
    getDragMode()
    Returns the drag mode
    VDDCssLayoutDropHandler
    getDropHandler()
    Returns the drop handler which handles the drop events
    VGrabFilter
    getGrabFilter()
     
    protected com.vaadin.shared.ui.dd.HorizontalDropLocation
    getHorizontalDropLocation(com.google.gwt.user.client.ui.Widget container, com.vaadin.client.ui.dd.VDragEvent event)
    Returns the horizontal location within the cell when hoovering over the cell.
    double
    getHorizontalDropRatio()
     
    protected final VLayoutDragDropMouseHandler
    getMouseHandler()
     
    protected com.vaadin.shared.ui.dd.VerticalDropLocation
    getVerticalDropLocation(com.google.gwt.user.client.ui.Widget container, com.vaadin.client.ui.dd.VDragEvent event)
    Returns the horizontal location within the cell when hoovering over the cell.
    double
    getVerticalDropRatio()
     
    void
    iframeShimsEnabled(boolean enabled)
     
    boolean
    isIframeShimsEnabled()
     
    protected void
    onLoad()
     
    protected void
    onUnload()
     
    protected boolean
    postDropHook(com.vaadin.client.ui.dd.VDragEvent drag)
    A hook for extended components to post process the the drop before it is sent to the server.
    protected void
    postEnterHook(com.vaadin.client.ui.dd.VDragEvent drag)
    A hook for extended components to post process the the enter event.
    protected void
    postLeaveHook(com.vaadin.client.ui.dd.VDragEvent drag)
    A hook for extended components to post process the the leave event.
    protected void
    postOverHook(com.vaadin.client.ui.dd.VDragEvent drag)
    A hook for extended components to post process the the over event.
    void
    setDragCaptionProvider(VDragCaptionProvider dragCaption)
     
    void
    setDragFilter(VDragFilter filter)
     
    void
    setDragImageProvider(VDragImageProvider provider)
     
    void
    setDragMode(LayoutDragMode mode)
     
    void
    setDropHandler(VDDCssLayoutDropHandler dropHandler)
     
    void
    setGrabFilter(VGrabFilter grabFilter)
     
    void
    setHorizontalDropRatio(float horizontalDropRatio)
     
    void
    setVerticalDropRatio(float verticalDropRatio)
     
    void
    updateDrag(com.vaadin.client.ui.dd.VDragEvent drag)
     
    protected void
    updateDragDetails(com.vaadin.client.ui.dd.VDragEvent event)
    Updates the drop details while dragging.

    Methods inherited from class com.vaadin.client.ui.VCssLayout

    addOrMove

    Methods inherited from class com.google.gwt.user.client.ui.FlowPanel

    add, clear, insert, insert

    Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

    add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

    Methods inherited from class com.google.gwt.user.client.ui.Panel

    add, adopt, doAttachChildren, doDetachChildren, orphan, remove

    Methods inherited from class com.google.gwt.user.client.ui.Widget

    addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

    Methods inherited from class com.google.gwt.user.client.ui.UIObject

    addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel

    getWidget, getWidgetCount, getWidgetIndex, remove

    Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

    getWidgetIndex

    Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

    add

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

  • Field Details

  • Constructor Details

    • VDDCssLayout

      public VDDCssLayout()
      Default constructor

  • Method Details

    • dragStart

      public boolean dragStart(com.google.gwt.user.client.ui.Widget widget, LayoutDragMode mode)
      Can be used to listen to drag start events, must return true for the drag to commence. Return false to interrupt the drag:
      Specified by:
      dragStart in interface VLayoutDragDropMouseHandler.DragStartListener
      Parameters:
      widget - The widget which is about to be dragged
      mode - The draggin mode
      Returns:
      Should the dragging be commenced.

    • setDragCaptionProvider

      public void setDragCaptionProvider(VDragCaptionProvider dragCaption)
      Specified by:
      setDragCaptionProvider in interface VHasDragCaptionProvider

    • getDragCaptionProvider

      public VDragCaptionProvider getDragCaptionProvider()
      Specified by:
      getDragCaptionProvider in interface VHasDragCaptionProvider

    • getDropHandler

      public VDDCssLayoutDropHandler getDropHandler()
      Returns the drop handler which handles the drop events
      Specified by:
      getDropHandler in interface VDDHasDropHandler<VDDCssLayoutDropHandler>
      Specified by:
      getDropHandler in interface com.vaadin.client.ui.dd.VHasDropHandler

    • setDropHandler

      public void setDropHandler(VDDCssLayoutDropHandler dropHandler)
      Specified by:
      setDropHandler in interface VDDHasDropHandler<VDDCssLayoutDropHandler>

    • getDragMode

      public LayoutDragMode getDragMode()
      Returns the drag mode
      Specified by:
      getDragMode in interface VHasDragMode
      Returns:

    • onLoad

      protected void onLoad()
      Overrides:
      onLoad in class com.google.gwt.user.client.ui.Widget

    • onUnload

      protected void onUnload()
      Overrides:
      onUnload in class com.google.gwt.user.client.ui.Widget

    • postDropHook

      protected boolean postDropHook(com.vaadin.client.ui.dd.VDragEvent drag)
      A hook for extended components to post process the the drop before it is sent to the server. Useful if you don't want to override the whole drop handler.

    • postEnterHook

      protected void postEnterHook(com.vaadin.client.ui.dd.VDragEvent drag)
      A hook for extended components to post process the the enter event. Useful if you don't want to override the whole drophandler.

    • postLeaveHook

      protected void postLeaveHook(com.vaadin.client.ui.dd.VDragEvent drag)
      A hook for extended components to post process the the leave event. Useful if you don't want to override the whole drophandler.

    • postOverHook

      protected void postOverHook(com.vaadin.client.ui.dd.VDragEvent drag)
      A hook for extended components to post process the the over event. Useful if you don't want to override the whole drophandler.

    • attachDragImageToLayout

      public void attachDragImageToLayout(com.vaadin.client.ui.dd.VDragEvent drag)

    • detachDragImageFromLayout

      public void detachDragImageFromLayout(com.vaadin.client.ui.dd.VDragEvent drag)

    • updateDragDetails

      protected void updateDragDetails(com.vaadin.client.ui.dd.VDragEvent event)
      Updates the drop details while dragging. This is needed to ensure client side criterias can validate the drop location.
      Parameters:
      event - The drag event

    • updateDrag

      public void updateDrag(com.vaadin.client.ui.dd.VDragEvent drag)

    • getHorizontalDropLocation

      protected com.vaadin.shared.ui.dd.HorizontalDropLocation getHorizontalDropLocation(com.google.gwt.user.client.ui.Widget container, com.vaadin.client.ui.dd.VDragEvent event)
      Returns the horizontal location within the cell when hoovering over the cell. By default the cell is devided into three parts: left,center,right with the ratios 10%,80%,10%;
      Parameters:
      container - The widget container
      event - The drag event
      Returns:
      The horizontal drop location

    • getVerticalDropLocation

      protected com.vaadin.shared.ui.dd.VerticalDropLocation getVerticalDropLocation(com.google.gwt.user.client.ui.Widget container, com.vaadin.client.ui.dd.VDragEvent event)
      Returns the horizontal location within the cell when hoovering over the cell. By default the cell is devided into three parts: left,center,right with the ratios 10%,80%,10%;
      Parameters:
      container - The widget container
      event - The drag event
      Returns:
      The horizontal drop location

    • getDragFilter

      public VDragFilter getDragFilter()
      Description copied from interface: VHasDragFilter
      Returns the drag filter used by the layout
      Specified by:
      getDragFilter in interface VHasDragFilter
      Returns:

    • getHorizontalDropRatio

      public double getHorizontalDropRatio()

    • setHorizontalDropRatio

      public void setHorizontalDropRatio(float horizontalDropRatio)

    • getVerticalDropRatio

      public double getVerticalDropRatio()

    • setVerticalDropRatio

      public void setVerticalDropRatio(float verticalDropRatio)

    • setDragFilter

      public void setDragFilter(VDragFilter filter)
      Specified by:
      setDragFilter in interface VHasDragFilter

    • iframeShimsEnabled

      public void iframeShimsEnabled(boolean enabled)
      Specified by:
      iframeShimsEnabled in interface VHasIframeShims

    • isIframeShimsEnabled

      public boolean isIframeShimsEnabled()
      Specified by:
      isIframeShimsEnabled in interface VHasIframeShims

    • setDragMode

      public void setDragMode(LayoutDragMode mode)
      Specified by:
      setDragMode in interface VHasDragMode

    • setDragImageProvider

      public void setDragImageProvider(VDragImageProvider provider)
      Specified by:
      setDragImageProvider in interface VHasDragImageReferenceSupport

    • getMouseHandler

      protected final VLayoutDragDropMouseHandler getMouseHandler()

    • getGrabFilter

      public VGrabFilter getGrabFilter()
      Specified by:
      getGrabFilter in interface VHasGrabFilter

    • setGrabFilter

      public void setGrabFilter(VGrabFilter grabFilter)
      Specified by:
      setGrabFilter in interface VHasGrabFilter