Package org.eclipse.draw2d
Class Viewport
java.lang.Object
org.eclipse.draw2d.Figure
org.eclipse.draw2d.Viewport
- All Implemented Interfaces:
PropertyChangeListener
,EventListener
,IFigure
- Direct Known Subclasses:
FreeformViewport
A Viewport is a flexible window onto a
ScrollPane
and represents the
visible portion of the ScrollPane.-
Nested Class Summary
Nested classes/interfaces inherited from class org.eclipse.draw2d.Figure
Figure.FigureIterator, Figure.IdentitySearch, Figure.ReverseFigureChildrenIterator
Nested classes/interfaces inherited from interface org.eclipse.draw2d.IFigure
IFigure.NoInsets
-
Field Summary
FieldsFields inherited from class org.eclipse.draw2d.Figure
bgColor, border, bounds, fgColor, flags, font, MAX_FLAG, maxSize, minSize, NO_MANAGER, prefSize, toolTip
Fields inherited from interface org.eclipse.draw2d.IFigure
MAX_DIMENSION, MIN_DIMENSION, NO_INSETS
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetClientArea
(Rectangle rect) Copies the client area into the specificied Recangle, and returns that rectangle for convenience.Returns the view, which is the contents of theScrollPane
associated with this Viewport.boolean
Returnstrue
if the Viewport resizes itself in the vertical direction when the available height of its view is decreased, false otherwise.boolean
Returnstrue
if the Viewport resizes itself in the horizontal direction when the available width of its view is decreased, false otherwise.Returns the RangeModel associated with the horizontal motion of this ViewportReturns the range model associated with the vertical motion of the Viewport.Returns the current location of this Viewport.boolean
Returnstrue
if this figure is capable of applying a local coordinate system which affects its children.protected void
Paints this Figure's client area.void
Listens for either of theRangeModels
to fire a property change event and updates the view accordingly.protected void
Sets extents ofRangeModels
to the client area of this Viewport.void
setContents
(IFigure figure) Sets this Viewport to be associated with the passed Figure.void
setContentsTracksHeight
(boolean track) Toggles the Viewport's ability to resize itself automatically when its view is decreased in size in the vertical direction.void
setContentsTracksWidth
(boolean track) Toggles the Viewport's ability to resize itself automatically when its view is decreased in size in the horizontal direction.void
setHorizontalLocation
(int value) Sets the horizontal location of the Viewport's view to the passed value.void
setHorizontalRangeModel
(RangeModel rangeModel) Sets the horizontal range model to the passed RangeModel.void
setIgnoreScroll
(boolean value) If value istrue
, this viewport will ignore any scrolling that occurs until this method is called again withfalse
.void
setVerticalLocation
(int value) Sets the vertical location of the Viewport's view to the passed value.void
setVerticalRangeModel
(RangeModel rangeModel) Sets the vertical range model to the passed RangeModel.void
setViewLocation
(int x, int y) Sets the location of the Viewport's view to the passed values.void
Sets the location of the Viewport's view to the passed Point.void
Translates a Translatable from this IFigure's parent's coordinates to this IFigure's local coordinates.void
Translates a Translatable from this IFigure's coordinates to its parent's coordinates.boolean
Returnstrue
if this viewport uses graphics translation.void
validate()
Indicates that this figure should make itself valid.Methods inherited from class org.eclipse.draw2d.Figure
add, add, add, add, addAncestorListener, addCoordinateListener, addFigureListener, addFocusListener, addKeyListener, addLayoutListener, addListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, containsPoint, containsPoint, erase, findDescendantAtExcluding, findFigureAt, findFigureAt, findFigureAt, findFigureAtExcluding, findMouseEventTargetAt, findMouseEventTargetInDescendantsAt, fireCoordinateSystemChanged, fireFigureMoved, fireMoved, firePropertyChange, firePropertyChange, firePropertyChange, getBackgroundColor, getBorder, getBounds, getChildren, getChildrenRevIterable, getClientArea, getClippingStrategy, getCursor, getFlag, getFont, getForegroundColor, getInsets, getLayoutManager, getListeners, getListenersIterable, getLocalBackgroundColor, getLocalFont, getLocalForegroundColor, getLocation, getMaximumSize, getMinimumSize, getMinimumSize, getParent, getPreferredSize, getPreferredSize, getSize, getToolTip, getUpdateManager, handleFocusGained, handleFocusLost, handleKeyPressed, handleKeyReleased, handleMouseDoubleClicked, handleMouseDragged, handleMouseEntered, handleMouseExited, handleMouseHover, handleMouseMoved, handleMousePressed, handleMouseReleased, hasFocus, internalGetEventDispatcher, intersects, invalidate, invalidateTree, isEnabled, isFocusTraversable, isMirrored, isMouseEventTarget, isOpaque, isRequestFocusEnabled, isShowing, isValid, isValidationRoot, isVisible, layout, optimizeClip, paint, paintBorder, paintChildren, paintFigure, primTranslate, remove, removeAll, removeAncestorListener, removeCoordinateListener, removeFigureListener, removeFocusListener, removeKeyListener, removeLayoutListener, removeListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, revalidate, setBackgroundColor, setBorder, setBounds, setChildrenDirection, setChildrenEnabled, setChildrenOrientation, setClippingStrategy, setConstraint, setCursor, setEnabled, setFlag, setFocusTraversable, setFont, setForegroundColor, setLayoutManager, setLocation, setMaximumSize, setMinimumSize, setOpaque, setParent, setPreferredSize, setPreferredSize, setRequestFocusEnabled, setSize, setSize, setToolTip, setValid, setVisible, translate, translateToAbsolute, translateToRelative, useLocalCoordinates
-
Field Details
-
PROPERTY_VIEW_LOCATION
ID for the view location property- See Also:
-
-
Constructor Details
-
Viewport
public Viewport()Constructs a new Viewport with the default values. -
Viewport
public Viewport(boolean setting) Constructs a new Viewport. If setting istrue
, the viewport will use graphics translation to paint.- Parameters:
setting
- whether to use graphics translation
-
-
Method Details
-
getClientArea
Description copied from interface:IFigure
Copies the client area into the specificied Recangle, and returns that rectangle for convenience.- Specified by:
getClientArea
in interfaceIFigure
- Overrides:
getClientArea
in classFigure
- Parameters:
rect
- The destination rectangle for the client area- Returns:
- The same instance that was passed in, modified to contain the client area
- See Also:
-
getContents
Returns the view, which is the contents of theScrollPane
associated with this Viewport.- Returns:
- the contents
- Since:
- 2.0
-
getHorizontalRangeModel
Returns the RangeModel associated with the horizontal motion of this Viewport- Returns:
- the RangeModel
- Since:
- 2.0
-
getContentsTracksHeight
public boolean getContentsTracksHeight()Returnstrue
if the Viewport resizes itself in the vertical direction when the available height of its view is decreased, false otherwise. This option is turned off by default, and can be activated by callingsetContentsTracksHeight(boolean)
and passing intrue
.- Returns:
- whether the contents tracks height
- Since:
- 2.0
-
getContentsTracksWidth
public boolean getContentsTracksWidth()Returnstrue
if the Viewport resizes itself in the horizontal direction when the available width of its view is decreased, false otherwise. This option is turned off by default, and can be activated by callingsetContentsTracksWidth(boolean)
and passing intrue
.- Returns:
- whether the contents tracks width
- Since:
- 2.0
-
getVerticalRangeModel
Returns the range model associated with the vertical motion of the Viewport.- Returns:
- the RangeModel
- Since:
- 2.0
-
getViewLocation
Returns the current location of this Viewport.- Returns:
- the current location of this Viewport
- Since:
- 2.0
-
paintClientArea
Description copied from class:Figure
Paints this Figure's client area. The client area is typically defined as the anything inside the Figure'sBorder
orInsets
, and by default includes the children of this Figure. On return, this method must leave the given Graphics in its initial state.- Overrides:
paintClientArea
in classFigure
- Parameters:
g
- The Graphics used to paint- See Also:
-
isCoordinateSystem
public boolean isCoordinateSystem()Description copied from interface:IFigure
Returnstrue
if this figure is capable of applying a local coordinate system which affects its children.- Specified by:
isCoordinateSystem
in interfaceIFigure
- Overrides:
isCoordinateSystem
in classFigure
- Returns:
true
if this figure provides local coordinates to children- See Also:
-
propertyChange
Listens for either of theRangeModels
to fire a property change event and updates the view accordingly.- Specified by:
propertyChange
in interfacePropertyChangeListener
- Parameters:
event
- the event
-
readjustScrollBars
protected void readjustScrollBars()Sets extents ofRangeModels
to the client area of this Viewport. Sets RangeModel minimums to zero. Sets RangeModel maximums to this Viewport's height/width.- Since:
- 2.0
-
setContents
Sets this Viewport to be associated with the passed Figure.- Parameters:
figure
- the new contents- Since:
- 2.0
-
setContentsTracksHeight
public void setContentsTracksHeight(boolean track) Toggles the Viewport's ability to resize itself automatically when its view is decreased in size in the vertical direction. This is disabled by default.- Parameters:
track
- whether this viewport should track its height- Since:
- 2.0
-
setContentsTracksWidth
public void setContentsTracksWidth(boolean track) Toggles the Viewport's ability to resize itself automatically when its view is decreased in size in the horizontal direction. This is disabled by default.- Parameters:
track
- whether this viewport should track its width- Since:
- 2.0
-
setHorizontalLocation
public void setHorizontalLocation(int value) Sets the horizontal location of the Viewport's view to the passed value.- Parameters:
value
- the new horizontal location- Since:
- 2.0
-
setHorizontalRangeModel
Sets the horizontal range model to the passed RangeModel.- Parameters:
rangeModel
- the new horizontal range model- Since:
- 2.0
-
setIgnoreScroll
public void setIgnoreScroll(boolean value) If value istrue
, this viewport will ignore any scrolling that occurs until this method is called again withfalse
.- Parameters:
value
- whether this viewport should ignore future scrolls
-
setVerticalLocation
public void setVerticalLocation(int value) Sets the vertical location of the Viewport's view to the passed value.- Parameters:
value
- the new vertical location- Since:
- 2.0
-
setVerticalRangeModel
Sets the vertical range model to the passed RangeModel.- Parameters:
rangeModel
- the new vertical RangeModel- Since:
- 2.0
-
setViewLocation
public void setViewLocation(int x, int y) Sets the location of the Viewport's view to the passed values.- Parameters:
x
- The new x coordinate of the Viewport's view.y
- The new y coordinate of the Viewport's view.- Since:
- 2.0
-
setViewLocation
Sets the location of the Viewport's view to the passed Point.- Parameters:
p
- The new location of the Viewport's view.- Since:
- 2.0
-
translateFromParent
Description copied from interface:IFigure
Translates a Translatable from this IFigure's parent's coordinates to this IFigure's local coordinates.- Specified by:
translateFromParent
in interfaceIFigure
- Overrides:
translateFromParent
in classFigure
- Parameters:
t
- The object to translate- See Also:
-
translateToParent
Description copied from interface:IFigure
Translates a Translatable from this IFigure's coordinates to its parent's coordinates.- Specified by:
translateToParent
in interfaceIFigure
- Overrides:
translateToParent
in classFigure
- Parameters:
t
- The object to translate- See Also:
-
useGraphicsTranslate
public boolean useGraphicsTranslate()Returnstrue
if this viewport uses graphics translation.- Returns:
- whether this viewport uses graphics translation
-
validate
public void validate()Description copied from interface:IFigure
Indicates that this figure should make itself valid. Validation includes invoking layout on a LayoutManager if present, and then validating all children figures. Default validation uses pre-order, depth-first ordering.
-