com.extjs.gxt.ui.client.dnd
Class StatusProxy

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.dnd.StatusProxy
All Implemented Interfaces:
Observable, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener

public class StatusProxy
extends BoxComponent

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


Nested Class Summary
 
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
 
Field Summary
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Method Summary
static StatusProxy get()
          Returns the singleton instance.
 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 status, java.lang.String cssClass)
          Updates the proxy's visual element to indicate the status of whether or not drop is allowed over the current target element.
 void update(com.google.gwt.user.client.Element element)
          Updates the contents of the ghost element.
 void update(java.lang.String html)
          Updates the contents of the ghost element.
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
getBounds, getHeight, getHeight, getPosition, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, isAutoHeight, isAutoWidth, isDeferHeight, isShim, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addListener, addPlugin, addStyleName, addWidgetListener, clearState, disable, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, getBaseStyle, getBorders, getContextMenu, getData, getElement, getHideMode, getId, getItemId, getListeners, getModel, getState, getStateId, getToolTip, hasListeners, hasListeners, hide, hideToolTip, isDisabledEvents, isEnabled, isRendered, isStateful, isVisible, mask, mask, mask, onBrowserEvent, onComponentEvent, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setBorders, setContextMenu, setData, setElement, setEnabled, setHideMode, setId, setIntStyleAttribute, setItemId, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
fireEvent, getParent, isAttached
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, setStylePrimaryName, setVisible, unsinkEvents
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

get

public static StatusProxy get()
Returns the singleton instance.

Returns:
the status proxy

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 fo standard no icon

getStatus

public boolean getStatus()
Returns true if the drop is allowed.

Returns:
the status

setStatus

public void setStatus(boolean status,
                      java.lang.String cssClass)
Updates the proxy's visual element to indicate the status of whether or not drop is allowed over the current target element.

Parameters:
cssClass - cssClass the css class for the new drop status indicator image

update

public void update(com.google.gwt.user.client.Element element)
Updates the contents of the ghost element.

Parameters:
element - the new ghost content

update

public void update(java.lang.String html)
Updates the contents of the ghost element.

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