DragStartEvent class

Represents a native drag start event.

class DragStartEvent extends DragDropEventBase {

 /**
  * The event type.
  */
 static DomEventType<DragStartHandler> TYPE = new DomEventType<DragStartHandler>(BrowserEvents.DRAGSTART, new DragStartEvent());

 DomEventType<DragStartHandler> getAssociatedType() {
   return TYPE;
 }

 DragStartEvent();

 void dispatch(DragStartHandler handler) {
   handler.onDragStart(this);
 }

}

Extends

IEvent<H> > DwtEvent > DomEvent > MouseEvent > DragDropEventBase > DragStartEvent

Static Properties

DomEventType<DragStartHandler> TYPE #

The event type.

static DomEventType<DragStartHandler> TYPE = new DomEventType<DragStartHandler>(BrowserEvents.DRAGSTART, new DragStartEvent())

Constructors

new DragStartEvent() #

Constructor.

docs inherited from IEvent<H>

DragStartEvent();

Methods

void assertLive() #

inherited from DwtEvent

Asserts that the event still should be accessed. All events are considered to be "dead" after their original handler manager finishes firing them. An event can be revived by calling {@link GwtEvent#revive()}.

void assertLive() {
 assert (!_dead) ; //: "This event has already finished being processed by its original handler manager, so you can no longer access it";
}

void dispatch(DragStartHandler handler) #

Implemented by subclasses to invoke their handlers in a type safe manner. Intended to be called by EventBus#fireEvent(Event) or EventBus#fireEventFromSource(Event, Object).

@param handler handler @see EventBus#dispatchEvent(Event, Object)

docs inherited from IEvent<H>

void dispatch(DragStartHandler handler) {
 handler.onDragStart(this);
}

DomEventType<DragStartHandler> getAssociatedType() #

Returns the EventType used to register this event, allowing an EventBus to find handlers of the appropriate class.

@return the type

docs inherited from IEvent<H>

DomEventType<DragStartHandler> getAssociatedType() {
 return TYPE;
}

int getClientX() #

inherited from MouseEvent

Gets the mouse x-position within the browser window's client area.

@return the mouse x-position

int getClientX() {
 return getMouseEvent().client.x;
}

int getClientY() #

inherited from MouseEvent

Gets the mouse y-position within the browser window's client area.

@return the mouse y-position

int getClientY() {
 return getMouseEvent().client.y;
}

String getData(String format) #

inherited from DragDropEventBase

Get the data for the specified format from the {@link DataTransfer} object.

@param format the format @return the data for the specified format

String getData(String format) {
 dart_html.DataTransfer dt = getDataTransfer();
 if (dt != null) {
   return getDataTransfer().getData(format);
 }
 return null;
}

DataTransfer getDataTransfer() #

inherited from DragDropEventBase

Get the {@link DataTransfer} associated with the current drag event.

@return the {@link DataTransfer} object

dart_html.DataTransfer getDataTransfer() {
 if (getNativeEvent() is dart_html.MouseEvent) {
   return (getNativeEvent() as dart_html.MouseEvent).dataTransfer;
 }
 return null;
}

MouseEvent getMouseEvent() #

inherited from MouseEvent

Cast native event to MouseEvent.

dart_html.MouseEvent getMouseEvent() {
 if (getNativeEvent() is dart_html.MouseEvent) {
   return getNativeEvent() as dart_html.MouseEvent;
 }
 throw new Exception("Native event is not subtype of MouseEvent");
}

int getNativeButton() #

inherited from MouseEvent

Gets the button value. Compare it to {@link com.google.gwt.dom.client.NativeEvent#BUTTONLEFT}, {@link com.google.gwt.dom.client.NativeEvent#BUTTONRIGHT}, {@link com.google.gwt.dom.client.NativeEvent#BUTTON_MIDDLE}

@return the button value

int getNativeButton() {
 return getMouseEvent().button;
}

Event getNativeEvent() #

inherited from DomEvent

Gets the underlying native event.

@return the native event

docs inherited from HasNativeEvent

dart_html.Event getNativeEvent() {
 assertLive();
 return _nativeEvent;
}

Element getRelativeElement() #

inherited from DomEvent

Gets the element relative to which event coordinates will be measured. If this element is <code>null</code>, event coordinates will be measured relative to the window's client area.

@return the event's relative element

dart_html.Element getRelativeElement() {
 assertLive();
 return _relativeElem;
}

int getRelativeX(Element target) #

inherited from MouseEvent

Gets the mouse x-position relative to a given element.

@param target the element whose coordinate system is to be used @return the relative x-position

int getRelativeX(dart_html.Element target) {
 return getMouseEvent().client.x - Dom.getAbsoluteLeft(target) + target.scrollLeft + target.document.documentElement.scrollLeft;
}

int getRelativeY(Element target) #

inherited from MouseEvent

Gets the mouse y-position relative to a given element.

@param target the element whose coordinate system is to be used @return the relative y-position

int getRelativeY(dart_html.Element target) {
 return getMouseEvent().client.y - Dom.getAbsoluteTop(target) + target.scrollTop + target.document.documentElement.scrollTop;
}

int getScreenX() #

inherited from MouseEvent

Gets the mouse x-position on the user's display.

@return the mouse x-position

int getScreenX() {
 return getMouseEvent().screen.x;
}

int getScreenY() #

inherited from MouseEvent

Gets the mouse y-position on the user's display.

@return the mouse y-position

int getScreenY() {
 return getMouseEvent().screen.y;
}

Object getSource() #

inherited from DwtEvent

Returns the source for this event. The type and meaning of the source is arbitrary, and is most useful as a secondary key for handler registration. (See EventBus#addHandlerToSource, which allows a handler to register for events of a particular type, tied to a particular source.)

Note that the source is actually set at dispatch time, e.g. via EventBus#fireEventFromSource(Event, Object).

@return object representing the source of this event

docs inherited from IEvent<H>

Object getSource() {
 assertLive();
 return super.getSource();
}

int getX() #

inherited from MouseEvent

Gets the mouse x-position relative to the event's current target element.

@return the relative x-position

int getX() {
 dart_html.Element relativeElem = getRelativeElement();
 if (relativeElem != null) {
   return getRelativeX(relativeElem);
 }
 return getClientX();
}

int getY() #

inherited from MouseEvent

Gets the mouse y-position relative to the event's current target element.

@return the relative y-position

int getY() {
 dart_html.Element relativeElem = getRelativeElement();
 if (relativeElem != null) {
   return getRelativeY(relativeElem);
 }
 return getClientY();
}

bool isAltKeyDown() #

inherited from MouseEvent

Is <code>alt</code> key down.

@return whether the alt key is down

bool isAltKeyDown() {
 return getMouseEvent().altKey;
}

bool isControlKeyDown() #

inherited from MouseEvent

Is <code>control</code> key down.

@return whether the control key is down

bool isControlKeyDown() {
 return getMouseEvent().ctrlKey;
}

bool isLive() #

inherited from DwtEvent

Is the event current live?

@return whether the event is live

bool isLive() {
 return !_dead;
}

bool isMetaKeyDown() #

inherited from MouseEvent

Is <code>meta</code> key down.

@return whether the meta key is down

bool isMetaKeyDown() {
 return getMouseEvent().metaKey;
}

bool isShiftKeyDown() #

inherited from MouseEvent

Is <code>shift</code> key down.

@return whether the shift key is down

bool isShiftKeyDown() {
 return getMouseEvent().shiftKey;
}

void kill() #

inherited from DwtEvent

Kill the event. After the event has been killed, users cannot really on its values or functions being available.

void kill() {
 _dead = true;
 setSource(null);
}

void overrideSource(Object source) #

inherited from DwtEvent

void overrideSource(Object source) {
 super.setSource(source);
}

void preventDefault() #

inherited from DomEvent

Prevents the wrapped native event's default action.

void preventDefault() {
 assertLive();
 _nativeEvent.preventDefault();
}

void revive() #

inherited from DwtEvent

Revives the event. Used when recycling event instances.

void revive() {
 _dead = false;
 setSource(null);
}

void setData(String format, String data) #

inherited from DragDropEventBase

Set the data in the {@link DataTransfer} object for the specified format.

@param format the format @param data the data to associate with the format

void setData(String format, String data) {
 dart_html.DataTransfer dt = getDataTransfer();
 if (dt != null) {
   getDataTransfer().setData(format, data);
 }
}

void setSource(source) #

inherited from IEvent

Set the source that triggered this event. Intended to be called by the EventBus during dispatch.

@param source the source of this event. @see EventBus#fireEventFromSource(Event, Object) @see EventBus#setSourceOfEvent(Event, Object)

void setSource(dynamic source) {
 this._source = source;
}

void stopPropagation() #

inherited from DomEvent

Stops the propagation of the underlying native event.

void stopPropagation() {
 assertLive();
 _nativeEvent.stopPropagation();
}

String toString() #

inherited from IEvent

The toString() for abstract event is overridden to avoid accidently including class literals in the the compiled output. Use Event

toDebugString to get more information about the event.

String toString() {
 return "An event type";
}

DragStartEvent class

Extends

Static Properties

Code DomEventType<DragStartHandler> TYPE #

Constructors

Code new DragStartEvent() #

Methods

Code void assertLive() #

Code void dispatch(DragStartHandler handler) #

Code DomEventType<DragStartHandler> getAssociatedType() #

Code int getClientX() #

Code int getClientY() #

Code String getData(String format) #

Code DataTransfer getDataTransfer() #

Code MouseEvent getMouseEvent() #

Code int getNativeButton() #

Code Event getNativeEvent() #

Code Element getRelativeElement() #

Code int getRelativeX(Element target) #

Code int getRelativeY(Element target) #

Code int getScreenX() #

Code int getScreenY() #

Code Object getSource() #

Code int getX() #

Code int getY() #

Code bool isAltKeyDown() #

Code bool isControlKeyDown() #

Code bool isLive() #

Code bool isMetaKeyDown() #

Code bool isShiftKeyDown() #

Code void kill() #

Code void overrideSource(Object source) #

Code void preventDefault() #

Code void revive() #

Code void setData(String format, String data) #

Code void setSource(source) #

Code void stopPropagation() #

Code String toString() #

toDebugString to get more information about the event.

DomEventType<DragStartHandler> TYPE #

new DragStartEvent() #

void assertLive() #

void dispatch(DragStartHandler handler) #

DomEventType<DragStartHandler> getAssociatedType() #

int getClientX() #

int getClientY() #

String getData(String format) #

DataTransfer getDataTransfer() #

MouseEvent getMouseEvent() #

int getNativeButton() #

Event getNativeEvent() #

Element getRelativeElement() #

int getRelativeX(Element target) #

int getRelativeY(Element target) #

int getScreenX() #

int getScreenY() #

Object getSource() #

int getX() #

int getY() #

bool isAltKeyDown() #

bool isControlKeyDown() #

bool isLive() #

bool isMetaKeyDown() #

bool isShiftKeyDown() #

void kill() #

void overrideSource(Object source) #

void preventDefault() #

void revive() #

void setData(String format, String data) #

void setSource(source) #

void stopPropagation() #

String toString() #