com.ibm.xtools.richtext.control.diagram

Class ScrollableFigure

java.lang.Object

org.eclipse.draw2d.Figure

com.ibm.xtools.richtext.control.diagram.ScrollableFigure

All Implemented Interfaces:

org.eclipse.draw2d.IFigure

public class ScrollableFigure
extends org.eclipse.draw2d.Figure

Figure that contains a ScrollPane with a nested Viewport. After creating a ScrollableFigure, the creator should call addScrollPane() to add a ScrollPane to this figure. Then, the creator should add figures to ScrollPane's content pane.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.draw2d.Figure

org.eclipse.draw2d.Figure.FigureIterator, org.eclipse.draw2d.Figure.IdentitySearch

Nested classes/interfaces inherited from interface org.eclipse.draw2d.IFigure

org.eclipse.draw2d.IFigure.NoInsets

Field Summary

Fields

Modifier and Type	Field and Description
static int	MIN_CLIENT_DP Specifies the default minimum client size of this figure in device coordinates.
protected org.eclipse.draw2d.ScrollPane	scrollPane The scroll pane

Fields 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

Constructor and Description
ScrollableFigure() Constructor

Method Summary

Modifier and Type	Method and Description
void	addScrollPane() Adds a scroll pane to this figure.
protected org.eclipse.draw2d.ScrollPane	basicCreateScrollpane() Creates a ScrollPane only.
protected org.eclipse.draw2d.ScrollPane	createScrollPane() Creates and initializes a ScrollPane.
protected org.eclipse.draw2d.ScrollPaneLayout	createScrollPaneLayout() Creates a ScrollPaneLayout.
org.eclipse.draw2d.IFigure	getContentPane() Gets content pane.
org.eclipse.draw2d.geometry.Dimension	getMinClientDimension() Gets minimum client dimension.
protected int	getMinClientSize() Gets minimum client size.
org.eclipse.draw2d.geometry.Dimension	getMinimumSize(int w, int h)
org.eclipse.draw2d.geometry.Dimension	getPreferredSize(int wHint, int hHint)
org.eclipse.draw2d.ScrollPane	getScrollPane() Gets the ScrollPane.
protected int	getShrinkValue() Gets border margin of this figure.
void	invalidate()
protected void	paintFigure(org.eclipse.draw2d.Graphics graphics)
void	setSelected(boolean selected) Sets selected status.
void	validate()

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, getClientArea, getClientArea, getClippingStrategy, getCursor, getFlag, getFont, getForegroundColor, getInsets, getLayoutManager, getListeners, getLocalBackgroundColor, getLocalFont, getLocalForegroundColor, getLocation, getMaximumSize, getMinimumSize, getParent, getPreferredSize, getSize, getToolTip, getUpdateManager, handleFocusGained, handleFocusLost, handleKeyPressed, handleKeyReleased, handleMouseDoubleClicked, handleMouseDragged, handleMouseEntered, handleMouseExited, handleMouseHover, handleMouseMoved, handleMousePressed, handleMouseReleased, hasFocus, internalGetEventDispatcher, intersects, invalidateTree, isCoordinateSystem, isEnabled, isFocusTraversable, isMirrored, isMouseEventTarget, isOpaque, isRequestFocusEnabled, isShowing, isValid, isValidationRoot, isVisible, layout, paint, paintBorder, paintChildren, paintClientArea, 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, translateFromParent, translateToAbsolute, translateToParent, translateToRelative, useLocalCoordinates

Methods inherited from class java.lang.Object

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

Field Detail

scrollPane

protected org.eclipse.draw2d.ScrollPane scrollPane

The scroll pane

MIN_CLIENT_DP

public static final int MIN_CLIENT_DP

Specifies the default minimum client size of this figure in device coordinates.

See Also:

Constant Field Values

Constructor Detail

ScrollableFigure

public ScrollableFigure()

Constructor

Method Detail

addScrollPane

public void addScrollPane()

Adds a scroll pane to this figure.

createScrollPane

protected org.eclipse.draw2d.ScrollPane createScrollPane()

Creates and initializes a ScrollPane.

Returns:

ScrollPane

basicCreateScrollpane

protected org.eclipse.draw2d.ScrollPane basicCreateScrollpane()

Creates a ScrollPane only. This method is called by createScrollPane().

Returns:

ScrollPane

createScrollPaneLayout

protected org.eclipse.draw2d.ScrollPaneLayout createScrollPaneLayout()

Creates a ScrollPaneLayout.

Returns:

ScrollPaneLayout

getMinClientSize

protected int getMinClientSize()

Gets minimum client size.

Returns:

minimum client size

getContentPane

public org.eclipse.draw2d.IFigure getContentPane()

Gets content pane. Content pane is located inside ScrollPane.

Returns:

content pane

getScrollPane

public final org.eclipse.draw2d.ScrollPane getScrollPane()

Gets the ScrollPane.

Returns:

ScrollPane

setSelected

public void setSelected(boolean selected)

Sets selected status.

Parameters:

selected - selected

paintFigure

protected void paintFigure(org.eclipse.draw2d.Graphics graphics)

Overrides:

paintFigure in class org.eclipse.draw2d.Figure

getShrinkValue

protected int getShrinkValue()

Gets border margin of this figure.

Returns:

margin value

getPreferredSize

public org.eclipse.draw2d.geometry.Dimension getPreferredSize(int wHint,
                                                              int hHint)

Specified by:

getPreferredSize in interface org.eclipse.draw2d.IFigure

Overrides:

getPreferredSize in class org.eclipse.draw2d.Figure

getMinimumSize

public org.eclipse.draw2d.geometry.Dimension getMinimumSize(int w,
                                                            int h)

Specified by:

getMinimumSize in interface org.eclipse.draw2d.IFigure

Overrides:

getMinimumSize in class org.eclipse.draw2d.Figure

invalidate

public void invalidate()

Specified by:

invalidate in interface org.eclipse.draw2d.IFigure

Overrides:

invalidate in class org.eclipse.draw2d.Figure

getMinClientDimension

public org.eclipse.draw2d.geometry.Dimension getMinClientDimension()

Gets minimum client dimension. This method should be protected, please don't use it as a public method. This mistake will be corrected soon.

Returns:

minimum client dimension

validate

public void validate()

Specified by:

validate in interface org.eclipse.draw2d.IFigure

Overrides:

validate in class org.eclipse.draw2d.Figure