io.jmix.ui.widget.addon.dragdroplayouts

Class DDFormLayout

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractComponentContainer

com.vaadin.ui.AbstractLayout

com.vaadin.ui.AbstractOrderedLayout

com.vaadin.ui.FormLayout

io.jmix.ui.widget.addon.dragdroplayouts.DDFormLayout

All Implemented Interfaces:

com.vaadin.event.ConnectorEventListener, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.dd.DragSource, com.vaadin.event.dd.DropTarget, com.vaadin.event.LayoutEvents.LayoutClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.event.SerializableEventListener, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.server.VariableOwner, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.HasContextHelp, com.vaadin.ui.ComponentContainer, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.Layout, com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler, com.vaadin.ui.LegacyComponent, DragFilterSupport, DragGrabFilterSupport, DragImageReferenceSupport, HasDragCaptionProvider, LayoutDragSource, ShimSupport, java.io.Serializable, java.lang.Iterable<com.vaadin.ui.Component>, java.util.EventListener

public class DDFormLayout
extends com.vaadin.ui.FormLayout
implements LayoutDragSource, com.vaadin.event.dd.DropTarget, ShimSupport, com.vaadin.ui.LegacyComponent, DragFilterSupport, DragImageReferenceSupport, DragGrabFilterSupport, HasDragCaptionProvider

Form layout with support for drag and drop

Since:

0.8.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DDFormLayout.FormLayoutTargetDetails Contains the component over which the drop was made and the index on which the drop was made.

Nested classes/interfaces inherited from class com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractClientConnector.IncorrectConcurrentAccessHandler

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.HasContextHelp, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.ui.Layout

com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Component.HasContextHelp

com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickEvent, com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickListener

Field Summary

Fields inherited from class com.vaadin.ui.AbstractOrderedLayout

ALIGNMENT_DEFAULT, components

Fields inherited from class com.vaadin.ui.AbstractComponent

componentErrorProvider, DESIGN_ATTR_PLAIN_TEXT, requiredError

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
DDFormLayout() Construct a new form layout
DDFormLayout(com.vaadin.ui.Component... components) Construct a new form layout with children

Method Summary

Modifier and Type	Method and Description
void	beforeClientResponse(boolean initial)
void	changeVariables(java.lang.Object source, java.util.Map<java.lang.String,java.lang.Object> variables)
DragCaptionProvider	getDragCaptionProvider()
DragFilter	getDragFilter() Get a filter which determines which components can be dragged from the layout and which cannot.
DragGrabFilter	getDragGrabFilter()
DragImageProvider	getDragImageProvider() Returns the drag image provider
LayoutDragMode	getDragMode() Returns the mode of which dragging is visualized.
com.vaadin.event.dd.DropHandler	getDropHandler() Returns the drop handler which handles drop events from dropping components on the layout.
DDFormLayoutState	getState()
com.vaadin.event.Transferable	getTransferable(java.util.Map<java.lang.String,java.lang.Object> rawVariables) Get the transferable created by a drag event.
boolean	isShimmed() Are shims used over iframes so dragging is possible
void	paintContent(com.vaadin.server.PaintTarget target)
void	setComponentVerticalDropRatio(float ratio) Sets the ratio which determines how a cell is divided into drop zones.
void	setDragCaptionProvider(DragCaptionProvider provider)
void	setDragFilter(DragFilter dragFilter) Set a filter which determines which components can be dragged from the layout and which cannot.
void	setDragGrabFilter(DragGrabFilter dragGrabFilter)
void	setDragImageProvider(DragImageProvider provider) Set a component as a drag image for a component in the layout.
void	setDragMode(LayoutDragMode mode) Enables dragging components from the layout.
void	setDropHandler(com.vaadin.event.dd.DropHandler dropHandler) Sets the current handler which handles dropped components on the layout.
void	setShim(boolean shim) False to disable the iframe shim used to enable dragging iframe based components (defaults to true).
com.vaadin.event.dd.TargetDetails	translateDropTargetDetails(java.util.Map<java.lang.String,java.lang.Object> clientVariables)

