acm.graphics
Interface GContainer

All Known Implementing Classes:

GCanvas, GCompound

public interface GContainer

Defines the functionality of an object that can serve as the parent of a GObject.

Field Summary

int	BACK_TO_FRONT Specifies that iterators should run from back to front
int	FRONT_TO_BACK Specifies that iterators should run from front to back

Method Summary

void	add(GObject gobj) Adds a new graphical object to this container.
void	add(GObject gobj, double x, double y) Adds the graphical object to this canvas and sets its location to the point (x, y).
void	add(GObject gobj, GPoint pt) Adds the graphical object to this canvas and sets its location to the specified point.
GObject	getElement(int index) Returns the graphical object at the specified index, numbering from back to front in the the z dimension.
GObject	getElementAt(double x, double y) Returns the topmost graphical object that contains the point (x, y), or null if no such object exists.
GObject	getElementAt(GPoint pt) Returns the topmost graphical object that contains the specified point, or null if no such object exists.
int	getElementCount() Returns the number of graphical objects stored in this GCanvas.
void	remove(GObject gobj) Removes a graphical object from this container.
void	removeAll() Removes all graphical objects from this container.

Field Detail

public static final int BACK_TO_FRONT

Specifies that iterators should run from back to front

public static final int FRONT_TO_BACK

Specifies that iterators should run from front to back

Method Detail

public void add(GObject gobj)

Adds a new graphical object to this container.

Usage:

gc.add(gobj);

Parameter:

gobj	The graphical object to add

public void add(GObject gobj, double x, double y)

Adds the graphical object to this canvas and sets its location to the point (x, y).

Usage:

gc.add(gobj, x, y);

Parameters:

gobj	The graphical object to add
x	The new x-coordinate for the object
y	The new y-coordinate for the object

public void add(GObject gobj, GPoint pt)

Adds the graphical object to this canvas and sets its location to the specified point.

Usage:

gc.add(gobj, pt);

Parameters:

gobj	The graphical object to add
pt	A GPoint object giving the coordinates of the point

public GObject getElement(int index)

Returns the graphical object at the specified index, numbering from back to front in the the z dimension.

Usage:

GObject gobj = gc.getElement(index);

Parameter:

index

The index of the component to return

Returns:

The graphical object at the specified index

public GObject getElementAt(double x, double y)

Returns the topmost graphical object that contains the point (x, y), or null if no such object exists.

Usage:

GObject gobj = gc.getElementAt(x, y);

Parameters:

x	The x-coordinate of the point being tested
y	The y-coordinate of the point being tested

Returns:

The graphical object at the specified location, or nullif no such object exists.

public GObject getElementAt(GPoint pt)

Returns the topmost graphical object that contains the specified point, or null if no such object exists.

Usage:

GObject gobj = gc.getElementAt(pt);

Parameter:

pt	The coordinates being tested

Returns:

The graphical object at the specified location, or nullif no such object exists

public int getElementCount()

Returns the number of graphical objects stored in this GCanvas.

Usage:	int n = gc.getElementCount();
Returns:	The number of graphical objects in this GCanvas

public void remove(GObject gobj)

Removes a graphical object from this container.

Usage:

gc.remove(gobj);

Parameter:

gobj	The graphical object to remove

public void removeAll()

Removes all graphical objects from this container.

Usage:

gc.removeAll();