Eclipse GEF and Draw2d Plug-in Developer Guide (Galileo) - DomainEventDispatcher (Eclipse GEF API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse GEF
3.3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.gef.ui.parts
Class DomainEventDispatcher

java.lang.Object
  

org.eclipse.draw2d.EventDispatcher
      

org.eclipse.draw2d.SWTEventDispatcher
          
org.eclipse.gef.ui.parts.DomainEventDispatcher

public class DomainEventDispatcher
extends SWTEventDispatcher

A special event dispatcher that will route events to the EditDomain when appropriate.

IMPORTANT: This class is not intended to be used or subclassed by clients.

Nested Class Summary

protected class DomainEventDispatcher.EditPartAccessibilityDispatcher
          Extended accessibility support for editpart.

Nested classes inherited from class org.eclipse.draw2d. SWTEventDispatcher

SWTEventDispatcher.FigureAccessibilityDispatcher

Nested classes inherited from class org.eclipse.draw2d. EventDispatcher

EventDispatcher.AccessibilityDispatcher

Field Summary

protected EditDomain domain
          The edit domain

protected EditPartViewer viewer
          The viewer on which this dispatcher is created.

Fields inherited from class org.eclipse.draw2d. SWTEventDispatcher

ANY_BUTTON, control

Constructor Summary

DomainEventDispatcher ( EditDomain d, EditPartViewer v)
          Constructs the dispatcher for the given domain and viewer.

Method Summary

void dispatchFocusGained (FocusEvent event)


void dispatchFocusLost (FocusEvent event)


void dispatchKeyPressed (org.eclipse.swt.events.KeyEvent e)


void dispatchKeyReleased (org.eclipse.swt.events.KeyEvent e)


void dispatchKeyTraversed (TraverseEvent e)


void dispatchMouseDoubleClicked (org.eclipse.swt.events.MouseEvent me)


void dispatchMouseEntered (org.eclipse.swt.events.MouseEvent me)


void dispatchMouseExited (org.eclipse.swt.events.MouseEvent me)


void dispatchMouseHover (org.eclipse.swt.events.MouseEvent me)


void dispatchMouseMoved (org.eclipse.swt.events.MouseEvent me)


void dispatchMousePressed (org.eclipse.swt.events.MouseEvent me)


void dispatchMouseReleased (org.eclipse.swt.events.MouseEvent me)


void dispatchMouseWheelScrolled (Event evt)
          Forwards the event to the EditDomain.

void dispatchNativeDragFinished (DragSourceEvent event, AbstractEditPartViewer viewer)
          Dispatches a drag finished event.

void dispatchNativeDragStarted (DragSourceEvent event, AbstractEditPartViewer viewer)
          Dispatches a drag started event.

protected EventDispatcher.AccessibilityDispatcher getAccessibilityDispatcher ()
          Lazily creates and returns the accessibility dispatcher.

protected EditPartViewer getViewer ()
          Returns the viewer on which this dispatcher was created

protected void setCapture ( IFigure figure)


protected void setCursor (Cursor newCursor)


void setOverrideCursor (Cursor newCursor)
          Sets the override cursor.

void setRouteEventsToEditor (boolean value)
          Sets whether events should go directly to the edit domain.

Methods inherited from class org.eclipse.draw2d. SWTEventDispatcher

dispatchFocusGained, dispatchFocusLost, dispatchKeyTraversed, getCurrentEvent, getCursorTarget, getFocusTraverseManager, getMouseTarget, getRoot, getToolTipHelper, isCaptured, releaseCapture, requestFocus, requestRemoveFocus, setControl, setCursor, setEnableKeyTraversal, setFigureUnderCursor, setFocus, setHoverSource, setMouseTarget, setRoot, updateCursor, updateFigureUnderCursor, updateHoverSource

Methods inherited from class org.eclipse.draw2d. EventDispatcher

dispatchMouseWheelScrolled

Methods inherited from class java.lang.Object

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

Field Detail

domain

protected 
EditDomain domain

The edit domain

viewer

protected 
EditPartViewer viewer

The viewer on which this dispatcher is created.

Constructor Detail

DomainEventDispatcher

public DomainEventDispatcher(
EditDomain d,
                             
EditPartViewer v)

Constructs the dispatcher for the given domain and viewer.
Parameters:: d - the domain; v - the viewer

Method Detail

dispatchFocusGained

public void dispatchFocusGained(FocusEvent event)

See Also:: EventDispatcher.dispatchFocusGained(org.eclipse.swt.events.FocusEvent)

dispatchFocusLost

public void dispatchFocusLost(FocusEvent event)

See Also:: EventDispatcher.dispatchFocusLost(org.eclipse.swt.events.FocusEvent)

dispatchKeyPressed

public void dispatchKeyPressed(org.eclipse.swt.events.KeyEvent e)

See Also:: EventDispatcher.dispatchKeyPressed(org.eclipse.swt.events.KeyEvent)

dispatchKeyTraversed

public void dispatchKeyTraversed(TraverseEvent e)

See Also:: SWTEventDispatcher.dispatchKeyTraversed(org.eclipse.swt.events.TraverseEvent)

dispatchKeyReleased

public void dispatchKeyReleased(org.eclipse.swt.events.KeyEvent e)

See Also:: EventDispatcher.dispatchKeyReleased(org.eclipse.swt.events.KeyEvent)

dispatchMouseDoubleClicked

public void dispatchMouseDoubleClicked(org.eclipse.swt.events.MouseEvent me)

See Also:: EventDispatcher.dispatchMouseDoubleClicked(org.eclipse.swt.events.MouseEvent)

dispatchMouseEntered

public void dispatchMouseEntered(org.eclipse.swt.events.MouseEvent me)

See Also:: EventDispatcher.dispatchMouseEntered(org.eclipse.swt.events.MouseEvent)

dispatchMouseExited

public void dispatchMouseExited(org.eclipse.swt.events.MouseEvent me)

See Also:: EventDispatcher.dispatchMouseExited(org.eclipse.swt.events.MouseEvent)

dispatchMouseHover

public void dispatchMouseHover(org.eclipse.swt.events.MouseEvent me)

See Also:: EventDispatcher.dispatchMouseHover(org.eclipse.swt.events.MouseEvent)

dispatchMousePressed

public void dispatchMousePressed(org.eclipse.swt.events.MouseEvent me)

See Also:: EventDispatcher.dispatchMousePressed(org.eclipse.swt.events.MouseEvent)

dispatchMouseMoved

public void dispatchMouseMoved(org.eclipse.swt.events.MouseEvent me)

See Also:: EventDispatcher.dispatchMouseMoved(org.eclipse.swt.events.MouseEvent)

dispatchMouseReleased

public void dispatchMouseReleased(org.eclipse.swt.events.MouseEvent me)

See Also:: EventDispatcher.dispatchMouseReleased(org.eclipse.swt.events.MouseEvent)

dispatchNativeDragFinished

public void dispatchNativeDragFinished(DragSourceEvent event,
                                       
AbstractEditPartViewer viewer)

Dispatches a drag finished event.

Parameters:: event - the event; viewer - the viewer on which the event occured.

dispatchNativeDragStarted

public void dispatchNativeDragStarted(DragSourceEvent event,
                                      
AbstractEditPartViewer viewer)

Dispatches a drag started event.

Parameters:: event - the event; viewer - the viewer

dispatchMouseWheelScrolled

public void dispatchMouseWheelScrolled(Event evt)

Forwards the event to the EditDomain.

See Also:: EventDispatcher.dispatchMouseWheelScrolled(org.eclipse.swt.widgets.Event)

getAccessibilityDispatcher

protected 
EventDispatcher.AccessibilityDispatcher getAccessibilityDispatcher()

Lazily creates and returns the accessibility dispatcher.

See Also:: EventDispatcher.getAccessibilityDispatcher()

getViewer

protected final 
EditPartViewer getViewer()

Returns the viewer on which this dispatcher was created

Returns:: the viewer for this dispatcher

setCapture

protected void setCapture(
IFigure figure)

See Also:: EventDispatcher.setCapture(IFigure)

setCursor

protected void setCursor(Cursor newCursor)

See Also:: SWTEventDispatcher#setCursor(Cursor)

setRouteEventsToEditor

public void setRouteEventsToEditor(boolean value)

Sets whether events should go directly to the edit domain.

Parameters:: value - true if all events should go directly to the edit domain

setOverrideCursor

public void setOverrideCursor(Cursor newCursor)

Sets the override cursor.

Parameters:: newCursor - the cursor