Methods inherited from class com.vaadin.ui.FormLayout

getExpandRatio, getState, setExpandRatio

Methods inherited from class com.vaadin.ui.AbstractOrderedLayout

addComponent, addComponent, addComponentAsFirst, addLayoutClickListener, getComponent, getComponentAlignment, getComponentCount, getComponentIndex, getCustomAttributes, getDefaultComponentAlignment, getMargin, isSpacing, iterator, readDesign, removeComponent, removeLayoutClickListener, replaceComponent, setComponentAlignment, setDefaultComponentAlignment, setMargin, setMargin, setSpacing, writeDesign

Methods inherited from class com.vaadin.ui.AbstractLayout

isRequiredIndicatorVisible, readMargin, setRequiredIndicatorVisible, writeMargin

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

addComponentAttachListener, addComponentDetachListener, addComponents, fireComponentAttachEvent, fireComponentDetachEvent, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponentAttachListener, removeComponentDetachListener, setHeight, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addContextHelpIconClickListener, addListener, addShortcutListener, addStyleName, attach, detach, ensureContextHelpInitialized, findAncestor, fireComponentErrorEvent, fireComponentEvent, fireContextHelpClick, focus, getActionManager, getCaption, getComponentError, getComponentErrorProvider, getContextHelpText, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getJTestId, getLocale, getParent, getPrimaryStyleName, getRequiredError, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isContextHelpTextHtmlEnabled, isEnabled, isOrHasAncestor, isReadOnly, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setComponentErrorProvider, setContextHelpText, setContextHelpTextHtmlEnabled, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setJTestId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredError, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidthFull, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getIncorrectConcurrentAccessHandler, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setConnectorResource, setErrorHandler, setIncorrectConcurrentAccessHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getJTestId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setJTestId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

Methods inherited from interface com.vaadin.ui.LegacyComponent

markAsDirty

Methods inherited from interface com.vaadin.server.VariableOwner

isEnabled

Methods inherited from interface com.vaadin.ui.ComponentContainer

addComponents, getComponentIterator, moveComponentsFrom, removeAllComponents

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier

addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener

Constructor Detail

DDFormLayout

public DDFormLayout()

Construct a new form layout

DDFormLayout

public DDFormLayout(com.vaadin.ui.Component... components)

Construct a new form layout with children

Parameters:

components - the child components of the layout

Method Detail

getDragGrabFilter

@Nullable
public DragGrabFilter getDragGrabFilter()

Specified by:

getDragGrabFilter in interface DragGrabFilterSupport

Returns:

Drag grab filter

setDragGrabFilter

public void setDragGrabFilter(@Nullable
                              DragGrabFilter dragGrabFilter)

Specified by:

setDragGrabFilter in interface DragGrabFilterSupport

Parameters:

dragGrabFilter - drag grab filter

setDragCaptionProvider

public void setDragCaptionProvider(@Nullable
                                   DragCaptionProvider provider)

Specified by:

setDragCaptionProvider in interface HasDragCaptionProvider

getDragCaptionProvider

@Nullable
public DragCaptionProvider getDragCaptionProvider()

Specified by:

getDragCaptionProvider in interface HasDragCaptionProvider

paintContent

public void paintContent(com.vaadin.server.PaintTarget target)
                  throws com.vaadin.server.PaintException

Specified by:

paintContent in interface com.vaadin.ui.LegacyComponent

Throws:

com.vaadin.server.PaintException

translateDropTargetDetails

public com.vaadin.event.dd.TargetDetails translateDropTargetDetails(java.util.Map<java.lang.String,java.lang.Object> clientVariables)

Specified by:

translateDropTargetDetails in interface com.vaadin.event.dd.DropTarget

getTransferable

public com.vaadin.event.Transferable getTransferable(java.util.Map<java.lang.String,java.lang.Object> rawVariables)

