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 <code>Composite</code>, it does not make sense to set a layout on it. <dl> <dt>Styles:</dt> <dd>BORDER, FLAT</dd> <dt>Events:</dt> <dd>(None)</dd> </dl> IMPORTANT: This class is not intended to be subclassed.

@see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>

class ViewForm : Composite {

int marginWidth;

int marginHeight;

int horizontalSpacing;

int verticalSpacing;

RGB borderInsideRGB;

RGB borderMiddleRGB;

RGB borderOutsideRGB;

Control topLeft;

Control topCenter;

Control topRight;

Control content;

bool separateTopCenter;

bool showBorder;

int separator;

int borderTop;

int borderBottom;

int borderLeft;

int borderRight;

int highlight;

Point oldSize;

Color selectionBackground;

int OFFSCREEN;

int BORDER1_COLOR;

int SELECTION_BACKGROUND;

this(Composite parent, int style);

Control getContent();

Control getTopCenter();

Control getTopLeft();

Control getTopRight();

void setContent(Control content);

void setLayout(Layout layout);

void setTopCenter(Control topCenter);

void setTopLeft(Control c);

void setTopRight(Control c);

void setBorderVisible(bool show);

void setTopCenterSeparate(bool show);

}

Constructors

this this(Composite parent, int style): Constructs a new instance of this class given its parent and a style value describing its behavior and appearance. The style value is either one of the style constants defined in class <code>SWT</code> which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the <code>int</code> "|" operator) two or more of those <code>SWT</code> style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Members

Functions

