net.sourceforge.geeboss.view
Class ViewForm

java.lang.Object
  org.eclipse.swt.widgets.Widget
      org.eclipse.swt.widgets.Control
          org.eclipse.swt.widgets.Scrollable
              org.eclipse.swt.widgets.Composite
                  net.sourceforge.geeboss.view.ViewForm

All Implemented Interfaces:

org.eclipse.swt.graphics.Drawable

public class ViewForm
extends org.eclipse.swt.widgets.Composite

Instances of this class implement a Composite that lays out three children horizontally and allows programmatic control of layout and border parameters. ViewForm is used in the workbench to implement 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.

Styles:

BORDER, FLAT

Events:

(None)

IMPORTANT: This class is not intended to be subclassed.

Field Summary

static org.eclipse.swt.graphics.RGB	mBorderInsideRGB Color of innermost line of drop shadow border.
static org.eclipse.swt.graphics.RGB	mBorderMiddleRGB Color of middle line of drop shadow border.
static org.eclipse.swt.graphics.RGB	mBorderOutsideRGB Color of outermost line of drop shadow border.
int	mMarginHeight marginHeight specifies the number of pixels of vertical margin that will be placed along the top and bottom edges of the form.
int	mMarginWidth marginWidth specifies the number of pixels of horizontal margin that will be placed along the left and right edges of the form.

Fields inherited from class org.eclipse.swt.widgets.Control

handle

Constructor Summary

ViewForm(org.eclipse.swt.widgets.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

org.eclipse.swt.graphics.Point	computeSize(int wHint, int hHint, boolean changed)
org.eclipse.swt.graphics.Rectangle	computeTrim(int x, int y, int width, int height)
org.eclipse.swt.graphics.Rectangle	getClientArea()
org.eclipse.swt.widgets.Control	getContent() Returns the content area.
org.eclipse.swt.widgets.Control	getTopCenter() Returns Control that appears in the top center of the pane.
org.eclipse.swt.widgets.Control	getTopLeft() Returns the Control that appears in the top left corner of the pane.
org.eclipse.swt.widgets.Control	getTopRight() Returns the control in the top right corner of the pane.
void	layout(boolean changed)
void	set3DBorderState(boolean show) Show / Hide the 3D Border of the ViewForm
void	setBorderVisible(boolean show) Specify whether the border should be displayed or not.
void	setContent(org.eclipse.swt.widgets.Control content) Sets the content.
void	setFont(org.eclipse.swt.graphics.Font f)
void	setLayout(org.eclipse.swt.widgets.Layout layout) Sets the layout which is associated with the receiver to be the argument which may be null.
void	setTopCenter(org.eclipse.swt.widgets.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(org.eclipse.swt.widgets.Control c) Set the control that appears in the top left corner of the pane.
void	setTopRight(org.eclipse.swt.widgets.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, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, setFocus, setLayoutDeferred, setTabList

Methods inherited from class org.eclipse.swt.widgets.Scrollable

getHorizontalBar, getVerticalBar

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, computeSize, forceFocus, getAccessible, getBackground, getBorderWidth, getBounds, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, setBackground, setBounds, setBounds, setCapture, setCursor, setEnabled, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, 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

mBorderInsideRGB

public static org.eclipse.swt.graphics.RGB mBorderInsideRGB

Color of innermost line of drop shadow border.

mBorderMiddleRGB

public static org.eclipse.swt.graphics.RGB mBorderMiddleRGB

Color of middle line of drop shadow border.

mBorderOutsideRGB

public static org.eclipse.swt.graphics.RGB mBorderOutsideRGB

Color of outermost line of drop shadow border.

mMarginHeight

public int mMarginHeight

marginHeight specifies the number of pixels of vertical margin that will be placed along the top and bottom edges of the form. The default value is 0.

mMarginWidth

public int mMarginWidth

marginWidth specifies the number of pixels of horizontal margin that will be placed along the left and right edges of the form. The default value is 0.

Constructor Detail

ViewForm

public ViewForm(org.eclipse.swt.widgets.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 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.

Parameters:

parent - a widget which will be the parent of the new instance (cannot be null)

style - the style of widget to construct

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

org.eclipse.swt.SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent

See Also:

SWT.BORDER, SWT.FLAT, Widget.getStyle()

Method Detail

computeSize

public org.eclipse.swt.graphics.Point computeSize(int wHint,
                                                  int hHint,
                                                  boolean changed)

Overrides:

computeSize in class org.eclipse.swt.widgets.Composite

computeTrim

public org.eclipse.swt.graphics.Rectangle computeTrim(int x,
                                                      int y,
                                                      int width,
                                                      int height)

Overrides:

computeTrim in class org.eclipse.swt.widgets.Scrollable

getClientArea

public org.eclipse.swt.graphics.Rectangle getClientArea()

Overrides:

getClientArea in class org.eclipse.swt.widgets.Scrollable

getContent

public org.eclipse.swt.widgets.Control getContent()

Returns the content area.

Returns:

the control in the content area of the pane or null

getTopCenter

public org.eclipse.swt.widgets.Control getTopCenter()

Returns Control that appears in the top center of the pane. Typically this is a toolbar.

Returns:

the control in the top center of the pane or null

getTopLeft

public org.eclipse.swt.widgets.Control getTopLeft()

Returns the Control that appears in the top left corner of the pane. Typically this is a label such as CLabel.

Returns:

the control in the top left corner of the pane or null

getTopRight

public org.eclipse.swt.widgets.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.

Returns:

the control in the top right corner of the pane or null

layout

public void layout(boolean changed)

Overrides:

layout in class org.eclipse.swt.widgets.Composite

set3DBorderState

public void set3DBorderState(boolean show)

Show / Hide the 3D Border of the ViewForm

Parameters:

show - If true, show the 3D Boreder

setBorderVisible

public void setBorderVisible(boolean show)

Specify whether the border should be displayed or not.

Parameters:

show - true if the border should be displayed

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setContent

public void setContent(org.eclipse.swt.widgets.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.

Parameters:

content - the control to be displayed in the content area or null

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
• ERROR_INVALID_ARGUMENT - if the control is not a child of this ViewForm

setFont

public void setFont(org.eclipse.swt.graphics.Font f)

Overrides:

setFont in class org.eclipse.swt.widgets.Control

setLayout

public void setLayout(org.eclipse.swt.widgets.Layout layout)

Sets the layout which is associated with the receiver to be the argument which may be null.

Note : ViewForm does not use a layout class to size and position its children.

Overrides:

setLayout in class org.eclipse.swt.widgets.Composite

Parameters:

layout - the receiver's new layout or null

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setTopCenter

public void setTopCenter(org.eclipse.swt.widgets.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.

Parameters:

topCenter - the control to be displayed in the top center or null

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
• ERROR_INVALID_ARGUMENT - if the control is not a child of this ViewForm

setTopCenterSeparate

public 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.

Parameters:

show - true if the topCenter will always appear on a separate line by itself

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setTopLeft

public void setTopLeft(org.eclipse.swt.widgets.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.

Parameters:

c - the control to be displayed in the top left corner or null

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
• ERROR_INVALID_ARGUMENT - if the control is not a child of this ViewForm

setTopRight

public void setTopRight(org.eclipse.swt.widgets.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.

Parameters:

c - the control to be displayed in the top right corner or null

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
• ERROR_INVALID_ARGUMENT - if the control is not a child of this ViewForm