net.sourceforge.rssowl.controller
Class ViewForm

java.lang.Object
  Composite
      net.sourceforge.rssowl.controller.ViewForm

public class ViewForm
extends 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

private int	BORDER_BOTTOM
private int	BORDER_LEFT
private int	BORDER_RIGHT
private int	BORDER_TOP
private Control	content
private boolean	draw3DBorder
private int	drawLine1
private int	drawLine2
private boolean	isToolBarMode
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.
private static int	OFFSCREEN
private Rectangle	oldArea
private boolean	onlyBorderBottom
private boolean	onlyBorderTop
private boolean	onlyBorderTopBottom
private boolean	separateTopCenter
private boolean	showBorder
private Control	topCenter
private Control	topLeft SWT widgets
private Control	topRight

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

(package private) static int	checkStyle(int style)
Point	computeSize(int wHint, int hHint, boolean changed)
Rectangle	computeTrim(int x, int y, int width, int height)
Rectangle	getClientArea()
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	layout(boolean changed)
(package private) void	onDispose()
(package private) void	onPaint(GC gc)
(package private) void	onResize()
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(Control content, boolean layout) Sets the content.
void	setFont(Font f)
void	setLayout(Layout layout) Sets the layout which is associated with the receiver to be the argument which may be null.
void	setOnlyBorderBottom(boolean onlyBorderBottom) Set that the ViewForm should only paint a single border on bottom.
void	setOnlyBorderTop(boolean onlyBorderTop) Set that the ViewForm should only paint a single border on top.
void	setOnlyBorderTopBottom(boolean onlyBorderTopBottom) Set that the ViewForm should only paint a single border on top and bottom.
void	setToolBarMode(boolean isToolBarMode)
void	setTopCenter(Control topCenter, boolean layout) Set the control that appears in the top center of the pane.
void	setTopCenterSeparate(boolean show, boolean layout) 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, boolean layout) Set the control that appears in the top left corner of the pane.
void	setTopRight(Control c, boolean layout) Set the control that appears in the top right corner of the pane.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OFFSCREEN

private static final int OFFSCREEN

See Also:

Constant Field Values

marginHeight

public int marginHeight

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.

marginWidth

public int marginWidth

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.

BORDER_BOTTOM

private int BORDER_BOTTOM

BORDER_LEFT

private int BORDER_LEFT

BORDER_RIGHT

private int BORDER_RIGHT

BORDER_TOP

private int BORDER_TOP

content

private Control content

draw3DBorder

private boolean draw3DBorder

drawLine1

private int drawLine1

drawLine2

private int drawLine2

isToolBarMode

private boolean isToolBarMode

oldArea

private Rectangle oldArea

onlyBorderBottom

private boolean onlyBorderBottom

onlyBorderTop

private boolean onlyBorderTop

onlyBorderTopBottom

private boolean onlyBorderTopBottom

separateTopCenter

private boolean separateTopCenter

showBorder

private boolean showBorder

topCenter

private Control topCenter

topLeft

private Control topLeft

SWT widgets

topRight

private Control topRight

Constructor Detail

ViewForm

public ViewForm(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

SWTException -

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

See Also:

SWT#BORDER, SWT#FLAT, #getStyle()

Method Detail

checkStyle

static int checkStyle(int style)

computeSize

public Point computeSize(int wHint,
                         int hHint,
                         boolean changed)

computeTrim

public Rectangle computeTrim(int x,
                             int y,
                             int width,
                             int height)

getClientArea

public Rectangle getClientArea()

getContent

public Control getContent()

Returns the content area.

Returns:

the control in the content area of the pane or null

getTopCenter

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

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:

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(Control content,
                       boolean layout)

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

layout - If TRUE, layout the ViewForm

Throws:

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(Font f)

setLayout

public void setLayout(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.

Parameters:

layout - the receiver's new layout or null

Throws:

SWTException -

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

setOnlyBorderBottom

public void setOnlyBorderBottom(boolean onlyBorderBottom)

Set that the ViewForm should only paint a single border on bottom. This hint does only work when SWT.FLAT is also passed to the ViewForm.

Parameters:

onlyBorderBottom - If TRUE only paint a single, bottom border

setOnlyBorderTop

public void setOnlyBorderTop(boolean onlyBorderTop)

Set that the ViewForm should only paint a single border on top. This hint does only work when SWT.FLAT is also passed to the ViewForm.

Parameters:

onlyBorderTop - If TRUE only paint a single, top border

setOnlyBorderTopBottom

public void setOnlyBorderTopBottom(boolean onlyBorderTopBottom)

Set that the ViewForm should only paint a single border on top and bottom. This hint does only work when SWT.FLAT is also passed to the ViewForm.

Parameters:

onlyBorderTopBottom - If TRUE only paint a single, bottom border

setToolBarMode

public void setToolBarMode(boolean isToolBarMode)

Parameters:

isToolBarMode - If TRUE, switch ViewForm into ToolBar Mode. In ToolBar Mode the visual presentation of the Center Control is different from the normal Mode.

setTopCenter

public void setTopCenter(Control topCenter,
                         boolean layout)

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

layout - If TRUE, layout the ViewForm

Throws:

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,
                                 boolean layout)

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

layout - If TRUE, layout the ViewForm

Throws:

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(Control c,
                       boolean layout)

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

layout - If TRUE, layout the ViewForm

Throws:

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(Control c,
                        boolean layout)

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

layout - If TRUE, layout the ViewForm

Throws:

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

onDispose

void onDispose()

onPaint

void onPaint(GC gc)

onResize

void onResize()