org.eclipse.scada.vi.ui.draw2d.primitives

Class FigureController

java.lang.Object

org.eclipse.scada.vi.ui.draw2d.primitives.FigureController

All Implemented Interfaces:

Controller

Direct Known Subclasses:

ChartController, FigureContainerController, ImageController, ShapeController, TextController

public abstract class FigureController
extends java.lang.Object
implements Controller

A figure controller

This figure controller needs to know when the figure it controls was added or removed. Since draw2d does not provide a "addRemovedListener" for IFigure but a IFigure#removeNotify() that can be overridden it is the responsibility of the implementing controller to call start() and stop() when the implementing IFigure#addNotify() and IFigure#removeNotify() get called. So create your figure like the following snippet shows:

IFigure figure = new PolylineShape () {
    public void addNotify () {
        super.addNotify ();
        start (); // FigureController.start ();
    }

    public void removeNotify () {
        stop (); // FigureController.stop ();
        super.removeNotify ();
    }
};
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FigureController.ClickHandlerImpl
static class	FigureController.SWTCursors

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceManager	manager

Constructor Summary

Constructors

Constructor and Description
FigureController(SymbolController controller, ResourceManager manager)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	applyCommon(Figure figure)
protected org.eclipse.draw2d.geometry.Dimension	create(Dimension dimension)
protected Color	createColor(RGB rgb)
protected org.eclipse.swt.graphics.Cursor	getCursor(java.lang.String cursor)
IFigure	getFigure() Return the figure that should be added to the parent
Dimension	getPreferredSize()
protected abstract IFigure	getPropertyFigure() Get the figure that is used for controlling the properties of this controller.
protected void	handleOnClick(MouseEvent me)
protected void	handleOnDoubleClick(MouseEvent me)
protected Border	makeBorder(java.lang.String border) Create a new border
protected org.eclipse.scada.vi.ui.draw2d.primitives.FigureController.ColorHandler	makeColorHandler(java.lang.String color, org.eclipse.scada.vi.ui.draw2d.primitives.FigureController.ColorApplier applier)
protected java.util.Map<java.lang.String,java.lang.String>	parseBorderArguments(java.lang.String singleArgumentName, java.lang.String border)
void	setBackgroundColor(java.lang.String color)
void	setBorder(java.lang.String border)
protected void	setColor(java.lang.Object key, org.eclipse.scada.vi.ui.draw2d.primitives.FigureController.ColorHandler colorHandler)
void	setCursor(java.lang.String cursor)
void	setForegroundColor(java.lang.String color)
void	setHeight(double height)
abstract void	setOpaque(java.lang.Boolean flag)
protected void	setOpaque(java.lang.Boolean flag, boolean defaultValue)
void	setPreferredHeight(double value)
void	setPreferredSize(double width, double height)
void	setPreferredSize(org.eclipse.draw2d.geometry.Dimension size)
void	setPreferredWidth(double value)
void	setSize(double width, double height)
void	setSize(org.eclipse.draw2d.geometry.Dimension size)
void	setToolTip(java.lang.String string)
void	setVisible(boolean flag)
void	setWidth(double width)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

manager

protected final ResourceManager manager

Constructor Detail

FigureController

public FigureController(SymbolController controller,
                ResourceManager manager)

Method Detail

getPropertyFigure

protected abstract IFigure getPropertyFigure()

Get the figure that is used for controlling the properties of this controller.

The figure returned is by default the same as the getFigure(). But in some cases it might be necessary to return a different figure.

Returns:

the figure that should the attributes applied

getFigure

public IFigure getFigure()

Description copied from interface: Controller

Return the figure that should be added to the parent

Specified by:

getFigure in interface Controller

Returns:

the figure to use for visualization

applyCommon

protected void applyCommon(Figure figure)

setToolTip

public void setToolTip(java.lang.String string)

setCursor

public void setCursor(java.lang.String cursor)

getCursor

protected org.eclipse.swt.graphics.Cursor getCursor(java.lang.String cursor)

handleOnDoubleClick

protected void handleOnDoubleClick(MouseEvent me)

handleOnClick

protected void handleOnClick(MouseEvent me)

setPreferredSize

public void setPreferredSize(double width,
                    double height)

setPreferredSize

public void setPreferredSize(org.eclipse.draw2d.geometry.Dimension size)

setSize

public void setSize(org.eclipse.draw2d.geometry.Dimension size)

setSize

public void setSize(double width,
           double height)

setWidth

public void setWidth(double width)

setHeight

public void setHeight(double height)

getPreferredSize

public Dimension getPreferredSize()

setPreferredWidth

public void setPreferredWidth(double value)

setPreferredHeight

public void setPreferredHeight(double value)

setBorder

public void setBorder(java.lang.String border)

setBackgroundColor

public void setBackgroundColor(java.lang.String color)

setForegroundColor

public void setForegroundColor(java.lang.String color)

setColor

protected void setColor(java.lang.Object key,
            org.eclipse.scada.vi.ui.draw2d.primitives.FigureController.ColorHandler colorHandler)

start

public void start()

stop

public void stop()

setVisible

public void setVisible(boolean flag)

setOpaque

public abstract void setOpaque(java.lang.Boolean flag)

setOpaque

protected void setOpaque(java.lang.Boolean flag,
             boolean defaultValue)

makeBorder

protected Border makeBorder(java.lang.String border)

Create a new border

 3
 GROUP:x
 COMPOUND:[GROUP:2|GROUP:3]
 

Parameters:

border -

Returns:

a new border

parseBorderArguments

protected java.util.Map<java.lang.String,java.lang.String> parseBorderArguments(java.lang.String singleArgumentName,
                                                                    java.lang.String border)

create

protected org.eclipse.draw2d.geometry.Dimension create(Dimension dimension)

makeColorHandler

protected org.eclipse.scada.vi.ui.draw2d.primitives.FigureController.ColorHandler makeColorHandler(java.lang.String color,
                                                                                       org.eclipse.scada.vi.ui.draw2d.primitives.FigureController.ColorApplier applier)

createColor

protected Color createColor(RGB rgb)