com.extjs.gxt.ui.client.fx
Class Draggable

java.lang.Object
  com.extjs.gxt.ui.client.event.BaseObservable
      com.extjs.gxt.ui.client.fx.Draggable

All Implemented Interfaces:

Observable

public class Draggable
extends BaseObservable

Adds drag behavior to any widget. Drag operations can be initiated from the widget itself, or another widget, such as the header in a dialog.

It is possible to specify event targets that will be ignored. If the target element has a 'my-nodrag' style it will not trigger a drag operation.

Events:

DragStart : DragEvent(draggable, component, event)
Fires after a drag has started.

• draggable : this
• component : drag component
• event : the dom event

DragMove : DragEvent(draggable, component, event)
Fires after the mouse moves.

• draggable : this
• component : drag component
• event : the dom event

DragCancel : DragEvent(draggable, component, event)
Fires after a drag has been cancelled.

• draggable : this
• component : drag component
• event : the dom event

DragEnd : DragEvent(draggable, component, event)
Fires after a drag has ended.

• draggable : this
• component : drag widget
• event : the dom event

Constructor Summary

Draggable(Component dragComponent)
Creates a new draggable instance.

Draggable(Component dragComponent, Component handle)
Create a new draggable instance.

Method Summary

void	addDragListener(DragListener listener) Adds a listener to receive drag events.
void	cancelDrag() Cancels the drag if running.
Component	getContainer() Returns the drag container.
Component	getDragHandle() Returns the drag handle.
Component	getDragWidget() Returns the widget being dragged.
java.lang.String	getProxyStyle() Returns the proxy style.
boolean	isConstrainClient() Returns true if drag is constrained to the viewport.
boolean	isConstrainHorizontal() Returns true if horizontal movement is contstrained.
boolean	isConstrainVertical() Returns true if vertical movement is constrained.
boolean	isDragging() Returns true if a drag is in progress.
boolean	isMoveAfterProxyDrag() Returns true if the drag widget is moved after a proxy drag.
boolean	isSizeProxyToSource() Returns true if the proxy element is sized to match the drag widget.
boolean	isUpdateZIndex() Returns true if the z-index is updated after a drag.
boolean	isUseProxy() Returns true if proxy element is enabled.
void	removeDragListener(DragListener listener) Removes a previously added listener.
void	setConstrainClient(boolean constrainClient) True to set constrain movement to the viewport (defaults to true).
void	setConstrainHorizontal(boolean constrainHorizontal) True to stop horizontal movement (defaults to false).
void	setConstrainVertical(boolean constrainVertical) True to stop vertical movement (defaults to false).
void	setContainer(Component container) Specifies a container to which the drag widget is constrained.
void	setEnabled(boolean enabled) Enables dragging if the argument is true, and disables it otherwise.
void	setMoveAfterProxyDrag(boolean moveAfterProxyDrag) True to move source widget after a proxy drag (defaults to true).
void	setProxy(com.google.gwt.user.client.Element element) Sets the proxy element.
void	setProxyStyle(java.lang.String proxyStyle) Sets the style name used for proxy drags (defaults to 'my-drag-proxy').
void	setSizeProxyToSource(boolean sizeProxyToSource) True to set proxy dimensions the same as the drag widget (defaults to true).
void	setUpdateZIndex(boolean updateZIndex) True if the CSS z-index should be updated on the widget being dragged.
void	setUseProxy(boolean useProxy) True to use a proxy widget during drag operation (defaults to true).
void	setXConstraint(int left, int right) Constrains the horizontal travel.
void	setYConstraint(int top, int bottom) Constrains the vertical travel.

Methods inherited from class com.extjs.gxt.ui.client.event.BaseObservable

addListener, fireEvent, fireEvent, getFiresEvents, hasListeners, hasListeners, removeAllListeners, removeListener, setFiresEvents

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Draggable

public Draggable(Component dragComponent)

Creates a new draggable instance.

Parameters:

dragComponent - the component to be dragged

Draggable

public Draggable(Component dragComponent,
                 Component handle)

Create a new draggable instance.

Parameters:

dragComponent - the component to be dragged

handle - the component drags will be initiated from

Method Detail

addDragListener

public void addDragListener(DragListener listener)

Adds a listener to receive drag events.

