|
Eclipse Draw2d 3.8.0.201206011245 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Control
org.eclipse.swt.widgets.Scrollable
org.eclipse.swt.widgets.Composite
org.eclipse.swt.widgets.Canvas
org.eclipse.draw2d.FigureCanvas
public class FigureCanvas
A scrolling Canvas that contains Figures
viewed through a
Viewport
. Call setContents(IFigure)
to specify the root of
the tree of Figures to be viewed through the Viewport.
Normal procedure for using a FigureCanvas:
setContents(IFigure)
. This
Figure will be the top-level Figure of the Draw2d application.
Note: Only one of the styles RIGHT_TO_LEFT, LEFT_TO_RIGHT may be specified.
Field Summary | |
---|---|
static int |
ALWAYS
Always show scrollbar |
static int |
AUTOMATIC
Automatically show scrollbar when needed |
static int |
NEVER
Never show scrollbar |
Fields inherited from class org.eclipse.swt.widgets.Control |
---|
view |
Constructor Summary | |
---|---|
FigureCanvas(Composite parent)
Creates a new FigureCanvas with the given parent and the DEFAULT_STYLES . |
|
FigureCanvas(Composite parent,
int style)
Constructor which applies the default styles plus any optional styles indicated. |
|
FigureCanvas(Composite parent,
int style,
LightweightSystem lws)
Constructor |
|
FigureCanvas(Composite parent,
LightweightSystem lws)
Constructs a new FigureCanvas with the given parent and LightweightSystem, using the DEFAULT_STYLES . |
|
FigureCanvas(int style,
Composite parent)
Constructor which uses the given styles verbatim. |
|
FigureCanvas(int style,
Composite parent,
LightweightSystem lws)
Constructor taking a lightweight system and SWT style, which is used verbatim. |
Method Summary | |
---|---|
Point |
computeSize(int wHint,
int hHint,
boolean changed)
|
IFigure |
getContents()
|
Font |
getFont()
|
int |
getHorizontalScrollBarVisibility()
|
LightweightSystem |
getLightweightSystem()
|
int |
getVerticalScrollBarVisibility()
|
Viewport |
getViewport()
Returns the Viewport. |
void |
scrollSmoothTo(int x,
int y)
Scrolls in an animated way to the new x and y location. |
void |
scrollTo(int x,
int y)
Scrolls the contents to the new x and y location. |
void |
scrollToX(int hOffset)
Scrolls the contents horizontally so that they are offset by hOffset . |
void |
scrollToY(int vOffset)
Scrolls the contents vertically so that they are offset by vOffset . |
void |
setBorder(Border border)
Sets the given border on the LightweightSystem's root figure. |
void |
setContents(IFigure figure)
Sets the contents of the Viewport . |
void |
setFont(Font font)
|
void |
setHorizontalScrollBarVisibility(int v)
Sets the horizontal scrollbar visibility. |
void |
setScrollBarVisibility(int both)
Sets both the horizontal and vertical scrollbar visibility to the given value. |
void |
setVerticalScrollBarVisibility(int v)
Sets the vertical scrollbar visibility. |
void |
setViewport(Viewport vp)
Sets the Viewport. |
Methods inherited from class org.eclipse.swt.widgets.Canvas |
---|
drawBackground, getCaret, getIME, scroll, setCaret, setIME |
Methods inherited from class org.eclipse.swt.widgets.Composite |
---|
changed, checkSubclass, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList |
Methods inherited from class org.eclipse.swt.widgets.Scrollable |
---|
computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar |
Methods inherited from class org.eclipse.swt.widgets.Widget |
---|
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static int NEVER
public static int AUTOMATIC
public static int ALWAYS
Constructor Detail |
---|
public FigureCanvas(Composite parent)
DEFAULT_STYLES
.
parent
- the parentpublic FigureCanvas(Composite parent, int style)
parent
- the parent compositestyle
- see the class javadoc for optional stylespublic FigureCanvas(int style, Composite parent)
style
- see the class javadoc for required and optional stylesparent
- the parent compositepublic FigureCanvas(Composite parent, LightweightSystem lws)
DEFAULT_STYLES
.
parent
- the parentlws
- the LightweightSystempublic FigureCanvas(int style, Composite parent, LightweightSystem lws)
style
- see the class javadoc for required and optional stylesparent
- the parent compositelws
- the LightweightSystempublic FigureCanvas(Composite parent, int style, LightweightSystem lws)
parent
- the parent compositestyle
- look at class javadoc for valid styleslws
- the lightweight systemMethod Detail |
---|
public Point computeSize(int wHint, int hHint, boolean changed)
computeSize
in class Composite
Composite.computeSize(int, int, boolean)
public IFigure getContents()
Viewport
.public Font getFont()
getFont
in class Control
Control.getFont()
public int getHorizontalScrollBarVisibility()
public LightweightSystem getLightweightSystem()
public int getVerticalScrollBarVisibility()
public Viewport getViewport()
null
, a new one is created.
public void scrollSmoothTo(int x, int y)
x
- the x coordinate to scroll toy
- the y coordinate to scroll topublic void scrollTo(int x, int y)
scrollToY(int)
or scrollToX(int)
,
respectively, to increase performance.
x
- the x coordinate to scroll toy
- the y coordinate to scroll topublic void scrollToX(int hOffset)
hOffset
.
hOffset
- the new horizontal offsetpublic void scrollToY(int vOffset)
vOffset
.
vOffset
- the new vertical offsetpublic void setBorder(Border border)
border
- The new borderpublic void setContents(IFigure figure)
Viewport
.
figure
- the new contentspublic void setFont(Font font)
setFont
in class Canvas
Control.setFont(org.eclipse.swt.graphics.Font)
public void setHorizontalScrollBarVisibility(int v)
AUTOMATIC
, ALWAYS
, and NEVER
.
v
- the new visibilitypublic void setScrollBarVisibility(int both)
AUTOMATIC
, ALWAYS
, and
NEVER
.
both
- the new visibilitypublic void setVerticalScrollBarVisibility(int v)
AUTOMATIC
, ALWAYS
, and NEVER
.
v
- the new visibilitypublic void setViewport(Viewport vp)
new Viewport(true)
.
vp
- the new viewport
|
Eclipse Draw2d 3.8.0.201206011245 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |