org.povclipse2.dialogs.flow

Class AbstractFlowWidget

java.lang.Object

Canvas

org.povclipse2.dialogs.flow.AbstractFlowWidget

Direct Known Subclasses:

ColormapWidget

public abstract class AbstractFlowWidget
extends Canvas

Abstract base class for flow widgets.
A flow widget consists of a drawing area and flow entries.
Flow entries can be added and deleted, they have a value in the rage of 0.0 and 1.0 (both inclusive) and a flow objects.
The object values inbetween two flow entries are calculated by morphing one flow object into the next one.

Author:

Wolfgang Möstl

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	ARROW_LENGHT
protected Color	blackColor
protected Color	clickareaBackgroundColor
protected Color	clickareaBackgroundColorDragging
protected IFlowEntry	draggingEntry
protected java.text.NumberFormat	floatFormatter
protected int	flowHeight
protected int	flowWidth
protected Color	handleColorTwo
protected int	leftWidth
protected Color	linkageColor
protected static int	POSITION_HALF_HEIGTH
protected static int	POSITION_HEIGTH
protected int	rightWidth
protected int	topHeight

Constructor Summary

Constructors

Constructor and Description
AbstractFlowWidget(Composite parent, int style, int flowHeight, int flowWidth, boolean changeable) Constructor

Method Summary

Modifier and Type	Method and Description
void	addFlowEntry(IFlowEntry entry) Adds a new FlowEntry.
Point	calcPreferredSize() Calculates the perferred size of this widget.
Point	computeSize(int wHint, int hHint)
protected MenuItem	createMenuItem(Menu parent, int style, java.lang.String text, Image icon, int accel, boolean enabled, java.lang.String callback) Creates a menu item
protected void	doAddEntry() Performs the popop-menu command "Add"
protected void	doDeleteEntry() Performs the popop-menu command "Delete"
abstract java.util.List<ColorData>	getEntries()
protected abstract java.lang.String	getFlowEntryName()
int	getFlowHeight()
java.util.List<IFlowEntry>	getFlowList()
int	getFlowWidth()
Color	getInternalBorderColor()
int	getInternalBorderWidth()
int	getLeftWidth()
int	getRightWidth()
protected abstract void	handleObjectClick(IFlowEntry entry) Opens a dialog used for editing the FlowEntry object.
protected java.lang.Double	handlePositionClick(IFlowEntry entry) Calls the FlowEntryValueDialog.
boolean	hasEntries()
protected void	init(Composite parent) Initilalizes the widget.
void	mouseDoubleClick(MouseEvent e)
void	mouseDown(MouseEvent e) Sets the dragging item and the popup menu text for the "Delete" menu item
void	mouseMove(MouseEvent e)
void	mouseUp(MouseEvent e) Performs the dragging and calling the value and object editor dialogs.
protected abstract IFlowEntry	newInitialFlowEntry()
void	paintControl(PaintEvent e) Paints the control.
protected abstract Rectangle	paintEntryObject(GC gc, IFlowEntry entry, Point lineHook, int lastHeightPosition) Paints the FlowEntry object.
protected abstract void	paintFlowArea(GC gc) Paints the complete flow area
protected void	registerCallback(MenuItem mi, java.lang.Object handler, java.lang.String handlerName) Adds a new SelectionListener to the given MenuItem, which calls the handler method using Java reflection.
abstract void	setEntries(java.util.List<ColorData> list)
void	setFlowHeight(int flowHeight)
void	setFlowWidth(int flowWidth)
void	setInternalBorderColor(Color internalBorderColor)
void	setInternalBorderWidth(int internalBorderWidth)
void	setLeftWidth(int leftWidth)
void	setRightWidth(int rightWidth)
void	setSizeUpdater(ISizeUpdater sizeUpdater) Sets the ISizeUpdater to be notified if the widget size has been changed.

Methods inherited from class java.lang.Object

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

Field Detail

POSITION_HEIGTH

protected static final int POSITION_HEIGTH

See Also:

Constant Field Values

POSITION_HALF_HEIGTH

protected static final int POSITION_HALF_HEIGTH

See Also:

Constant Field Values

ARROW_LENGHT

protected static final int ARROW_LENGHT

See Also:

Constant Field Values

floatFormatter

protected java.text.NumberFormat floatFormatter

topHeight

protected int topHeight

flowHeight

protected int flowHeight

flowWidth

protected int flowWidth

leftWidth

protected int leftWidth

rightWidth

protected int rightWidth

blackColor

protected Color blackColor

linkageColor

protected Color linkageColor

clickareaBackgroundColor

protected Color clickareaBackgroundColor

clickareaBackgroundColorDragging

protected Color clickareaBackgroundColorDragging

handleColorTwo

protected Color handleColorTwo

draggingEntry

protected IFlowEntry draggingEntry

Constructor Detail

AbstractFlowWidget

public AbstractFlowWidget(Composite parent,
                          int style,
                          int flowHeight,
                          int flowWidth,
                          boolean changeable)

Constructor

Parameters:

parent - The sidgets parent composite

style - The SWT style bits, only those for Canvas widgets are supported.

flowHeight - The height of the flow bar

flowWidth - The width of the flow bar

changeable - true to enable the mouse listeners, false to have the widget in a read-only mode.

Method Detail

computeSize

public Point computeSize(int wHint,
                         int hHint)

paintFlowArea

protected abstract void paintFlowArea(GC gc)

Paints the complete flow area

Parameters:

gc - The GC to be used for the drawing.

paintEntryObject

protected abstract Rectangle paintEntryObject(GC gc,
                                              IFlowEntry entry,
                                              Point lineHook,
                                              int lastHeightPosition)

Paints the FlowEntry object. This has to be done at the right of the flow drawing area, as the left side is occupied by the FlowEntry value drawing.

Parameters:

gc - The GC to be used for the drawing

entry - The FlowEntry who's object is to be drawn.

lineHook - a Point identifying the last pixel of the entries line

lastHeightPosition - The y coordinate the last FlowEntry object painting has been done.

Returns:

a Rectangle identifying the palace beeing sensible for user clicks. Clicking into this area results in showing the object editing dialog.

handleObjectClick

protected abstract void handleObjectClick(IFlowEntry entry)

Opens a dialog used for editing the FlowEntry object.

Parameters:

entry - The FlowEntry to be edited.

getFlowEntryName

protected abstract java.lang.String getFlowEntryName()

Returns:

The name of FlowEntry implementation.

newInitialFlowEntry

protected abstract IFlowEntry newInitialFlowEntry()

Returns:

A newly created and initialized FlowEntry.

setEntries

public abstract void setEntries(java.util.List<ColorData> list)

Parameters:

list - A list of object beeing used as map initializer.

getEntries

public abstract java.util.List<ColorData> getEntries()

Returns:

The list of entries.

init

protected void init(Composite parent)

Initilalizes the widget.

Parameters:

parent - The parent Composite of this widget.

doAddEntry

protected void doAddEntry()

Performs the popop-menu command "Add"

doDeleteEntry

protected void doDeleteEntry()

Performs the popop-menu command "Delete"

createMenuItem

protected MenuItem createMenuItem(Menu parent,
                                  int style,
                                  java.lang.String text,
                                  Image icon,
                                  int accel,
                                  boolean enabled,
                                  java.lang.String callback)

Creates a menu item

Parameters:

parent - The Menu to hold the new MenuItem

style - The MenuItem SWT style bits

text - The tex to be displayed

icon - The icon to be shown

accel - The accelleration value to be used

enabled - true to enable and false to disable the new MenuItem

callback - The name of the callback method to be called when the menu item is selected.

Returns:

The enw created MenuItem.

registerCallback

protected void registerCallback(MenuItem mi,
                                java.lang.Object handler,
                                java.lang.String handlerName)

Adds a new SelectionListener to the given MenuItem, which calls the handler method using Java reflection.

Parameters:

mi - The MenuItem to receive the SelectionListener

handler - The Handler class implementing the handlerName

handlerName - The method name to be called by the listener.

getFlowList

public java.util.List<IFlowEntry> getFlowList()

Returns:

The List of IFlowEntry objects.

addFlowEntry

public void addFlowEntry(IFlowEntry entry)

Adds a new FlowEntry.

Parameters:

entry - the FlowEntry to be added.

hasEntries

public boolean hasEntries()

Returns:

true if the set of FlowEntries is not empty, false otherwise.

calcPreferredSize

public Point calcPreferredSize()

Calculates the perferred size of this widget.

Returns:

the perferred size of this widget.

mouseDoubleClick

public void mouseDoubleClick(MouseEvent e)

handlePositionClick

protected java.lang.Double handlePositionClick(IFlowEntry entry)

Calls the FlowEntryValueDialog.

Parameters:

entry - The IFlowEntry whose position is to be changed.

Returns:

The new position or NULL if the user cancels the dialog.

mouseDown

public void mouseDown(MouseEvent e)

Sets the dragging item and the popup menu text for the "Delete" menu item

See Also:

org.eclipse.swt.events.MouseListener#mouseDown(org.eclipse.swt.events.MouseEvent)

mouseUp

public void mouseUp(MouseEvent e)

Performs the dragging and calling the value and object editor dialogs.

See Also:

org.eclipse.swt.events.MouseListener#mouseUp(org.eclipse.swt.events.MouseEvent)

mouseMove

public void mouseMove(MouseEvent e)

paintControl

public void paintControl(PaintEvent e)

Paints the control.

See Also:

org.eclipse.swt.events.PaintListener#paintControl(org.eclipse.swt.events.PaintEvent)

getFlowHeight

public int getFlowHeight()

Returns:

The height of the flow area

setFlowHeight

public void setFlowHeight(int flowHeight)

Parameters:

flowHeight - The hight of the flow area to be used.

getFlowWidth

public int getFlowWidth()

Returns:

The width of the flow area

setFlowWidth

public void setFlowWidth(int flowWidth)

Parameters:

flowWidth - The width of the flow area to be used.

getInternalBorderColor

public Color getInternalBorderColor()

Returns:

The Color used for painting the flow area border.

setInternalBorderColor

public void setInternalBorderColor(Color internalBorderColor)

Parameters:

internalBorderColor - The Color to be used for paining the flow area border.

getInternalBorderWidth

public int getInternalBorderWidth()

Returns:

The width of the flow area border

setInternalBorderWidth

public void setInternalBorderWidth(int internalBorderWidth)

Parameters:

internalBorderWidth - The width of the flow area border.
values less than 1 deactivates the painting of the flow area border.

getLeftWidth

public int getLeftWidth()

Returns:

The size between the widget's left side and the flow area, that is the offset of the flow area.

setLeftWidth

public void setLeftWidth(int leftWidth)

Parameters:

leftWidth - The offset of the flow area. The leftWidth can not be smaller than the minLeftWidth.

getRightWidth

public int getRightWidth()

Returns:

The width from the right side of the flow area to the right side of the widet.

setRightWidth

public void setRightWidth(int rightWidth)

Parameters:

rightWidth - The size between the right side of the flow area and the widget's rigt side, that is the width the implementing class can be use for drawing the FlowEntries objects. The rightWidth can not be smaller than the minRightWidth.

setSizeUpdater

public void setSizeUpdater(ISizeUpdater sizeUpdater)

Sets the ISizeUpdater to be notified if the widget size has been changed.

Parameters:

sizeUpdater - The ISizeUpdater to be notified.