dsto.dfc.swt.forms
Class RadioEndpoint

java.lang.Object
  extended by dsto.dfc.swt.forms.AbstractPipe
      extended by dsto.dfc.swt.forms.PipeEndpoint
          extended by dsto.dfc.swt.forms.RadioEndpoint
All Implemented Interfaces:
Pipe, Disposable, EventListener, org.eclipse.swt.events.SelectionListener, org.eclipse.swt.internal.SWTEventListener

public class RadioEndpoint
extends PipeEndpoint
implements org.eclipse.swt.events.SelectionListener

A pipe endpoint that allows selection of a value from a list of radio buttons.

Version:
$Revision$
Author:
mpp

Field Summary
 
Fields inherited from class dsto.dfc.swt.forms.AbstractPipe
errorHandler, parent
 
Constructor Summary
RadioEndpoint(org.eclipse.swt.widgets.Composite parent, ValueLabel[] valueLabels)
          Create a new instance.
 
Method Summary
 void dispose()
          Default implementation: does nothing.
 boolean flush()
          Cause any uncommitted changes to any pipe segments in the tree to be pushed back into the pipe sequence (using Pipe.output(Object)).
 void focus()
           
 org.eclipse.swt.widgets.Button getButton(int index)
           
 Object getValue()
          Get the selected value.
 boolean input(Object newValue)
          Input a value into the pipe tree.
 boolean isDisposed()
          Test if pipe has been disposed.
 void widgetDefaultSelected(org.eclipse.swt.events.SelectionEvent e)
           
 void widgetSelected(org.eclipse.swt.events.SelectionEvent e)
           
 
Methods inherited from class dsto.dfc.swt.forms.PipeEndpoint
connect, output
 
Methods inherited from class dsto.dfc.swt.forms.AbstractPipe
getParent, handlePipeError, setErrorHandler, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RadioEndpoint

public RadioEndpoint(org.eclipse.swt.widgets.Composite parent,
                     ValueLabel[] valueLabels)
Create a new instance.

Parameters:
parent - The parent control to place the radio buttons in.
valueLabels - An array of value/label pairs corresponding to the radio button labels/data values.
Method Detail

dispose

public void dispose()
Description copied from class: AbstractPipe
Default implementation: does nothing.

Specified by:
dispose in interface Pipe
Specified by:
dispose in interface Disposable
Overrides:
dispose in class AbstractPipe

isDisposed

public boolean isDisposed()
Description copied from interface: Pipe
Test if pipe has been disposed.

Specified by:
isDisposed in interface Pipe

focus

public void focus()

getValue

public Object getValue()
Get the selected value.


input

public boolean input(Object newValue)
Description copied from interface: Pipe
Input a value into the pipe tree.

Specified by:
input in interface Pipe
Specified by:
input in class PipeEndpoint
Returns:
True if the operation completed successfully.
See Also:
for more info on handling errors.

flush

public boolean flush()
Description copied from interface: Pipe
Cause any uncommitted changes to any pipe segments in the tree to be pushed back into the pipe sequence (using Pipe.output(Object)). This is designed for use by pipes connect editors such as text fields that are not committed immediately: most pipes will simply forward this call on to their children.

Specified by:
flush in interface Pipe
Specified by:
flush in class PipeEndpoint
Returns:
True if the operation completed successfully.
See Also:
for more info on handling errors.

getButton

public org.eclipse.swt.widgets.Button getButton(int index)

widgetSelected

public void widgetSelected(org.eclipse.swt.events.SelectionEvent e)
Specified by:
widgetSelected in interface org.eclipse.swt.events.SelectionListener

widgetDefaultSelected

public void widgetDefaultSelected(org.eclipse.swt.events.SelectionEvent e)
Specified by:
widgetDefaultSelected in interface org.eclipse.swt.events.SelectionListener


Copyright © 2008 Commonwealth of Australia