|
GEF (MVC) 3.9.0.201308190730 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.gef.editparts.ViewportAutoexposeHelper
public class ViewportAutoexposeHelper
An implementation of AutoexposeHelper
that performs
autoscrolling of a Viewport
figure. This helper is for use with
graphical editparts that contain a viewport figure. This helper will search
the editpart and find the viewport. Autoscroll will occur when the detect
location is inside the viewport's bounds, but near its edge. It will continue
for as long as the location continues to meet these criteria. The autoscroll
direction is approximated to the nearest orthogonal or diagonal direction
(north, northeast, east, etc.).
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.eclipse.gef.AutoexposeHelper |
---|
AutoexposeHelper.Search |
Field Summary | |
---|---|
protected GraphicalEditPart |
owner
|
Constructor Summary | |
---|---|
ViewportAutoexposeHelper(GraphicalEditPart owner)
Constructs a new helper on the given GraphicalEditPart. |
|
ViewportAutoexposeHelper(GraphicalEditPart owner,
Insets threshold)
Constructs a new helper on the given GraphicalEditPart. |
Method Summary | |
---|---|
boolean |
detect(Point where)
Returns true if the given point is inside the viewport, but
near its edge. |
protected Viewport |
findViewport(GraphicalEditPart part)
|
boolean |
step(Point where)
Returns true if the given point is outside the viewport or
near its edge. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected GraphicalEditPart owner
Constructor Detail |
---|
public ViewportAutoexposeHelper(GraphicalEditPart owner)
Viewport
somewhere between its contentsPane
and its figure inclusively.
owner
- the GraphicalEditPart that owns the Viewportpublic ViewportAutoexposeHelper(GraphicalEditPart owner, Insets threshold)
Viewport
somewhere between its contentsPane
and its figure inclusively.
owner
- the GraphicalEditPart that owns the Viewportthreshold
- the Expose Threshold to use when determing whether or not a
scroll should occur.Method Detail |
---|
public boolean detect(Point where)
true
if the given point is inside the viewport, but
near its edge.
detect
in interface AutoexposeHelper
where
- the mouse's current location in the viewer
true
if the location is interestingAutoexposeHelper.detect(org.eclipse.draw2d.geometry.Point)
public boolean step(Point where)
true
if the given point is outside the viewport or
near its edge. Scrolls the viewport by a calculated (time based) amount
in the current direction.
todo: investigate if we should allow auto expose when the pointer is
outside the viewport
step
in interface AutoexposeHelper
where
- the current location of the mouse in the viewer
AutoexposeHelper.step(org.eclipse.draw2d.geometry.Point)
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
protected Viewport findViewport(GraphicalEditPart part)
|
GEF (MVC) 3.9.0.201308190730 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |