fr.lri.swingstates.canvas

Class CWidget

java.lang.Object

fr.lri.swingstates.canvas.CShape

fr.lri.swingstates.canvas.CWidget

All Implemented Interfaces:

CElement, GraphicalShape, java.lang.Cloneable

Direct Known Subclasses:

CDynamicWidget

public class CWidget
extends CShape

A widget shape for use with an Canvas. Like any other canvas shape type, it can be rendered in a smcanvas and interaction with it can be described in a state machine. It is built on any JComponent and, thus, can have its own listener.

WARNING:

1. The underlying widget is refreshed each time it receives an input event.
2. When the underlying widget dynamically creates other widgets (such as a JComboBox which brings up a JPopupMenu, the behaviour can not be satisfying.

This following code makes a button "ok" at location (10, 10) rotated by pi in a smcanvas.

 JButton ok = new JButton("ok");
 CShape smw = canvas.newWidget(ok, 100, 100, 50, 15).rotateBy(Math.PI/2);
 

Now, let's see how to manage interaction with the button ok:

1.  ok.addActionListener(new ActionListener() {
                   public void actionPerformed(ActionEvent e) {
                           System.out.println("OK");
                   }
    });
    

   Clicking on the button ok causes the message "OK" written on standard output.

2.  StateMachine sm = new StateMachine() {
                   public State colorButton = new State() {
                           Transition click = new ClickOnShape(BUTTON1) { 
                                   public void action(){
                                           getShape().setFillPaint(Color.RED);
                                   }
                           };
                   };
    };
    canvas.attach(sm);
    

   Clicking on the button ok fills it in red AND causes the message "OK" written on standard output.

3.  ((CWidget)smw).setBasicListener(false);
    

   Clicking on the button just fills it in red.

4.  smw.setPickable(false);
    

   Clicking on the button does anything.

5.  ((CWidget)smw).setBasicListener(true);
    

   Clicking on the button just causes the message "OK" written on standard output.

Author:

Caroline Appert

Constructor Summary

Constructors

Constructor and Description
CWidget(javax.swing.JComponent w) Builds a CWidget based on a swing component.
CWidget(javax.swing.JComponent w, double x, double y) Builds a CWidget based on a swing component.
CWidget(javax.swing.JComponent w, double x, double y, double width, double height) Builds a CWidget based on a swing component.

Method Summary

Methods

Modifier and Type	Method and Description
CShape	copyTo(CShape sms) Copies this widget into a destination widget.
CShape	duplicate() Creates a new copy of this shape and returns it.
javax.swing.JComponent	getWidget()
boolean	isBasicListener() Tests if this smwidget's listeners are or are not notified by input events.
void	paint(java.awt.Graphics g) Paints the shape.
void	setBasicListener(boolean basicListener) Sets this smwidget's listeners be notified or not by input events.
CElement	setFillPaint(java.awt.Paint fp) Sets the fill Paint, which is used to display the interior of the shape when it is filled.
CElement	widgetChanged() Requests a refresh of the CWidget.

Methods inherited from class fr.lri.swingstates.canvas.CShape

above, aboveAll, addChild, addGhost, addTag, addTag, addTag, addTo, animate, asEllipse, asImage, asPolyLine, asRectangle, asRectangularShape, asText, attachSM, below, belowAll, canvasToShape, canvasToShapeRef, clone, contains, contains, contains, contains, detachSM, duplicateWithTags, firstShape, fixReferenceShapeToCurrent, getAbsShape, getAbsTransform, getAntialiasedShapes, getBoundingBox, getCanvas, getCenterX, getCenterY, getChild, getChildren, getChildrenCount, getClip, getFilledShapes, getFillPaint, getFirstAntialiasedShape, getFirstFilledShape, getFirstHavingTag, getFirstOutlinedShape, getGhost, getHeight, getHierarchy, getIntersection, getMaxX, getMaxY, getMinX, getMinY, getOutlinedShapes, getOutlinePaint, getParent, getReferenceX, getReferenceY, getRenderingHint, getRotation, getScaleX, getScaleY, getShape, getStroke, getSubtraction, getTags, getTransform, getTranslateX, getTranslateY, getTransparencyFill, getTransparencyOutline, getWidth, hasTag, hasTag, indexOf, intersects, isAbove, isAntialiased, isBelow, isDrawable, isFilled, isOnOutline, isOutlined, isPickable, isPicked, pick, pickStyle, remove, removeAllChildren, removeChild, removeChild, removeGhost, removeTag, removeTag, rotateBy, rotateTo, scaleBy, scaleBy, scaleTo, scaleTo, setAntialiased, setClip, setDrawable, setFilled, setOutlined, setOutlinePaint, setParent, setPickable, setReferencePoint, setReferencePoint, setRenderingHint, setShape, setStroke, setTransformToIdentity, setTransparencyFill, setTransparencyFill, setTransparencyOutline, setTransparencyOutline, shapeToCanvas, translateBy, translateTo

Methods inherited from class java.lang.Object

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

Constructor Detail

CWidget

public CWidget(javax.swing.JComponent w)

Builds a CWidget based on a swing component.

Parameters:

w - The component.

CWidget

public CWidget(javax.swing.JComponent w,
       double x,
       double y)

Builds a CWidget based on a swing component.

Parameters:

w - The component.

x - The x coordinate of the upper left point of the bounding box.

y - The y coordinate of the upper left point of the bounding box.

CWidget

public CWidget(javax.swing.JComponent w,
       double x,
       double y,
       double width,
       double height)

Builds a CWidget based on a swing component.

Parameters:

w - The component.

x - The x coordinate of the upper left point of the bounding box.

y - The y coordinate of the upper left point of the bounding box.

width - The width of the bounding box.

height - The height of the bounding box.

Method Detail

widgetChanged

public CElement widgetChanged()

Requests a refresh of the CWidget. Actually, a CWidget is repainted only when an input event occurs on it.

Returns:

this CWidget.

setFillPaint

public CElement setFillPaint(java.awt.Paint fp)

Sets the fill Paint, which is used to display the interior of the shape when it is filled.

Specified by:

setFillPaint in interface CElement

Overrides:

setFillPaint in class CShape

Parameters:

fp - The fill Paint.

Returns:

this shape.

See Also:

CShape.setFillPaint(Paint)

paint

public void paint(java.awt.Graphics g)

Paints the shape. Normally this method need not be called, since the canvas paints the display list automatically.

Overrides:

paint in class CShape

Parameters:

g - The graphics with which the shape must be painted.

isBasicListener

public boolean isBasicListener()

Tests if this smwidget's listeners are or are not notified by input events.

Returns:

true if this smwidget's listeners are notified by input events, false, if they are not.

setBasicListener

public void setBasicListener(boolean basicListener)

Sets this smwidget's listeners be notified or not by input events.

Parameters:

basicListener - True, if this smwidget's listeners must be notified by input events, false, if not.

copyTo

public CShape copyTo(CShape sms)

Copies this widget into a destination widget.

Overrides:

copyTo in class CShape

Parameters:

sms - The destination shape

Returns:

this shape

See Also:

CShape.copyTo(fr.lri.swingstates.canvas.CShape)

duplicate

public CShape duplicate()

Creates a new copy of this shape and returns it.

Overrides:

duplicate in class CShape

Returns:

the copy.

See Also:

CShape.duplicateWithTags()

getWidget

public javax.swing.JComponent getWidget()

Returns:

The underlying JComponent widget.