org.vizzini.ui
Class AbstractApp

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Panel
              java.applet.Applet
                  javax.swing.JApplet
                      org.vizzini.ui.AbstractApp

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, IOSXApp

Direct Known Subclasses:

AbstractGameUISwing, AntUI, ColorDesigner, DatabaseUI

public abstract class AbstractApp
extends JApplet
implements IOSXApp

Provides a base class for applets and applications.

Since:

v0.1

Version:

v0.2

Author:

Jeffrey M. Thompson

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.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

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 java.awt.image.ImageObserver

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

Constructor Summary

AbstractApp()
Construct this object.

Method Summary

void	aboutActionPerformed(ActionEvent event) Callback for the about button.
protected void	checkActions() Check the action enabled states.
protected void	cleanup() Cleanup as necessary before exiting.
void	doMain(String[] args) Start this applet as an application.
String	getAppName() Return the application name.
protected JFrame	getFrame() Return the frame which contains this applet.
protected Dimension	getInitialDimension() Return the initial frame dimensions.
protected JMenuBar	getMenuBar() Get the menu bar, either from the applet or the application's frame.
protected Container	getMenuBarContainer() Return the appropriate container to hold the menu bar.
void	init() Initialize.
protected void	macOSXRegistration() Generic registration with the Mac OS X application menu.
void	onlineHelpActionPerformed(ActionEvent event) Callback for the online help button.
void	preferencesActionPerformed(ActionEvent event) Display the preferences dialog.
void	quitActionPerformed(ActionEvent event) Callback for the quit button.
void	setCursorBusy(boolean busy) Set the cursor to busy depending upon the given state.
protected boolean	usePreferencesMenu() Return true if this application uses the preferences application menu item.
protected boolean	useSplashScreen() Return true if this application uses a splash screen upon startup.

Methods inherited from class javax.swing.JApplet

addImpl, createRootPane, getAccessibleContext, getContentPane, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, remove, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.applet.Applet

destroy, getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, isActive, newAudioClip, play, play, resize, resize, setStub, showStatus, start, 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, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate, 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, 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, getMousePosition, 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, 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, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractApp

public AbstractApp()

Construct this object.

Since:

v0.1

Method Detail

aboutActionPerformed

public void aboutActionPerformed(ActionEvent event)

Callback for the about button.

Specified by:

aboutActionPerformed in interface IOSXApp

Since:

v0.1

doMain

public void doMain(String[] args)

Start this applet as an application.

Since:

v0.1

getAppName

public String getAppName()

Return the application name.

Since:

v0.1

init

public void init()

Initialize.

Overrides:

init in class Applet

Since:

v0.1

onlineHelpActionPerformed

public void onlineHelpActionPerformed(ActionEvent event)

Callback for the online help button.

Since:

v0.1

preferencesActionPerformed

public void preferencesActionPerformed(ActionEvent event)

Display the preferences dialog. The OSXAdapter calls this method when "Preferences..." is selected from the application menu.

Specified by:

preferencesActionPerformed in interface IOSXApp

Since:

v0.1

quitActionPerformed

public void quitActionPerformed(ActionEvent event)

Callback for the quit button.

Specified by:

quitActionPerformed in interface IOSXApp

Since:

v0.1

setCursorBusy

public void setCursorBusy(boolean busy)

Set the cursor to busy depending upon the given state.

Since:

v0.1

checkActions

protected void checkActions()

Check the action enabled states.

Since:

v0.1

cleanup

protected void cleanup()

Cleanup as necessary before exiting. The base class method does nothing.

Since:

v0.1

getFrame

protected JFrame getFrame()

Return the frame which contains this applet.

Since:

v0.1

getInitialDimension

protected Dimension getInitialDimension()

Return the initial frame dimensions.

Since:

v0.1

getMenuBar

protected JMenuBar getMenuBar()

Get the menu bar, either from the applet or the application's frame.

Since:

v0.1

getMenuBarContainer

protected Container getMenuBarContainer()

Return the appropriate container to hold the menu bar.

Since:

v0.1

macOSXRegistration

protected void macOSXRegistration()

Generic registration with the Mac OS X application menu. Checks the platform, then attempts to register with the Apple EAWT. This method calls OSXAdapter.registerMacOSXApplication() and OSXAdapter.enablePrefs(). See OSXAdapter.java for the signatures of these methods.

Since:

v0.1

usePreferencesMenu

protected boolean usePreferencesMenu()

Return true if this application uses the preferences application menu item.

Since:

v0.1

useSplashScreen

protected boolean useSplashScreen()

Return true if this application uses a splash screen upon startup.

Since:

v0.1