dsto.dfc.swt.forms
Class FormPanel

java.lang.Object
  org.eclipse.swt.widgets.Widget
      org.eclipse.swt.widgets.Control
          org.eclipse.swt.widgets.Scrollable
              org.eclipse.swt.widgets.Composite
                  dsto.dfc.swt.forms.FormPanel

All Implemented Interfaces:

PipeErrorHandler, org.eclipse.swt.graphics.Drawable

public abstract class FormPanel
extends org.eclipse.swt.widgets.Composite
implements PipeErrorHandler

Utility base class for panels that uses the pipes framework to handle form editing. Clients connect their controls using the connect () methods or by using the root "formPipe" pipe directly and then use setFormValue(Object)to load the value into the form.

Version:

$Revision$

Author:

mpp

See Also:

Forms, Pipes

Field Summary

protected MultiPipe

formPipe

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

handle

Constructor Summary

FormPanel(org.eclipse.swt.widgets.Composite parent, int style)

Method Summary

void	commit()
protected PropertyPipe	connect(String property, Pipe target) Connect a property to a target using a PropertyPipe.
protected TextEndpoint	connect(String property, org.eclipse.swt.custom.StyledText textField)
protected TextEndpoint	connect(String property, org.eclipse.swt.widgets.Text textField) Shortcut for Pipes.connect(Pipe, String, Text).
void	dispose()
void	handlePipeError(Pipe source, String message) Called when an error occurs when loading/unloading the pipe.
protected void	performFlush()
protected void	setFormValue(Object value) The the value being edited by the form.

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

changed, checkSubclass, computeSize, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList

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

computeTrim, getBorderWidth, getClientArea, getHorizontalBar, getVerticalBar

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

addControlListener, addDragDetectListener, addFocusListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getRegion, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setRegion, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update

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

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

formPipe

protected MultiPipe formPipe

Constructor Detail

FormPanel

public FormPanel(org.eclipse.swt.widgets.Composite parent,
                 int style)

Method Detail

dispose

public void dispose()

Overrides:

dispose in class org.eclipse.swt.widgets.Widget

commit

public void commit()

setFormValue

protected void setFormValue(Object value)

The the value being edited by the form.

Parameters:

value -

connect

protected TextEndpoint connect(String property,
                               org.eclipse.swt.widgets.Text textField)

Shortcut for Pipes.connect(Pipe, String, Text).

connect

protected TextEndpoint connect(String property,
                               org.eclipse.swt.custom.StyledText textField)

connect

protected PropertyPipe connect(String property,
                               Pipe target)

Connect a property to a target using a PropertyPipe.

performFlush

protected void performFlush()

handlePipeError

public void handlePipeError(Pipe source,
                            String message)

Called when an error occurs when loading/unloading the pipe. Subclasses may override to add better error reporting (currently reports a log diagnostic).

Specified by:

handlePipeError in interface PipeErrorHandler