acm.program

Class GraphicsProgram

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Panel

java.applet.Applet

javax.swing.JApplet

acm.program.Program

acm.program.GraphicsProgram

All Implemented Interfaces:

GCanvasInterface, acm.io.IOModel, GraphicsProgramInterface, ProgramInterface, ActionListener, AdjustmentListener, ComponentListener, ContainerListener, FocusListener, ItemListener, KeyListener, MouseListener, MouseMotionListener, MouseWheelListener, TextListener, WindowFocusListener, WindowListener, WindowStateListener, ImageObserver, MenuContainer, Serializable, Iterable<GObject>, Runnable, EventListener, Accessible, ChangeListener, DocumentListener, ListDataListener, ListSelectionListener, MouseInputListener, PopupMenuListener, RootPaneContainer

public abstract class GraphicsProgram
extends Program
implements GraphicsProgramInterface, Iterable<GObject>

This class is a standard subclass of Program whose principal window is used for drawing graphics.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JApplet

JApplet.AccessibleJApplet

Nested classes/interfaces inherited from class java.applet.Applet

Applet.AccessibleApplet

Nested classes/interfaces inherited from class java.awt.Panel

Panel.AccessibleAWTPanel

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class acm.program.Program

CONFIG_FILE_NAME, invisibleObjects

Fields inherited from class javax.swing.JApplet

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface acm.program.ProgramInterface

CENTER, EAST, NORTH, SOUTH, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GraphicsProgram() Creates a new graphics program.

Method Summary