Parameters:

listener - the drag listener to be added

cancelDrag

public void cancelDrag()

Cancels the drag if running.

getContainer

public Component getContainer()

Returns the drag container.

Returns:

the drag container

getDragHandle

public Component getDragHandle()

Returns the drag handle.

Returns:

the drag handle

getDragWidget

public Component getDragWidget()

Returns the widget being dragged.

Returns:

the drag widget

getProxyStyle

public java.lang.String getProxyStyle()

Returns the proxy style.

Returns:

the proxy style

isConstrainClient

public boolean isConstrainClient()

Returns true if drag is constrained to the viewport.

Returns:

the contstrain client state

isConstrainHorizontal

public boolean isConstrainHorizontal()

Returns true if horizontal movement is contstrained.

Returns:

the horizontal constrain state

isConstrainVertical

public boolean isConstrainVertical()

Returns true if vertical movement is constrained.

Returns:

true if vertical movement constrainer

isDragging

public boolean isDragging()

Returns true if a drag is in progress.

Returns:

the drag state

isMoveAfterProxyDrag

public boolean isMoveAfterProxyDrag()

Returns true if the drag widget is moved after a proxy drag.

Returns:

the move after proxy state

isSizeProxyToSource

public boolean isSizeProxyToSource()

Returns true if the proxy element is sized to match the drag widget.

Returns:

the size proxy to source state

isUpdateZIndex

public boolean isUpdateZIndex()

Returns true if the z-index is updated after a drag.

Returns:

the update z-index state

isUseProxy

public boolean isUseProxy()

Returns true if proxy element is enabled.

Returns:

the use proxy state

removeDragListener

public void removeDragListener(DragListener listener)

Removes a previously added listener.

Parameters:

listener - the listener to be removed

setConstrainClient

public void setConstrainClient(boolean constrainClient)

True to set constrain movement to the viewport (defaults to true).

Parameters:

constrainClient - true to constrian to viewport

setConstrainHorizontal

public void setConstrainHorizontal(boolean constrainHorizontal)

True to stop horizontal movement (defaults to false).

Parameters:

constrainHorizontal - true to stop horizontal movement

setConstrainVertical

public void setConstrainVertical(boolean constrainVertical)

True to stop vertical movement (defaults to false).

Parameters:

constrainVertical - true to stop vertical movement

setContainer

public void setContainer(Component container)

Specifies a container to which the drag widget is constrained.

Parameters:

container - the container

setEnabled

public void setEnabled(boolean enabled)

Enables dragging if the argument is true, and disables it otherwise.

Parameters:

enabled - the new enabled state

setMoveAfterProxyDrag

public void setMoveAfterProxyDrag(boolean moveAfterProxyDrag)

True to move source widget after a proxy drag (defaults to true).

Parameters:

moveAfterProxyDrag - true to move after a proxy drag

setProxy

public void setProxy(com.google.gwt.user.client.Element element)

Sets the proxy element.

Parameters:

element - the proxy element

setProxyStyle

public void setProxyStyle(java.lang.String proxyStyle)

Sets the style name used for proxy drags (defaults to 'my-drag-proxy').

Parameters:

proxyStyle - the proxy style

setSizeProxyToSource

public void setSizeProxyToSource(boolean sizeProxyToSource)

True to set proxy dimensions the same as the drag widget (defaults to true).

Parameters:

sizeProxyToSource - true to update proxy size

setUpdateZIndex

public void setUpdateZIndex(boolean updateZIndex)

True if the CSS z-index should be updated on the widget being dragged. Setting this value to true will ensure that the dragged element is always displayed over all other widgets (defaults to true).

Parameters:

updateZIndex - true update the z-index

setUseProxy

public void setUseProxy(boolean useProxy)

True to use a proxy widget during drag operation (defaults to true).

Parameters:

useProxy - true use a proxy

setXConstraint

public void setXConstraint(int left,
                           int right)

Constrains the horizontal travel.

Parameters:

left - the number of pixels the element can move to the left

right - the number of pixels the element can move to the right

setYConstraint

public void setYConstraint(int top,
                           int bottom)

Constrains the vertical travel.

Parameters:

top - the number of pixels the element can move to the up

bottom - the number of pixels the element can move to the down