|
Eclipse Draw2d 3.3 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.ObjectCanvas
org.eclipse.draw2d.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 |
| 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,
LightweightSystem lws)
Constructs a new FigureCanvas with the given parent and LightweightSystem, using the #DEFAULT_STYLES. |
|
FigureCanvas(int style,
Composite parent,
LightweightSystem lws)
Constructor taking a lightweight system and SWT style, which is used verbatim. |
|
| Method Summary | |
org.eclipse.swt.graphics.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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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 parent
public FigureCanvas(Composite parent,
int style)
parent - the parent compositestyle - see the class javadoc for optional styles
public FigureCanvas(Composite parent,
LightweightSystem lws)
#DEFAULT_STYLES.
parent - the parentlws - the LightweightSystem
public FigureCanvas(int style,
Composite parent,
LightweightSystem lws)
style - see the class javadoc for required and optional stylesparent - the parent compositelws - the LightweightSystem| Method Detail |
public org.eclipse.swt.graphics.Point computeSize(int wHint,
int hHint,
boolean changed)
Compositepublic IFigure getContents()
Viewport.public Font getFont()
Controlpublic 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 to
public 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)
Controlpublic 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.3 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||