|
|||||||||
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.custom.ViewForm
public class ViewForm
Instances of this class implement a Composite that positions and sizes children and allows programmatic control of layout and border parameters. ViewForm is used in the workbench to lay out a view's label/menu/toolbar local bar.
Note that although this class is a subclass of Composite
,
it does not make sense to set a layout on it.
IMPORTANT: This class is not intended to be subclassed.
Field Summary | |
---|---|
static RGB |
borderInsideRGB
Deprecated. |
static RGB |
borderMiddleRGB
Deprecated. |
static RGB |
borderOutsideRGB
Deprecated. |
int |
horizontalSpacing
horizontalSpacing specifies the number of pixels between the right edge of one cell and the left edge of its neighbouring cell to the right. |
int |
marginHeight
marginHeight specifies the number of pixels of vertical margin that will be placed along the top and bottom edges of the form. |
int |
marginWidth
marginWidth specifies the number of pixels of horizontal margin that will be placed along the left and right edges of the form. |
int |
verticalSpacing
verticalSpacing specifies the number of pixels between the bottom edge of one cell and the top edge of its neighbouring cell underneath. |
Fields inherited from class org.eclipse.swt.widgets.Composite |
---|
embeddedHandle |
Fields inherited from class org.eclipse.swt.widgets.Widget |
---|
handle |
Constructor Summary | |
---|---|
ViewForm(Composite parent,
int style)
Constructs a new instance of this class given its parent and a style value describing its behavior and appearance. |
Method Summary | |
---|---|
Rectangle |
computeTrim(int x,
int y,
int width,
int height)
Given a desired client area for the receiver (as described by the arguments), returns the bounding rectangle which would be required to produce that client area. |
Rectangle |
getClientArea()
Returns a rectangle which describes the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings"). |
Control |
getContent()
Returns the content area. |
Control |
getTopCenter()
Returns Control that appears in the top center of the pane. |
Control |
getTopLeft()
Returns the Control that appears in the top left corner of the pane. |
Control |
getTopRight()
Returns the control in the top right corner of the pane. |
void |
setBorderVisible(boolean show)
Specify whether the border should be displayed or not. |
void |
setContent(Control content)
Sets the content. |
void |
setLayout(Layout layout)
Sets the layout which is associated with the receiver to be the argument which may be null. |
void |
setTopCenter(Control topCenter)
Set the control that appears in the top center of the pane. |
void |
setTopCenterSeparate(boolean show)
If true, the topCenter will always appear on a separate line by itself, otherwise the topCenter will appear in the top row if there is room and will be moved to the second row if required. |
void |
setTopLeft(Control c)
Set the control that appears in the top left corner of the pane. |
void |
setTopRight(Control c)
Set the control that appears in the top right corner of the pane. |
Methods inherited from class org.eclipse.swt.widgets.Composite |
---|
changed, checkSubclass, computeSize, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayoutDeferred, setTabList |
Methods inherited from class org.eclipse.swt.widgets.Scrollable |
---|
getBorderWidth, getHorizontalBar, 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, setData, setData, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public int marginWidth
public int marginHeight
public int horizontalSpacing
public int verticalSpacing
public static RGB borderInsideRGB
public static RGB borderMiddleRGB
public static RGB borderOutsideRGB
Constructor Detail |
---|
public ViewForm(Composite parent, int style)
The style value is either one of the style constants defined in
class SWT
which is applicable to instances of this
class, or must be built by bitwise OR'ing together
(that is, using the int
"|" operator) two or more
of those SWT
style constants. The class description
lists the style constants that are applicable to the class.
Style bits are also inherited from superclasses.
parent
- a widget which will be the parent of the new instance (cannot be null)style
- the style of widget to construct
java.lang.IllegalArgumentException
- SWTException
- SWT.BORDER
,
SWT.FLAT
,
Widget.getStyle()
Method Detail |
---|
public Rectangle computeTrim(int x, int y, int width, int height)
Scrollable
In other words, it returns a rectangle such that, if the receiver's bounds were set to that rectangle, the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings") would be the rectangle described by the arguments (relative to the receiver's parent).
computeTrim
in class Scrollable
x
- the desired x coordinate of the client areay
- the desired y coordinate of the client areawidth
- the desired width of the client areaheight
- the desired height of the client area
Scrollable.getClientArea()
public Rectangle getClientArea()
Scrollable
getClientArea
in class Composite
Scrollable.computeTrim(int, int, int, int)
public Control getContent()
public Control getTopCenter()
public Control getTopLeft()
public Control getTopRight()
public void setContent(Control content)
content
- the control to be displayed in the content area or null
SWTException
- public void setLayout(Layout layout)
Note: No Layout can be set on this Control because it already manages the size and position of its children.
setLayout
in class Composite
layout
- the receiver's new layout or null
SWTException
- public void setTopCenter(Control topCenter)
topCenter
- the control to be displayed in the top center or null
SWTException
- public void setTopLeft(Control c)
c
- the control to be displayed in the top left corner or null
SWTException
- public void setTopRight(Control c)
c
- the control to be displayed in the top right corner or null
SWTException
- public void setBorderVisible(boolean show)
show
- true if the border should be displayed
SWTException
- public void setTopCenterSeparate(boolean show)
show
- true if the topCenter will always appear on a separate line by itself
SWTException
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |