io.jmix.ui.widget.client.addon.dragdroplayouts.ui.formlayout

Class VDDFormLayout

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

com.vaadin.client.ui.VFormLayout

io.jmix.ui.widget.client.addon.dragdroplayouts.ui.formlayout.VDDFormLayout

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.AcceptsOneWidget, com.google.gwt.user.client.ui.HasOneWidget, 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.IsWidget, com.vaadin.client.ui.dd.VHasDropHandler, VDDHasDropHandler<VDDFormLayoutDropHandler>, VHasDragCaptionProvider, VHasDragFilter, VHasDragImageReferenceSupport, VHasDragMode, VHasGrabFilter, VHasIframeShims, VLayoutDragDropMouseHandler.DragStartListener, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>

public class VDDFormLayout
extends com.vaadin.client.ui.VFormLayout
implements VHasDragMode, VDDHasDropHandler<VDDFormLayoutDropHandler>, VLayoutDragDropMouseHandler.DragStartListener, VHasDragFilter, VHasIframeShims, VHasDragImageReferenceSupport, VHasGrabFilter, VHasDragCaptionProvider

Client side implementation for DDFormLayout

Since:

0.4.0

Nested Class Summary

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

com.vaadin.client.ui.VFormLayout.Caption, com.vaadin.client.ui.VFormLayout.ErrorFlag, com.vaadin.client.ui.VFormLayout.VFormLayoutTable

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

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vaadin.client.ApplicationConnection	client
static java.lang.String	OVER
static java.lang.String	OVER_SPACED

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

table

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
VDDFormLayout()

Method Summary

Modifier and Type	Method and Description
protected void	deEmphasis() Removes any applies drag and drop style applied by emphasis()
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.ui.Widget widget, com.vaadin.client.ui.dd.VDragEvent event) Empasises the drop location of the component when hovering over a ĆhildComponentContainer.
float	getCellTopBottomDropRatio()
VDragCaptionProvider	getDragCaptionProvider()
VDragFilter	getDragFilter() Returns the drag filter used by the layout
LayoutDragMode	getDragMode() Returns the current drag mode which determines how the drag is visualized
VDDFormLayoutDropHandler	getDropHandler() Get the drop handler attached to the Layout
VGrabFilter	getGrabFilter()
protected VLayoutDragDropMouseHandler	getMouseHandler()
static com.google.gwt.dom.client.Element	getRowFromChildElement(com.google.gwt.dom.client.Element e, com.google.gwt.dom.client.Element root)
protected com.vaadin.shared.ui.dd.VerticalDropLocation	getVerticalDropLocation(com.google.gwt.dom.client.Element rowElement, com.vaadin.client.ui.dd.VDragEvent event) Returns the horizontal location within the cell when hoovering over the cell.
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	setCellTopBottomDropRatio(float cellTopBottomDropRatio)
void	setDragCaptionProvider(VDragCaptionProvider dragCaption)
void	setDragFilter(VDragFilter filter)
void	setDragImageProvider(VDragImageProvider provider)
void	setDragMode(LayoutDragMode mode)
void	setDropHandler(VDDFormLayoutDropHandler handler)
void	setGrabFilter(VGrabFilter grabFilter)
protected void	updateDragDetails(com.google.gwt.user.client.ui.Widget widget, com.vaadin.client.ui.dd.VDragEvent event) Updates the drop details while dragging.

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

add, getContainerElement, getWidget, iterator, remove, setWidget, setWidget

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

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

forEach, spliterator

Field Detail

OVER

public static final java.lang.String OVER

See Also:

Constant Field Values

OVER_SPACED

public static final java.lang.String OVER_SPACED

See Also:

Constant Field Values

client

protected com.vaadin.client.ApplicationConnection client

Constructor Detail

VDDFormLayout

public VDDFormLayout()

Method Detail

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

deEmphasis

protected void deEmphasis()

Removes any applies drag and drop style applied by emphasis()

getVerticalDropLocation

protected com.vaadin.shared.ui.dd.VerticalDropLocation getVerticalDropLocation(com.google.gwt.dom.client.Element rowElement,
                                                                               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:

rowElement - The row

event - The drag event

Returns:

The horizontal drop location

getRowFromChildElement

public static com.google.gwt.dom.client.Element getRowFromChildElement(com.google.gwt.dom.client.Element e,
                                                                       com.google.gwt.dom.client.Element root)

updateDragDetails

protected void updateDragDetails(com.google.gwt.user.client.ui.Widget widget,
                                 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:

widget - The container which we are hovering over

event - The drag event

emphasis

protected void emphasis(com.google.gwt.user.client.ui.Widget widget,
                        com.vaadin.client.ui.dd.VDragEvent event)

Empasises the drop location of the component when hovering over a ĆhildComponentContainer. Passing null as the container removes any previous emphasis.

Parameters:

widget - The container which we are hovering over

event - The drag event

getDragMode

public LayoutDragMode getDragMode()

Returns the current drag mode which determines how the drag is visualized

Specified by:

getDragMode in interface VHasDragMode

Returns:

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.

getDropHandler

public VDDFormLayoutDropHandler getDropHandler()

Get the drop handler attached to the Layout

Specified by:

getDropHandler in interface com.vaadin.client.ui.dd.VHasDropHandler

Specified by:

getDropHandler in interface VDDHasDropHandler<VDDFormLayoutDropHandler>

setDropHandler

public void setDropHandler(VDDFormLayoutDropHandler handler)

Specified by:

setDropHandler in interface VDDHasDropHandler<VDDFormLayoutDropHandler>

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

getCellTopBottomDropRatio

public float getCellTopBottomDropRatio()

setCellTopBottomDropRatio

public void setCellTopBottomDropRatio(float cellTopBottomDropRatio)

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