io.jmix.ui.widget.addon.dragdroplayouts.interfaces

Interface LayoutDragSource

All Superinterfaces:

com.vaadin.server.ClientConnector, com.vaadin.ui.Component, com.vaadin.shared.Connector, com.vaadin.event.dd.DragSource, java.io.Serializable, com.vaadin.server.Sizeable

All Known Implementing Classes:

DDAbsoluteLayout, DDAccordion, DDCssLayout, DDFormLayout, DDGridLayout, DDHorizontalLayout, DDHorizontalLayout, DDHorizontalSplitPanel, DDPanel, DDTabSheet, DDVerticalLayout, DDVerticalLayout, DDVerticalSplitPanel, JmixMainTabSheet

public interface LayoutDragSource
extends com.vaadin.event.dd.DragSource

Interface for layout drag sources

Since:

0.6.0

Nested Class Summary

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

Field Summary

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

Method Summary

Modifier and Type	Method and Description
DragFilter	getDragFilter() Get a filter which determines which components can be dragged from the layout and which cannot.
LayoutDragMode	getDragMode() Gets the drag mode which controls how drags can be made.
void	setDragFilter(DragFilter dragFilter) Set a filter which determines which components can be dragged from the layout and which cannot.
void	setDragMode(LayoutDragMode mode) Sets the drag mode which controls how drags can be made.

Methods inherited from interface com.vaadin.event.dd.DragSource

getTransferable

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, beforeClientResponse, 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

Method Detail

getDragMode

LayoutDragMode getDragMode()

Gets the drag mode which controls how drags can be made. The layout supports two modes, NONE which disables dragging from the layout and CLONE which enables dragging the component from the layout.

Returns:

The drag mode

setDragMode

void setDragMode(LayoutDragMode mode)

Sets the drag mode which controls how drags can be made. The layout supports two modes, NONE which disables dragging from the layout and CLONE which enables dragging the component from the layout.

Parameters:

mode - The mode to set

getDragFilter

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.

Returns:

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

setDragFilter

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.

Parameters:

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