de.frame4j.graf

Class Tableau.Anchor

java.lang.Object

de.frame4j.graf.Tableau.Anchor

All Implemented Interfaces:

Serializable

Enclosing class:

Tableau

public class Tableau.Anchor
extends Object
implements Serializable

The anchorage of a Paintable element in the Tableau.

Anchor objects encapsulate the presence of Paintable objects including spot and dimension on the Tableau.

© Copyright 1998 - 2001, 2004 Albrecht Weinert

Version:

see embedding class

Author:

Albrecht Weinert

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Dimension	dim The element's dimension within the tableau.
protected Paintable	element The Paintable element &qout;moored".
protected Point	loc The element's spot (left upper corner) in the Tableau.

Constructor Summary

Constructors

Constructor and Description
Anchor(Paintable element, int x, int y, int width, int height) Constructor with setting; centred.
Anchor(Paintable element, Point loc, Dimension dim) Constructor with setting.
Anchor(Paintable element, Point loc, int width, int height) Constructor with setting.

Method Summary

Modifier and Type	Method and Description
Dimension	getDim() The element's dimension within the tableau.
Paintable	getElement() The Paintable element &qout;moored".
Point	getLoc() The element's spot (left upper corner) in the Tableau.
int	getX() The element's spot (left upper corner) in the Tableau, X coordinate.
int	getY() The element's spot (left upper corner) in the Tableau, Y coordinate.
boolean	isPaintable() Determine if paintable.
void	moveLoc(int dx, int dy) Move the spot.
void	newDim(int width, int height) Set the element's dimension within the tableau.
void	newLoc(int x, int y) Set the spot.
boolean	pointInside(Point p, int s) Is a point within this anchor.
void	setDim(Dimension dim) Set the element's dimension within the tableau.
void	setDim(int width, int height) Set the element's dimension within the tableau.
void	setElement(Paintable element) Set the Paintable element &qout;moored".
void	setLoc(int x, int y) Set the spot.
void	setLoc(Point loc) Set the spots.

Methods inherited from class java.lang.Object

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

Field Detail

element

protected Paintable element

The Paintable element &qout;moored".

loc

protected Point loc

The element's spot (left upper corner) in the Tableau.

See Also:

getLoc(), dim

dim

protected Dimension dim

The element's dimension within the tableau.

Like the spot the dimension will be handed to the elements paint method. And both will be used for assigning mouse events to elements.

Constructor Detail

Anchor

public Anchor(Paintable element,
              Point loc,
              Dimension dim)

Constructor with setting.

The parameters dim and loc won't get copied but taken as reference. Hence changes on them will affect all anchors and elements in question.
In other words: Such sharing allows scaling and moving multiple elements in one action.

Parameters:

element - the element paintable within the tableau

loc - its place (0,0) is left upper;
null will get (a new) (-100, -100), hence well outside.

dim - its dimensions;
null will be a new (0, 0), hence usually invisibly small.

Anchor

public Anchor(Paintable element,
              Point loc,
              int width,
              int height)

Constructor with setting.

This is like:
Anchor(element, loc, new Dimension(width, height)

Anchor

public Anchor(Paintable element,
              int x,
              int y,
              int width,
              int height)

Constructor with setting; centred.

The coordinate parameters x and y relate to the element's centre. The new Anchor's fields dim and loc will be made accordingly. The loc made in the end will as usual point to the element's upper left corner.

This is like:
Anchor(element, new Point ( x - width / 2, y - height / 2), width, height)

Parameters:

element - the element paintable within the tableau

x - its place (x, y) as centre of the element

y - its place (x, y) as centre of the element

width - the element's width

height - the element's height

Method Detail

getElement

public Paintable getElement()

The Paintable element &qout;moored".

setElement

public void setElement(Paintable element)

Set the Paintable element &qout;moored".

getLoc

public Point getLoc()

The element's spot (left upper corner) in the Tableau.

See Also:

getLoc(), dim

getX

public int getX()

The element's spot (left upper corner) in the Tableau, X coordinate.

See Also:

getLoc(), dim

getY

public int getY()

The element's spot (left upper corner) in the Tableau, Y coordinate.

See Also:

getLoc(), dim

setLoc

public void setLoc(Point loc)

Set the spots.

Parameters:

loc - will be taken as reference, (no copy/clone here)

See Also:

getLoc()

setLoc

public void setLoc(int x,
                   int y)

Set the spot.

The current spot (Point loc) will be changed to the parameter values x and y. No new Point object loc will be made. Is the object loc shared with other Anchor objects, those will move too.

Parameters:

x - coordinate

y - coordinate

See Also:

getLoc(), newLoc(int, int), setLoc(Point)

newLoc

public void newLoc(int x,
                   int y)

Set the spot.

The current spot (Point loc) will be changed to a new one made with the parameter values x and y. (A new Point object loc will be made.)
Is the previous object loc shared with other Anchor objects, those will not move.

Parameters:

x - coordinate

y - coordinate

See Also:

setLoc(int, int)

moveLoc

public void moveLoc(int dx,
                    int dy)

Move the spot.

The current spot (Point loc) will be changed relatively by adding the parameter values dx and dy. No new Point object loc will be made. Is the object loc being shared with other Anchor objects, those will move too.

Parameters:

dx - coordinate delta

dy - coordinate delta

getDim

public Dimension getDim()

The element's dimension within the tableau.

Like the spot the dimension will be handed to the elements paint method. And both will be used for assigning mouse events to elements.

setDim

public void setDim(Dimension dim)

Set the element's dimension within the tableau.

Parameters:

dim - this reference will be taken (no copy / clone will be made)

See Also:

setDim(int, int)

setDim

public void setDim(int width,
                   int height)

Set the element's dimension within the tableau.

The elements dimension will be changed without making a new Dimension object. If this dimension is shared with other elements they will see this change too.

Parameters:

width - size

height - size

See Also:

setDim(Dimension), newDim(int, int)

newDim

public void newDim(int width,
                   int height)

Set the element's dimension within the tableau.

The elements dimension will be changed by making a new Dimension object. If the previous dimension was shared with other elements those won't see this change.

See Also:

setDim(int, int), setDim(Dimension)

isPaintable

public boolean isPaintable()

Determine if paintable.

This method checks if this Anchor hold an element paintable within this tableau.

For the element to be considered paintable element, spot (loc) and dimension (dim) have to exist, and the rectangle described by loc and dim has to be within the tableau — at least partly: one pixel is enough.

Returns:

true: the anchored element is considered paintable

See Also:

dim, loc, element

pointInside

public boolean pointInside(Point p,
                           int s)

Is a point within this anchor.

This method checks if a point p lies with in the element's rectangle as given by loc and dim.
The parameter s gives a minimal width and height to which this rectangle will eventually be widened around its centre. This allows to "hit" comfortably element with 0-dimension respectively very small ones.

Parameters:

p - the point in question.

s - widening the "hit area" to at least s * s pixel (if smaller)

Returns:

true if the point is within the anchored rectangle (+ tolerance)