objectdraw
Class Controller

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Panel
              java.applet.Applet
                  javax.swing.JApplet
                      objectdraw.Controller

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable

Direct Known Subclasses:

FrameController, WindowController

public class Controller

extends javax.swing.JApplet

Controller is a Swing compatible class designed to be extended to produce programs that employ a GUI but do not include graphics displayed in a DrawingCanvas. To write such a program, a programmer should extend this class defining a begin method that performs initialization, including constructing the programs GUI, appropriate instance variable, and any private methods needed to simplify the definition of the begin method or to handle GUI events.

Version:

1.1.2 released July 2006 Version 1.1 added getVersion static method

See Also:

AWTController, WindowController, Serialized Form

Field Summary

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Controller()

Method Summary

void	begin() Programs written by extending Controller can perform any required initialization by defining a begin method containing the code to perform the initialization steps.
void	destroy() This predefined method is invoked by the appletviewer or web browser running a program that extends Controller when the program's execution is complete.
java.applet.AudioClip	getAudio(java.lang.String path) Retrieves an audio file
java.awt.Image	getImage(java.lang.String path) Retrieves an image.
static double	getTime() Deprecated. Use System.currentTimeMillis() instead
static java.lang.String	getVersion() Determine the version of the objectdraw library being used.
void	init() This predefined method is invoked by the applet viewer or web browser used to run a program that extends Controller to initiate the execution of the program.
void	placeInFrame(int width, int height) Associate of this controller with an independent window.
void	resize(int width, int height) Resize the window in which this controller is running (if possible)
void	start() This predefined method is invoked by the appletviewer or web browser running a program that extends Controller when the program should commence or resume active execution.
void	startController() Run this controller in an independent window of default size.
void	startController(int width, int height) Run this controller in an independent window of the specified size.
void	stop() This predefined method is invoked by the appletviewer or web browser running a program that extends Controller when the program should cease active execution.

Methods inherited from class javax.swing.JApplet

getAccessibleContext, getContentPane, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, remove, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, update

Methods inherited from class java.applet.Applet

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

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, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, removeNotify, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Controller

public Controller()

Method Detail

getVersion

public static java.lang.String getVersion()

Determine the version of the objectdraw library being used.

Returns:

a String describing the version of the library

init

public final void init()

This predefined method is invoked by the applet viewer or web browser used to run a program that extends Controller to initiate the execution of the program. Programmers extending this class should not include their own definition of init.

begin

public void begin()

Programs written by extending Controller can perform any required initialization by defining a begin method containing the code to perform the initialization steps.

getImage

public java.awt.Image getImage(java.lang.String path)

Retrieves an image.

Parameters:

path - the file path name or URL of the desired image.

Returns:

the requested image

getAudio

public java.applet.AudioClip getAudio(java.lang.String path)

Retrieves an audio file

Parameters:

path - the file path name or URL of the desired audio file

Returns:

the requested audio file

getTime

public static double getTime()

Deprecated. Use System.currentTimeMillis() instead

In earlier versions of objectdraw, this method was provided to determine the current time in milliseconds. It is now deprecated and throws an exception if invoked.

Returns:

nothing

start

public final void start()

This predefined method is invoked by the appletviewer or web browser running a program that extends Controller when the program should commence or resume active execution. It ensures that all ActiveObjects that have been created by the program are notified that the program has been started. Programmers extending this class should not include their own definition of start.

stop

public final void stop()

This predefined method is invoked by the appletviewer or web browser running a program that extends Controller when the program should cease active execution. This may happen because the window in which the program is executing is temporarily hidden from view. In this case, the program's execution may later be resumed by an invocation of the start method. The stop method ensures that all ActiveObjects that have been created by the program are notified that the program has been suspended. Programmers extending this class should not include their own definition of stop.

destroy

public final void destroy()

This predefined method is invoked by the appletviewer or web browser running a program that extends Controller when the program's execution is complete. It ensures that all ActiveObjects that have been created by the program are notified that they should cease execution. Programmers extending this class should not include their own definition of destroy.

placeInFrame

public void placeInFrame(int width,
                         int height)

Associate of this controller with an independent window. This is used when a controller is executed as an application or under a development environment like BlueJ or DrJava. If this method is used, the invoker must later ensure that the Controller's init and begin methods are invoked to initiate execution.

Parameters:

width - the width of the desired window

height - the height of the desired window

startController

public void startController(int width,
                            int height)

Run this controller in an independent window of the specified size. This is used when a controller is executed as an application or under a development environment like BlueJ or DrJava. For example, the main method of an application that extends AWTController would typically consist of a single command that invoked runInFrame.

Parameters:

width - the width of the desired window

height - the height of the desired window

startController

public void startController()

Run this controller in an independent window of default size. This is used when a controller is executed as an application or under a development environment like BlueJ or DrJava. For example, the main method of an application that extends AWTController would typically consist of a single command that invoked runInFrame.

resize

public void resize(int width,
                   int height)

Resize the window in which this controller is running (if possible)

Parameters:

width - the new width for the window

height - the new height for the window