Package org.eclipse.gef.editparts
Class ViewportExposeHelper
java.lang.Object
org.eclipse.gef.editparts.ViewportExposeHelper
- All Implemented Interfaces:
ExposeHelper
An implementation of
ExposeHelper
for use with editparts using a
Viewport
.- Since:
- 2.0
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new ViewportExposeHelper on the specified GraphicalEditPart. -
Method Summary
Modifier and TypeMethodDescriptionvoid
exposeDescendant
(EditPart part) Exposes the descendant EditPart by smoothly scrolling theViewport
.protected org.eclipse.draw2d.Viewport
int
Returns the maximumFrameCount.int
Returns the minimumFrameCount.void
setMargin
(org.eclipse.draw2d.geometry.Insets margin) Sets the amount of margin to be left around the descendant being exposed.void
setMaximumFrameCount
(int maximumFrameCount) Sets the maximumFrameCount.void
setMinimumFrameCount
(int minimumFrameCount) Sets the minimumFrameCount.
-
Field Details
-
owner
-
-
Constructor Details
-
ViewportExposeHelper
Constructs a new ViewportExposeHelper on the specified GraphicalEditPart. The GraphicalEditPart must have aViewport
somewhere between its contentsPane and its figure inclusively.- Parameters:
owner
- the GraphicalEditPart that owns the Viewport
-
-
Method Details
-
exposeDescendant
Exposes the descendant EditPart by smoothly scrolling theViewport
. The smoothness is determined by the minimum and maximum frame count, and the overall amount being scrolled.- Specified by:
exposeDescendant
in interfaceExposeHelper
- Parameters:
part
- the descendant to expose- See Also:
-
getMaximumFrameCount
public int getMaximumFrameCount()Returns the maximumFrameCount.- Returns:
- int
-
getMinimumFrameCount
public int getMinimumFrameCount()Returns the minimumFrameCount.- Returns:
- int
-
setMargin
public void setMargin(org.eclipse.draw2d.geometry.Insets margin) Sets the amount of margin to be left around the descendant being exposed. There is no margin by default.- Parameters:
margin
- the margin in pixels
-
setMaximumFrameCount
public void setMaximumFrameCount(int maximumFrameCount) Sets the maximumFrameCount.- Parameters:
maximumFrameCount
- The maximumFrameCount to set
-
setMinimumFrameCount
public void setMinimumFrameCount(int minimumFrameCount) Sets the minimumFrameCount.- Parameters:
minimumFrameCount
- The minimumFrameCount to set
-
findViewport
-