getContent Control getContent(): Returns the content area. * @return the control in the content area of the pane or null
getTopCenter Control getTopCenter(): Returns Control that appears in the top center of the pane. Typically this is a toolbar. * @return the control in the top center of the pane or null
getTopLeft Control getTopLeft(): Returns the Control that appears in the top left corner of the pane. Typically this is a label such as CLabel. * @return the control in the top left corner of the pane or null
getTopRight Control getTopRight(): Returns the control in the top right corner of the pane. Typically this is a Close button or a composite with a Menu and Close button. * @return the control in the top right corner of the pane or null
setBorderVisible void setBorderVisible(bool show): Specify whether the border should be displayed or not. * @param show true if the border should be displayed * @exception SWTException <ul> <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> </ul>
setContent void setContent(Control content): Sets the content. Setting the content to null will remove it from the pane - however, the creator of the content must dispose of the content. * @param content the control to be displayed in the content area or null * @exception SWTException <ul> <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> <li>ERROR_INVALID_ARGUMENT - if the control is not a child of this ViewForm</li> </ul>
setLayout void setLayout(Layout layout): Sets the layout which is associated with the receiver to be the argument which may be null. Note: No Layout can be set on this Control because it already manages the size and position of its children.
setTopCenter void setTopCenter(Control topCenter): Set the control that appears in the top center of the pane. Typically this is a toolbar. The topCenter is optional. Setting the topCenter to null will remove it from the pane - however, the creator of the topCenter must dispose of the topCenter. * @param topCenter the control to be displayed in the top center or null * @exception SWTException <ul> <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> <li>ERROR_INVALID_ARGUMENT - if the control is not a child of this ViewForm</li> </ul>
setTopCenterSeparate void setTopCenterSeparate(bool 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. * @param show true if the topCenter will always appear on a separate line by itself * @exception SWTException <ul> <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> </ul>
setTopLeft void setTopLeft(Control c): Set the control that appears in the top left corner of the pane. Typically this is a label such as CLabel. The topLeft is optional. Setting the top left control to null will remove it from the pane - however, the creator of the control must dispose of the control. * @param c the control to be displayed in the top left corner or null * @exception SWTException <ul> <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> <li>ERROR_INVALID_ARGUMENT - if the control is not a child of this ViewForm</li> </ul>
setTopRight void setTopRight(Control c): Set the control that appears in the top right corner of the pane. Typically this is a Close button or a composite with a Menu and Close button. The topRight is optional. Setting the top right control to null will remove it from the pane - however, the creator of the control must dispose of the control. * @param c the control to be displayed in the top right corner or null * @exception SWTException <ul> <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> <li>ERROR_INVALID_ARGUMENT - if the control is not a child of this ViewForm</li> </ul>

Static variables

borderInsideRGB RGB borderInsideRGB;: Color of innermost line of drop shadow border.
borderMiddleRGB RGB borderMiddleRGB;: Color of middle line of drop shadow border.
borderOutsideRGB RGB borderOutsideRGB;: Color of outermost line of drop shadow border.

Variables

horizontalSpacing 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.
marginHeight int marginHeight;: marginHeight specifies the number of pixels of vertical margin that will be placed along the top and bottom edges of the form.
marginWidth int marginWidth;: marginWidth specifies the number of pixels of horizontal margin that will be placed along the left and right edges of the form.
verticalSpacing int verticalSpacing;: verticalSpacing specifies the number of pixels between the bottom edge of one cell and the top edge of its neighbouring cell underneath.

Inherited Members

From Composite

changed void changed(Control[] changed): Clears any data that has been cached by a Layout for all widgets that are in the parent hierarchy of the changed control up to and including the receiver. If an ancestor does not have a layout, it is skipped.
getBackgroundMode int getBackgroundMode(): Returns the receiver's background drawing mode. This will be one of the following constants defined in class <code>SWT</code>: <code>INHERIT_NONE</code>, <code>INHERIT_DEFAULT</code>, <code>INHERTIT_FORCE</code>.
getChildren Control[] getChildren(): Returns a (possibly empty) array containing the receiver's children. Children are returned in the order that they are drawn. The topmost control appears at the beginning of the array. Subsequent controls draw beneath this control and appear later in the array. Note: This is not the actual structure used by the receiver to maintain its list of children, so modifying the array will not affect the receiver.
getLayout Layout getLayout(): Returns layout which is associated with the receiver, or null if one has not been set.
getLayoutDeferred bool getLayoutDeferred(): Returns <code>true</code> if the receiver has deferred the performing of layout, and <code>false</code> otherwise.
getTabList Control[] getTabList(): Gets the (possibly empty) tabbing order for the control.
isLayoutDeferred bool isLayoutDeferred(): Returns <code>true</code> if the receiver or any ancestor up to and including the receiver's nearest ancestor shell has deferred the performing of layouts. Otherwise, <code>false</code> is returned.
layout void layout(): If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the receiver does not have a layout, do nothing. This is equivalent to calling <code>layout(true)</code>. Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.
layout void layout(bool changed): If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the argument is <code>true</code> the layout must not rely on any information it has cached about the immediate children. If it is <code>false</code> the layout may (potentially) optimize the work it is doing by assuming that none of the receiver's children has changed state since the last layout. If the receiver does not have a layout, do nothing. If a child is resized as a result of a call to layout, the resize event will invoke the layout of the child. The layout will cascade down through all child widgets in the receiver's widget tree until a child is encountered that does not resize. Note that a layout due to a resize will not flush any cached information (same as <code>layout(false)</code>). Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.
layout void layout(bool changed, bool all): If the receiver has a layout, asks the layout to lay out (that is, set the size and location of) the receiver's children. If the changed argument is <code>true</code> the layout must not rely on any information it has cached about its children. If it is <code>false</code> the layout may (potentially) optimize the work it is doing by assuming that none of the receiver's children has changed state since the last layout. If the all argument is <code>true</code> the layout will cascade down through all child widgets in the receiver's widget tree, regardless of whether the child has changed size. The changed argument is applied to all layouts. If the all argument is <code>false</code>, the layout will not cascade down through all child widgets in the receiver's widget tree. However, if a child is resized as a result of a call to layout, the resize event will invoke the layout of the child. Note that a layout due to a resize will not flush any cached information (same as <code>layout(false)</code>). Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.
layout void layout(Control[] changed): Forces a lay out (that is, sets the size and location) of all widgets that are in the parent hierarchy of the changed control up to and including the receiver. The layouts in the hierarchy must not rely on any information cached about the changed control or any of its ancestors. The layout may (potentially) optimize the work it is doing by assuming that none of the peers of the changed control have changed state since the last layout. If an ancestor does not have a layout, skip it. Note: Layout is different from painting. If a child is moved or resized such that an area in the parent is exposed, then the parent will paint. If no child is affected, the parent will not paint.
setBackgroundMode void setBackgroundMode(int mode): Sets the background drawing mode to the argument which should be one of the following constants defined in class <code>SWT</code>: <code>INHERIT_NONE</code>, <code>INHERIT_DEFAULT</code>, <code>INHERIT_FORCE</code>.
setLayout void setLayout(Layout layout): Sets the layout which is associated with the receiver to be the argument which may be null.
setLayoutDeferred void setLayoutDeferred(bool defer): If the argument is <code>true</code>, causes subsequent layout operations in the receiver or any of its children to be ignored. No layout of any kind can occur in the receiver or any of its children until the flag is set to false. Layout operations that occurred while the flag was <code>true</code> are remembered and when the flag is set to <code>false</code>, the layout operations are performed in an optimized manner. Nested calls to this method are stacked.
setTabList void setTabList(Control[] tabList): Sets the tabbing order for the specified controls to match the order that they occur in the argument list.