com.sencha.gxt.dnd.core.client

Class StatusProxy

java.lang.Object

Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.dnd.core.client.StatusProxy

All Implemented Interfaces:

HasGestureRecognizers, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId

public class StatusProxy
extends Component

A custom widget used to display the status of the drag operation and information about the data being dragged. The widget is displayed next to the cursor as the user drags data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StatusProxy.StatusProxyAppearance

Field Summary

Fields inherited from class com.sencha.gxt.widget.core.client.Component

adjustSize, allowTextSelection, cacheSizes, disableContextMenu, disabled, disabledStyle, ensureVisibilityOnSizing, height, hidden, lastSize, layer, left, mask, maskMessage, monitorWindowResize, pageX, pageY, resizeHandler, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StatusProxy()
protected	StatusProxy(StatusProxy.StatusProxyAppearance appearance)

Method Summary

Modifier and Type	Method and Description
static StatusProxy	get() Returns the singleton instance.
StatusProxy.StatusProxyAppearance	getAppearance()
boolean	getStatus() Returns true if the drop is allowed.
void	setStatus(boolean allowed) Updates the proxy's visual element to indicate the status of whether or not drop is allowed over the current target element.
void	setStatus(boolean allowed, ImageResource icon) Updates the proxy's visual element to indicate the status of whether or not drop is allowed over the current target element.
void	update(SafeHtml html) Updates the contents of the ghost element.

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disable, disableContextMenu, disableEvents, enable, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getElement, getFocusEl, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, notifyHide, notifyShow, onAfterFirstAttach, onAttach, onBlur, onBrowserEvent, onDetach, onDisable, onEnable, onFocus, onHide, onHideContextMenu, onLoad, onPosition, onResize, onRightClick, onShow, onShowContextMenu, onTouch, onUnload, onWindowResize, removeStyleDependentName, removeStyleOnOver, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusProxy

protected StatusProxy()

StatusProxy

protected StatusProxy(StatusProxy.StatusProxyAppearance appearance)

Method Detail

get

public static StatusProxy get()

Returns the singleton instance.

Returns:

the status proxy

getAppearance

public StatusProxy.StatusProxyAppearance getAppearance()

getStatus

public boolean getStatus()

Returns true if the drop is allowed.

Returns:

the status

setStatus

public void setStatus(boolean allowed)

Updates the proxy's visual element to indicate the status of whether or not drop is allowed over the current target element.

Parameters:

allowed - true for the standard ok icon, false for standard no icon

setStatus

public void setStatus(boolean allowed,
                      ImageResource icon)

Updates the proxy's visual element to indicate the status of whether or not drop is allowed over the current target element.

Parameters:

allowed - drop is allowed

icon - icon to display

update

public void update(SafeHtml html)

Updates the contents of the ghost element.

Parameters:

html - the html that will replace the current contents of the ghost element