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 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 ();
    }
};
 

Author:

Jens Reimann

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FigureController.SWTCursors

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.jface.resource.ResourceManager	manager

Constructor Summary

Constructors

Constructor and Description
FigureController(SymbolController controller, org.eclipse.jface.resource.ResourceManager manager)

Method Summary

Modifier and Type	Method and Description
protected void	applyCommon(Figure figure)
protected org.eclipse.draw2d.geometry.Dimension	create(Dimension dimension)
protected org.eclipse.swt.graphics.Color	createColor(org.eclipse.swt.graphics.RGB rgb)
protected org.eclipse.swt.graphics.Cursor	getCursor(String cursor)
org.eclipse.draw2d.IFigure	getFigure() Return the figure that should be added to the parent
Dimension	getPreferredSize()
protected abstract org.eclipse.draw2d.IFigure	getPropertyFigure() Get the figure that is used for controlling the properties of this controller.
void	handleMouseDragged(org.eclipse.draw2d.MouseEvent me)
void	handleMouseEntered(org.eclipse.draw2d.MouseEvent me)
void	handleMouseExited(org.eclipse.draw2d.MouseEvent me)
void	handleMouseHover(org.eclipse.draw2d.MouseEvent me)
void	handleMouseMoved(org.eclipse.draw2d.MouseEvent me)
protected void	handleOnClick(org.eclipse.draw2d.MouseEvent me)
protected void	handleOnDoubleClick(org.eclipse.draw2d.MouseEvent me)
protected org.eclipse.draw2d.Border	makeBorder(String border) Create a new border
protected org.eclipse.scada.vi.ui.draw2d.primitives.FigureController.ColorHandler	makeColorHandler(String color, org.eclipse.scada.vi.ui.draw2d.primitives.FigureController.ColorApplier applier)
protected static Map<String,String>	parseBorderArguments(String singleArgumentName, String border)
void	setBackgroundColor(String color)
void	setBorder(String border)
protected void	setColor(Object key, org.eclipse.scada.vi.ui.draw2d.primitives.FigureController.ColorHandler colorHandler)
void	setCursor(String cursor) Set a cursor for the figure The name of the cursor must be one of the FigureController.SWTCursors enum.
void	setForegroundColor(String color)
void	setHeight(double height)
abstract void	setOpaque(Boolean flag)
protected void	setOpaque(Boolean flag, boolean defaultValue)
void	setPreferredHeight(double value)
void	setPreferredSize(org.eclipse.draw2d.geometry.Dimension size)
void	setPreferredSize(double width, double height)
void	setPreferredWidth(double value)
void	setSize(org.eclipse.draw2d.geometry.Dimension size)
void	setSize(double width, double height)
void	setToolTip(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 org.eclipse.jface.resource.ResourceManager manager

Constructor Detail

FigureController

public FigureController(SymbolController controller,
                        org.eclipse.jface.resource.ResourceManager manager)

Method Detail

getPropertyFigure

protected abstract org.eclipse.draw2d.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 org.eclipse.draw2d.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(String string)

setCursor

public void setCursor(String cursor)

Set a cursor for the figure
The name of the cursor must be one of the FigureController.SWTCursors enum.

Parameters:

cursor - the name of the cursor

getCursor

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

handleOnDoubleClick

protected void handleOnDoubleClick(org.eclipse.draw2d.MouseEvent me)

handleOnClick

protected void handleOnClick(org.eclipse.draw2d.MouseEvent me)

handleMouseMoved

public void handleMouseMoved(org.eclipse.draw2d.MouseEvent me)

handleMouseHover

public void handleMouseHover(org.eclipse.draw2d.MouseEvent me)

handleMouseExited

public void handleMouseExited(org.eclipse.draw2d.MouseEvent me)

handleMouseEntered

public void handleMouseEntered(org.eclipse.draw2d.MouseEvent me)

handleMouseDragged

public void handleMouseDragged(org.eclipse.draw2d.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(String border)

setBackgroundColor

public void setBackgroundColor(String color)

setForegroundColor

public void setForegroundColor(String color)

setColor

protected void setColor(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(Boolean flag)

setOpaque

protected void setOpaque(Boolean flag,
                         boolean defaultValue)

makeBorder

protected org.eclipse.draw2d.Border makeBorder(String border)

Create a new border

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

Parameters:

border -

Returns:

a new border

parseBorderArguments

protected static Map<String,String> parseBorderArguments(String singleArgumentName,
                                                         String border)

create

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

makeColorHandler

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

createColor

protected org.eclipse.swt.graphics.Color createColor(org.eclipse.swt.graphics.RGB rgb)