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

Class VDDVerticalSplitPanel

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.vaadin.client.ui.VAbstractSplitPanel
com.vaadin.client.ui.VSplitPanelVertical
io.jmix.ui.widget.client.addon.dragdroplayouts.ui.verticalsplitpanel.VDDVerticalSplitPanel
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.IsWidget, com.vaadin.client.ui.dd.VHasDropHandler, VDDHasDropHandler<VDDVerticalSplitPanelDropHandler>, VHasDragCaptionProvider, VHasDragFilter, VHasDragImageReferenceSupport, VHasDragMode, VHasGrabFilter, VHasIframeShims, VLayoutDragDropMouseHandler.DragStartListener, Iterable<com.google.gwt.user.client.ui.Widget>
public class VDDVerticalSplitPanel extends com.vaadin.client.ui.VSplitPanelVertical implements VHasDragMode, VDDHasDropHandler<VDDVerticalSplitPanelDropHandler>, VLayoutDragDropMouseHandler.DragStartListener, VHasDragFilter, VHasDragImageReferenceSupport, VHasIframeShims, VHasGrabFilter, VHasDragCaptionProvider
Client side implementation for DDVerticalSplitPanel
Since:
0.4.0

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.vaadin.client.ui.VAbstractSplitPanel

    com.vaadin.client.ui.VAbstractSplitPanel.SplitterMoveHandler

    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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    OVER
     
    static final String
    OVER_SPLITTER
     

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

    CLASSNAME, client, componentStyleNames, maximumPosition, minimumPosition, origScrollTop, position, scrolledContainer

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

    DEBUG_ID_PREFIX

  • Constructor Summary

    Constructors
    Constructor
    Description
    VDDVerticalSplitPanel()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    constructDom()
     
    protected void
    deEmphasis()
    Removes any previous emphasis made by drag&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.
    protected void
    emphasis(com.google.gwt.user.client.Element element)
    Emphasisizes a container element
    VDragCaptionProvider
    getDragCaptionProvider()
     
    VDragFilter
    getDragFilter()
    Returns the drag filter used by the layout
    LayoutDragMode
    getDragMode()
    Returns the drag mode
    VDDVerticalSplitPanelDropHandler
    getDropHandler()
     
    protected com.google.gwt.user.client.Element
    getFirstContainer()
    Returns the container element which wraps the first (left-most) component
    VGrabFilter
    getGrabFilter()
     
    protected final VLayoutDragDropMouseHandler
    getMouseHandler()
     
    protected com.google.gwt.user.client.Element
    getSecondContainer()
    Returns the container element which wraps the second (right-most) component
    protected com.google.gwt.user.client.Element
    getSplitter()
    Returns the splitter element
    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(VDDVerticalSplitPanelDropHandler handler)
     
    void
    setGrabFilter(VGrabFilter grabFilter)
     
    protected void
    updateDragDetails(com.vaadin.client.ui.dd.VDragEvent event)
    Updates the drop details while dragging.

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

    startResize, stopResize

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

    checkSplitPositionLimits, getFirstWidget, getSecondWidget, getSplitterPosition, getSplitterSize, isEnabled, makeScrollable, onBrowserEvent, onMouseDown, onMouseMove, onMouseUp, remove, setEnabled, setFirstWidget, setLocked, setPositionReversed, setSecondWidget, setSplitPosition, setStylenames, updateSizes

    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

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

    add, add, adopt, clear, 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, 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 java.lang.Iterable

    forEach, spliterator

  • Field Details

  • Constructor Details

    • VDDVerticalSplitPanel

      public VDDVerticalSplitPanel()

  • Method Details

    • setDragCaptionProvider

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

    • getDragCaptionProvider

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

    • 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

    • constructDom

      protected void constructDom()
      Overrides:
      constructDom in class com.vaadin.client.ui.VAbstractSplitPanel

    • 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.

    • 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.

    • setDropHandler

      public void setDropHandler(VDDVerticalSplitPanelDropHandler handler)
      Specified by:
      setDropHandler in interface VDDHasDropHandler<VDDVerticalSplitPanelDropHandler>

    • getDropHandler

      public VDDVerticalSplitPanelDropHandler getDropHandler()
      Specified by:
      getDropHandler in interface VDDHasDropHandler<VDDVerticalSplitPanelDropHandler>
      Specified by:
      getDropHandler in interface com.vaadin.client.ui.dd.VHasDropHandler

    • getDragMode

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

    • emphasis

      protected void emphasis(com.google.gwt.user.client.Element element)
      Emphasisizes a container element
      Parameters:
      element -

    • deEmphasis

      protected void deEmphasis()
      Removes any previous emphasis made by drag&drag

    • getFirstContainer

      protected com.google.gwt.user.client.Element getFirstContainer()
      Returns the container element which wraps the first (left-most) component
      Overrides:
      getFirstContainer in class com.vaadin.client.ui.VAbstractSplitPanel
      Returns:

    • getSecondContainer

      protected com.google.gwt.user.client.Element getSecondContainer()
      Returns the container element which wraps the second (right-most) component
      Overrides:
      getSecondContainer in class com.vaadin.client.ui.VAbstractSplitPanel
      Returns:

    • getSplitter

      protected com.google.gwt.user.client.Element getSplitter()
      Returns the splitter element
      Returns:

    • 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

    • getDragFilter

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

    • 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