Get the transferable created by a drag event.

Specified by:

getTransferable in interface com.vaadin.event.dd.DragSource

getDropHandler

public com.vaadin.event.dd.DropHandler getDropHandler()

Returns the drop handler which handles drop events from dropping components on the layout. Returns Null if dropping is disabled.

Specified by:

getDropHandler in interface com.vaadin.event.dd.DropTarget

setDropHandler

public void setDropHandler(com.vaadin.event.dd.DropHandler 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.

Parameters:

dropHandler - The drop handler to handle drop events or null to disable dropping

getDragMode

public LayoutDragMode getDragMode()

Returns the mode of which dragging is visualized.

Specified by:

getDragMode in interface LayoutDragSource

Returns:

setDragMode

public void setDragMode(LayoutDragMode mode)

Enables dragging components from the layout.

Specified by:

setDragMode in interface LayoutDragSource

Parameters:

mode - The mode of which how the dragging should be visualized.

setComponentVerticalDropRatio

public void setComponentVerticalDropRatio(float ratio)

Sets the ratio which determines how a cell is divided into drop zones. The ratio is measured from the top and bottom 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.

Parameters:

ratio - A ratio between 0 and 0.5. Default is 0.2

setShim

public void setShim(boolean shim)

False to disable the iframe shim used to enable dragging iframe based components (defaults to true).

Specified by:

setShim in interface ShimSupport

Parameters:

shim - Are the iframes shimmed

isShimmed

public boolean isShimmed()

Are shims used over iframes so dragging is possible

Specified by:

isShimmed in interface ShimSupport

Returns:

Are the iframes shimmed

getDragFilter

public DragFilter getDragFilter()

Get a filter which determines which components can be dragged from the layout and which cannot. This does not effect the drag mode, but only provides a means to make exceptions in the drag mode. The drag filter is only used when dragging is enabled in the layout, i.e drag mode is NOT LayoutDragMode.NONE By default the drag filter permits dragging all components when the layout drag mode allows it.

Specified by:

getDragFilter in interface DragFilterSupport

Specified by:

getDragFilter in interface LayoutDragSource

Returns:

dragFilter The filter to use, by default DragFilter.ALL is used.

setDragFilter

public void setDragFilter(DragFilter dragFilter)

Set a filter which determines which components can be dragged from the layout and which cannot. This does not effect the drag mode, but only provides a means to make exceptions in the drag mode. The drag filter is only used when dragging is enabled in the layout, i.e drag mode is NOT LayoutDragMode.NONE By default the drag filter permits dragging all components when the layout drag mode allows it.

Specified by:

setDragFilter in interface DragFilterSupport

Specified by:

setDragFilter in interface LayoutDragSource

Parameters:

dragFilter - The filter to use, by default DragFilter.ALL is used.

getState

public DDFormLayoutState getState()

Overrides:

getState in class com.vaadin.ui.FormLayout

beforeClientResponse

public void beforeClientResponse(boolean initial)

Specified by:

beforeClientResponse in interface com.vaadin.server.ClientConnector

Overrides:

beforeClientResponse in class com.vaadin.ui.AbstractComponent

changeVariables

public void changeVariables(java.lang.Object source,
                            java.util.Map<java.lang.String,java.lang.Object> variables)

Specified by:

changeVariables in interface com.vaadin.server.VariableOwner

setDragImageProvider

public void setDragImageProvider(@Nullable
                                 DragImageProvider provider)

Description copied from interface: DragImageReferenceSupport

Set a component as a drag image for a component in the layout. The drag image will be shown instead of the component when the user drag a component in the layout.

Specified by:

setDragImageProvider in interface DragImageReferenceSupport

Parameters:

provider - The image provider

getDragImageProvider

@Nullable
public DragImageProvider getDragImageProvider()

Description copied from interface: DragImageReferenceSupport

Returns the drag image provider

Specified by:

getDragImageProvider in interface DragImageReferenceSupport

Returns:

the image provider