Modifier and Type	Method and Description
void	add(Component comp, double x, double y) Adds the component to the canvas and sets its location to the point ( x, y).
void	add(Component comp, GPoint pt) Adds the component to the canvas and sets its location to the specified point.
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 the canvas and sets its location to the point (x, y).
void	add(GObject gobj, GPoint pt) Adds the graphical object to the canvas and sets its location to the specified point.
void	addKeyListeners() Adds the program as a KeyListener to the canvas.
void	addKeyListeners(KeyListener listener) Adds the specified listener as a KeyListener to the canvas.
void	addMouseListeners() Adds the program as both a MouseListener and MouseMotionListener to the canvas.
void	addMouseListeners(EventListener listener) Adds the specified listener as a MouseListener and/or MouseMotionListener, as appropriate, to the canvas.
void	clear() Removes all graphical objects from this container.
void	clearCanvas() Removes all graphical objects from this container.
protected GCanvas	createGCanvas() Creates the GCanvas used by the GraphicsProgram .
protected void	endHook() Ensures that the window is repainted at the end of the program.
double	getCanvasHeight() Returns the height of the central canvas area.
Dimension	getCanvasSize() Returns the size of the central canvas area.
double	getCanvasWidth() Returns the width of the central canvas area.
<T extends GObject> T	getElement(int index) Returns the graphical object at the specified index, numbering from back to front in the the z dimension.
<T extends GObject> T	getElementAt(double... coords) This version of getElementAt accepts a variable number of coordinate pairs (in x1, y1, x2, y2, x3, y3, ...
<T extends GObject> T	getElementAt(double x, double y) Returns the topmost graphical object that contains the point ( x, y), or null if no such object exists.
<T extends GObject> T	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.
GCanvas	getGCanvas() Returns the GCanvas object used by this program.
boolean	hasElementAt(double... coords) Returns true if a graphical object exists that touches any of the given (x, y) pixel positions, or false if no such object exists.
boolean	hasElementAt(double x, double y) Returns true if a graphical object exists that touches the given (x, y) pixel position, or false if no such object exists.
void	init() Specifies the code to be executed as startup time before the run method is called.
boolean	isAntiAliasing() Sets whether this program's canvas uses anti-aliasing, which is smoothing and blending of neighboring pixels.
protected boolean	isStarted() Checks to see whether this program has started, usually by checking to see whether some pane exists.
Iterator<GObject>	iterator() Returns an Iterator that cycles through the elements within this container in the default direction, which is from back to front.
Iterator<GObject>	iterator(int direction) Returns an Iterator that cycles through the elements within this container in the specified direction, which must be one of the constants FRONT_TO_BACK or BACK_TO_FRONT from the GContainer interface.
void	remove(double x, double y) Removes the top-most graphical object at the given (x, y) position from this container.
void	remove(GObject gobj) Removes a graphical object from this container.
void	remove(GPoint pt) Removes the top-most graphical object at the given (x, y) position from this container.
void	removeAll() Removes all graphical objects from this container.
void	removeAll(double... coords) Removes all graphical objects at the given (x, y) positions from this container.
void	removeAll(double x, double y) Removes all graphical objects at the given (x, y) position from this container.
void	removeAll(GPoint pt) Removes all graphical objects at the given (x, y) position from this container.
void	removeAllComponents() Removes all components from this container.
void	repaint() Signals a need to repaint this window.
void	run() Specifies the code to be executed as the program runs.
void	setAntiAliasing(boolean antialias) Sets whether this program's canvas uses anti-aliasing, which is smoothing and blending of neighboring pixels.
void	setBackground(Color bg) Sets the background color of the GCanvas.
void	setCanvasHeight(double height) Sets this program to be exactly the right size so that its graphical canvas will be the given height in pixels.
void	setCanvasSize(double width, double height) Sets this program to be exactly the right size so that its graphical canvas will be the given size in pixels.
void	setCanvasWidth(double width) Sets this program to be exactly the right size so that its graphical canvas will be the given width in pixels.
void	setShowPixelInfo(boolean show) Sets whether to display information on this canvas about the current pixel where the mouse pointer is resting in this program's graphical canvas.
void	setSize(double width, double height) Sets this program to be exactly the right size so that its graphical canvas will be the given size in pixels.
void	setSize(int width, int height) Sets this program to be exactly the right size so that its graphical canvas will be the given size in pixels.
void	setWindowSize(double width, double height) Sets this program's window to be the given size in pixels.
static void	startGraphicsProgram(GObject gobj, String[] args) Creates a GraphicsProgram containing the specified GObject and then starts it.
BufferedImage	toImage() Returns an image representation of the current contents of the screen.
void	waitForClick() Waits for a mouse click in the window before proceeding.

Methods inherited from class acm.program.Program

actionPerformed, add, addActionListeners, addActionListeners, addActionListenersToButtonsOnly, addAllActionListeners, addExitHook, addImpl, adjustmentValueChanged, alert, alert, animation, center, changedUpdate, checkCompilerFlags, checkKill, checkStartupSettings, componentAdded, componentHidden, componentMoved, componentRemoved, componentResized, componentShown, confirm, contentsChanged, createConsole, createDialogIO, createMenuBar, createParameterTable, createProgramFrame, destroy, error, error, error, exit, fileExists, fileExists, fileExistsInsideJAR, fileExistsInsideJAR, fileExistsOnDisk, fileExistsOnDisk, fileSize, fileSize, focusGained, focusLost, getAnimationDelay, getAppletStub, getArgumentArray, getBoolean, getBoolean, getBoolean, getBorder, getBottomY, getCenterLocation, getCenterX, getCenterY, getCentralRegionSize, getConsole, getDialog, getDouble, getDouble, getDouble, getDouble, getHeight, getInputModel, getInteger, getInteger, getInteger, getInteger, getJFrame, getLayout, getLine, getLine, getMainThread, getMenuBar, getOutputColor, getOutputModel, getParameter, getParameterTable, getPreferredSize, getReader, getReal, getReal, getReal, getReal, getRegionPanel, getRightX, getScreenHeight, getScreenSize, getScreenWidth, getStartupObject, getTitle, getWidth, getWindow, getWriter, getYesOrNo, hasConfiguration, insertUpdate, intervalAdded, intervalRemoved, isAnimated, isApplet, isAppletMode, isExitOnClose, isInitialized, itemStateChanged, keyPressed, keyReleased, keyTyped, killMe, loadConfiguration, loadConfiguration, main, menuAction, menuCanceled, menuDeselected, menuSelected, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, openFile, openFile, openFileFromDisk, openFileFromDisk, openFileFromJAR, openFileFromJAR, pack, pause, pauseTick, popupMenuCanceled, popupMenuWillBecomeInvisible, popupMenuWillBecomeVisible, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, printf, println, println, println, println, println, println, println, println, println, println, println, println, println, println, println, println, println, prompt, readBoolean, readBoolean, readBoolean, readDouble, readDouble, readDouble, readDouble, readInt, readInt, readInt, readInt, readLine, readLine, remove, remove, removeFromRegion, removeMenuBar, removeUpdate, runHook, saveConfiguration, saveConfiguration, setAnimated, setAnimationDelay, setAppletStub, setBottomY, setCenterLocation, setCenterX, setCenterY, setConsole, setDialog, setExitOnClose, setFramesPerSecond, setHeight, setInputModel, setInvisible, setJFrame, setJMenuBar, setLayout, setLocation, setLocation, setOutputColor, setOutputModel, setParameter, setParameterTable, setPauseScaleFactor, setResizable, setRightX, setShowPixelGrid, setStartupObject, setTitle, setWidth, setX, setY, showErrorMessage, start, start, startAnimation, startHook, startRun, stateChanged, stopAnimation, textValueChanged, validate, valueChanged, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowGainedFocus, windowIconified, windowLostFocus, windowOpened, windowStateChanged

Methods inherited from class javax.swing.JApplet

createRootPane, getAccessibleContext, getContentPane, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isRootPaneCheckingEnabled, paramString, repaint, setContentPane, setGlassPane, setLayeredPane, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.applet.Applet

getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameterInfo, isActive, isValidateRoot, newAudioClip, play, play, resize, resize, setStub, showStatus, stop

Methods inherited from class java.awt.Panel

addNotify

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getListeners, getMaximumSize, getMinimumSize, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, revalidate, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface acm.program.ProgramInterface

exit, getTitle, pause, print, print, printf, println, println, println, setParameterTable, setStartupObject, setTitle, start, start

Methods inherited from interface acm.graphics.GCanvasInterface

getBackground, getFont, getHeight, getSize, getWidth, setFont, setSize

Methods inherited from interface java.awt.event.MouseListener

mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged, mouseMoved

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

GraphicsProgram

protected GraphicsProgram()

Creates a new graphics program.

Usage:

GraphicsProgram program = new GraphicsProgram();

Method Detail

add

public void add(GObject gobj)

Adds a new graphical object to this container.

Specified by:

add in interface GCanvasInterface

Parameters:

gobj - The graphical object to add

Usage:

add(gobj);

add

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

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

Specified by:

add in interface GCanvasInterface

Parameters:

gobj - The graphical object to add

x - The new x-coordinate for the object

y - The new y-coordinate for the object

Usage:

add(gobj, x, y);

add

public final void add(GObject gobj,
                      GPoint pt)

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

Specified by:

add in interface GCanvasInterface

Parameters:

gobj - The graphical object to add

pt - The new coordinates of the point

Usage:

add(gobj, pt);

add

public final void add(Component comp,
                      double x,
                      double y)

Adds the component to the canvas and sets its location to the point ( x, y).

Specified by:

add in interface GCanvasInterface

Parameters:

comp - The component to add

x - The new x-coordinate for the object

y - The new y-coordinate for the object

Usage:

add(comp, x, y);

add

public final void add(Component comp,
                      GPoint pt)

Adds the component to the canvas and sets its location to the specified point.

Specified by:

add in interface GCanvasInterface

Parameters:

comp - The component to add

pt - A GPoint object giving the coordinates of the point

Usage:

add(comp, pt);

addKeyListeners

public void addKeyListeners()

Adds the program as a KeyListener to the canvas.

Specified by:

addKeyListeners in interface GraphicsProgramInterface

Usage:

addKeyListeners();

addKeyListeners

public void addKeyListeners(KeyListener listener)

Adds the specified listener as a KeyListener to the canvas.

Specified by:

addKeyListeners in interface GraphicsProgramInterface

Parameters:

listener - A KeyListener object

Usage:

addKeyListeners(listener);

addMouseListeners

public void addMouseListeners()

Adds the program as both a MouseListener and MouseMotionListener to the canvas.

Specified by:

addMouseListeners in interface GraphicsProgramInterface

Usage:

addMouseListeners();

addMouseListeners

public void addMouseListeners(EventListener listener)

Adds the specified listener as a MouseListener and/or MouseMotionListener, as appropriate, to the canvas.

Specified by:

addMouseListeners in interface GraphicsProgramInterface

Parameters:

listener - A listener object that is either a MouseListener, a MouseMotionListener, or both

Usage:

addMouseListeners(listener);

clear

public void clear()

Removes all graphical objects from this container. Equivalent to removeAll but also clears pixel data.

Specified by:

clear in interface GCanvasInterface

Usage:

clear();

clearCanvas

public void clearCanvas()

Removes all graphical objects from this container. Equivalent to removeAll.

Specified by:

clearCanvas in interface GraphicsProgramInterface

Usage:

clearCanvas();

createGCanvas

protected GCanvas createGCanvas()

Creates the GCanvas used by the GraphicsProgram . Subclasses can override this method to create their own GCanvas types.

Returns:

The GCanvas to be inserted into the program

Usage:

GCanvas gc = program.createGCanvas();

Noshow:

endHook

protected void endHook()

Ensures that the window is repainted at the end of the program.

Overrides:

endHook in class Program

getCanvasHeight

public double getCanvasHeight()

Returns the height of the central canvas area.

Specified by:

getCanvasHeight in interface GraphicsProgramInterface

Returns:

the height of the central canvas area

getCanvasSize

public Dimension getCanvasSize()

Returns the size of the central canvas area.

Specified by:

getCanvasSize in interface GraphicsProgramInterface

Returns:

the size of the central canvas area

getCanvasWidth

public double getCanvasWidth()

Returns the width of the central canvas area.

Specified by:

getCanvasWidth in interface GraphicsProgramInterface

Returns:

the width of the central canvas area

getElementCount

public int getElementCount()

Returns the number of graphical objects stored in this GCanvas.

Specified by:

getElementCount in interface GCanvasInterface

Returns:

The number of graphical objects in this GCanvas

Usage:

int n = getElementCount();

getElement

public <T extends GObject> T getElement(int index)

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

Specified by:

getElement in interface GCanvasInterface

Parameters:

index - The index of the component to return

Returns:

The graphical object at the specified index

Usage:

GObject gobj = getElement(index);

getElementAt

public <T extends GObject> T getElementAt(double x,
                                          double y)

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

Specified by:

getElementAt in interface GCanvasInterface

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 null if no such object exists.

Usage:

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

getElementAt

public <T extends GObject> T getElementAt(double... coords)

This version of getElementAt accepts a variable number of coordinate pairs (in x1, y1, x2, y2, x3, y3, ... order) and will return the topmost graphical objectfound at any of these pairs. The pairs are checked in the order they are passed. If no graphical object is found at any of these coordinate pairs, null is returned.

Specified by:

getElementAt in interface GCanvasInterface

getElementAt

public final <T extends GObject> T getElementAt(GPoint pt)

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

Specified by:

getElementAt in interface GCanvasInterface

Parameters:

pt - The coordinates being tested

Returns:

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

Usage:

GObject gobj = program.getElementAt(pt);

getGCanvas

public GCanvas getGCanvas()

Returns the GCanvas object used by this program.

Specified by:

getGCanvas in interface GraphicsProgramInterface

Returns:

The GCanvas object used by the program

Usage:

GCanvas gc = getGCanvas();

hasElementAt

public boolean hasElementAt(double x,
                            double y)

Returns true if a graphical object exists that touches the given (x, y) pixel position, or false if no such object exists.

Specified by:

hasElementAt in interface GCanvasInterface

hasElementAt

public boolean hasElementAt(double... coords)

Returns true if a graphical object exists that touches any of the given (x, y) pixel positions, or false if no such object exists. This method accepts a variable number of coordinate pairs (in x1, y1, x2, y2, x3, y3, ... order). The pairs are checked in the order they are passed.

Specified by:

hasElementAt in interface GCanvasInterface

init

public void init()

Specifies the code to be executed as startup time before the run method is called. Subclasses can override this method to perform any initialization code that would ordinarily be included in an applet init method. In general, subclasses will override init in GUI-based programs where the program simply sets up an initial state and then waits for events from the user. The run method is required for applications in which there needs to be some control thread while the program runs, as in a typical animation.

Specified by:

init in interface ProgramInterface

Overrides:

init in class Program

Usage:

program.init();

isAntiAliasing

public boolean isAntiAliasing()

Sets whether this program's canvas uses anti-aliasing, which is smoothing and blending of neighboring pixels. Default true.

Specified by:

isAntiAliasing in interface GCanvasInterface

isStarted

protected boolean isStarted()

Checks to see whether this program has started, usually by checking to see whether some pane exists. Subclasses can override this method to ensure that their structures are visible before proceeding.

Overrides:

isStarted in class Program

Noshow:

iterator

public Iterator<GObject> iterator()

Returns an Iterator that cycles through the elements within this container in the default direction, which is from back to front. You can also run the iterator in the opposite direction by using the iterator(direction) form of this method.

Applets that want to run in browsers, however, should avoid using this method, because Iterator is not supported on 1.1 browsers. For maximum portability, you should rely instead on the getElementCount and getElement methods, which provide the same functionality in a browser-compatible way.

Specified by:

iterator in interface GCanvasInterface

Specified by:

iterator in interface Iterable<GObject>

Returns:

An Iterator ranging over the elements of the container from back to front

Usage:

Iterator i = iterator();

iterator

public Iterator<GObject> iterator(int direction)

Returns an Iterator that cycles through the elements within this container in the specified direction, which must be one of the constants FRONT_TO_BACK or BACK_TO_FRONT from the GContainer interface.

for (Iterator<GObject> i = iterator(direction); i.hasNext(); )

Applets that want to run in browsers, however, should avoid using this method, because Iterator is not supported on 1.1 browsers. For maximum portability, you should rely instead on the getElementCount and getElement methods, which provide the same functionality in a browser-compatible way.

Specified by:

iterator in interface GCanvasInterface

Returns:

An Iterator ranging over the elements of the container in the specified direction

Usage:

Iterator i = iterator(direction);

remove

public void remove(double x,
                   double y)

Removes the top-most graphical object at the given (x, y) position from this container. If no graphical object is located at that position, does nothing.

Specified by:

remove in interface GCanvasInterface

Usage:

remove(x, y);

remove

public void remove(GPoint pt)

Removes the top-most graphical object at the given (x, y) position from this container. If no graphical object is located at that position, does nothing.

Specified by:

remove in interface GCanvasInterface

Usage:

remove(pt);

remove

public void remove(GObject gobj)

Removes a graphical object from this container.

Specified by:

remove in interface GCanvasInterface

Parameters:

gobj - The graphical object to remove

Usage:

remove(gobj);

removeAll

public void removeAll()

Removes all graphical objects from this container. Note that this definition overrides the Container version of removeAll, which is replaced by removeAllComponents.

Specified by:

removeAll in interface GCanvasInterface

Overrides:

removeAll in class Program

Usage:

removeAll();

removeAll

public void removeAll(double x,
                      double y)

Removes all graphical objects at the given (x, y) position from this container. If no graphical objects are located at that position, does nothing.

Specified by:

removeAll in interface GCanvasInterface

Usage:

removeAll(x, y);

removeAll

public void removeAll(double... coords)

Removes all graphical objects at the given (x, y) positions from this container. If no graphical objects are located at that position, does nothing.

Specified by:

removeAll in interface GCanvasInterface

Usage:

removeAll(x1, y1, x2, y2, ...);

removeAll

public void removeAll(GPoint pt)

Removes all graphical objects at the given (x, y) position from this container. If no graphical objects are located at that position, does nothing.

Specified by:

removeAll in interface GCanvasInterface

Usage:

removeAll(pt);

removeAllComponents

public void removeAllComponents()

Removes all components from this container.

Specified by:

removeAllComponents in interface GraphicsProgramInterface

Usage:

removeAllComponents();

Noshow:

repaint

public void repaint()

Signals a need to repaint this window.

Specified by:

repaint in interface GCanvasInterface

Overrides:

repaint in class Program

Noshow:

run

public void run()

Specifies the code to be executed as the program runs. The run method is required for applications that have a thread of control that runs even in the absence of user actions, such as a program that uses console interation or that involves animation. GUI-based programs that operate by setting up an initial configuration and then wait for user events usually do not specify a run method and supply a new definition for init instead.

Specified by:

run in interface ProgramInterface

Specified by:

run in interface Runnable

Overrides:

run in class Program

setAntiAliasing

public void setAntiAliasing(boolean antialias)

Sets whether this program's canvas uses anti-aliasing, which is smoothing and blending of neighboring pixels. Default true.

Specified by:

setAntiAliasing in interface GCanvasInterface

setBackground

public void setBackground(Color bg)

Sets the background color of the GCanvas.

Specified by:

setBackground in interface GCanvasInterface

Overrides:

setBackground in class Program

Parameters:

bg - The new background color

Usage:

setBackground(bg);

Noshow:

setCanvasHeight

public void setCanvasHeight(double height)

Sets this program to be exactly the right size so that its graphical canvas will be the given height in pixels. This is often preferred over setHeight() because you'll know exactly how many pixels are available to you for drawing.

Specified by:

setCanvasHeight in interface GraphicsProgramInterface

Parameters:

height - the desired height of the drawing canvas, in pixels

setCanvasSize

public void setCanvasSize(double width,
                          double height)

Sets this program to be exactly the right size so that its graphical canvas will be the given size in pixels. This is often preferred over setSize() because you'll know exactly how many pixels are available to you for drawing.

Specified by:

setCanvasSize in interface GraphicsProgramInterface

Parameters:

width - the desired width of the drawing canvas, in pixels

height - the desired height of the drawing canvas, in pixels

setCanvasWidth

public void setCanvasWidth(double width)

Sets this program to be exactly the right size so that its graphical canvas will be the given width in pixels. This is often preferred over setWidth() because you'll know exactly how many pixels are available to you for drawing.

Specified by:

setCanvasWidth in interface GraphicsProgramInterface

Parameters:

width - the desired width of the drawing canvas, in pixels

setSize

public void setSize(double width,
                    double height)

Sets this program to be exactly the right size so that its graphical canvas will be the given size in pixels.

Specified by:

setSize in interface GraphicsProgramInterface

Overrides:

setSize in class Program

Parameters:

width - the desired width of the drawing canvas, in pixels

height - the desired height of the drawing canvas, in pixels

setShowPixelInfo

public void setShowPixelInfo(boolean show)

Sets whether to display information on this canvas about the current pixel where the mouse pointer is resting in this program's graphical canvas. Displays the current pixel's (x, y) coordinate and color.

Specified by:

setShowPixelInfo in interface GCanvasInterface

Overrides:

setShowPixelInfo in class Program

setSize

public void setSize(int width,
                    int height)

Sets this program to be exactly the right size so that its graphical canvas will be the given size in pixels.

Overrides:

setSize in class Component

Parameters:

width - the desired width of the drawing canvas, in pixels

height - the desired height of the drawing canvas, in pixels

setWindowSize

public void setWindowSize(double width,
                          double height)

Sets this program's window to be the given size in pixels.

Specified by:

setWindowSize in interface GraphicsProgramInterface

Parameters:

width - the desired width of the window, in pixels

height - the desired height of the window, in pixels

startGraphicsProgram

public static void startGraphicsProgram(GObject gobj,
                                        String[] args)
                                 throws Throwable

Creates a GraphicsProgram containing the specified GObject and then starts it. This code is called only by the start method in GObject.

Parameters:

gobj - The object to be inserted into the GraphicsProgram

args - The array of arguments

Throws:

Throwable

Usage:

startGraphicsProgram(gobj, args);

Noshow:

toImage

public BufferedImage toImage()

Returns an image representation of the current contents of the screen.

Specified by:

toImage in interface GCanvasInterface

waitForClick

public void waitForClick()

Waits for a mouse click in the window before proceeding.

Specified by:

waitForClick in interface GraphicsProgramInterface

Usage:

waitForClick();