audio.modules.user
Class DummyKeyboardInterface

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      audio.modules.user.DummyKeyboardInterface

All Implemented Interfaces:

AudioInput, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, VDMModule

public class DummyKeyboardInterface
extends javax.swing.JFrame
implements AudioInput, java.awt.event.WindowListener

Represents a two octave MIDI keyboard that is playable on a standard PC compatible keyboard. If you don't have any MIDI instruments to hand (they can be quite unwieldy, after all), use this one.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JFrame.AccessibleJFrame

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

java.awt.Frame.AccessibleAWTFrame

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

java.awt.Window.AccessibleAWTWindow

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

DummyKeyboardInterface(AudioInterfaceDriver audioInterfaceDriver)
Plays via the specified driver.

Method Summary

void	close() Shuts the interface down and frees any resources associated with it.
java.lang.String	getDescription() Returns a description of the interface.
java.lang.String	getFriendlyName() Returns a user defined interface name or null if the user has not changed it.
java.lang.String	getName() Returns the name of the module.
java.lang.String	getPathToIcon() Returns the path an image suitable for use as an icon.
java.lang.String	getType() Returns the type of the interface - useful for writing specific display algorithms for specific instrument types
java.lang.String	getVendor() Returns the interface vendor,
java.lang.String	getVersion() Returns the version of the module.
boolean	isOpen() Should return whether the interface is in a state where it can start transmitting data.
void	open() Turns on the interface - it should then be in a state where it can start transmitting data.
void	sendMessage() Send locally stored messages when called.
void	setFriendlyName(java.lang.String newName) Used when the user changes the name of the interface in the audio processor GUI.
void	windowActivated(java.awt.event.WindowEvent arg0)
void	windowClosed(java.awt.event.WindowEvent arg0)
void	windowClosing(java.awt.event.WindowEvent arg0) Triggers a call to close() when the window is closed.
void	windowDeactivated(java.awt.event.WindowEvent arg0)
void	windowDeiconified(java.awt.event.WindowEvent arg0)
void	windowIconified(java.awt.event.WindowEvent arg0)
void	windowOpened(java.awt.event.WindowEvent arg0)

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Frame

addNotify, finalize, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, 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, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

DummyKeyboardInterface

public DummyKeyboardInterface(AudioInterfaceDriver audioInterfaceDriver)

Plays via the specified driver.

Parameters:

audioInterfaceDriver -

Method Detail

open

public void open()

Description copied from interface: AudioInput

Turns on the interface - it should then be in a state where it can start transmitting data.

Specified by:

open in interface AudioInput

isOpen

public boolean isOpen()

Description copied from interface: AudioInput

Should return whether the interface is in a state where it can start transmitting data.

Specified by:

isOpen in interface AudioInput

Returns:

True if it is accepting data, false otherwise.

close

public void close()

Description copied from interface: AudioInput

Shuts the interface down and frees any resources associated with it.

Specified by:

close in interface AudioInput

getDescription

public java.lang.String getDescription()

Description copied from interface: AudioInput

Returns a description of the interface.

Specified by:

getDescription in interface AudioInput

Returns:

"On hardware USB bus" or something

getName

public java.lang.String getName()

Description copied from interface: VDMModule

Returns the name of the module.

Specified by:

getName in interface VDMModule

Overrides:

getName in class java.awt.Component

Returns:

"MIDI input 1" or similar

getVendor

public java.lang.String getVendor()

Description copied from interface: AudioInput

Returns the interface vendor,

Specified by:

getVendor in interface AudioInput

Returns:

"ACME MIDI" or something like that

getVersion

public java.lang.String getVersion()

Description copied from interface: VDMModule

Returns the version of the module.

Specified by:

getVersion in interface VDMModule

Returns:

Some sort of versioning information.

setFriendlyName

public void setFriendlyName(java.lang.String newName)

Description copied from interface: AudioInput

Used when the user changes the name of the interface in the audio processor GUI.

Specified by:

setFriendlyName in interface AudioInput

getFriendlyName

public java.lang.String getFriendlyName()

Description copied from interface: AudioInput

Returns a user defined interface name or null if the user has not changed it.

Specified by:

getFriendlyName in interface AudioInput

Returns:

The user defined name or null.

windowOpened

public void windowOpened(java.awt.event.WindowEvent arg0)

Specified by:

windowOpened in interface java.awt.event.WindowListener

windowClosing

public void windowClosing(java.awt.event.WindowEvent arg0)

Triggers a call to close() when the window is closed.

Specified by:

windowClosing in interface java.awt.event.WindowListener

windowClosed

public void windowClosed(java.awt.event.WindowEvent arg0)

Specified by:

windowClosed in interface java.awt.event.WindowListener

windowIconified

public void windowIconified(java.awt.event.WindowEvent arg0)

Specified by:

windowIconified in interface java.awt.event.WindowListener

windowDeiconified

public void windowDeiconified(java.awt.event.WindowEvent arg0)

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

windowActivated

public void windowActivated(java.awt.event.WindowEvent arg0)

Specified by:

windowActivated in interface java.awt.event.WindowListener

windowDeactivated

public void windowDeactivated(java.awt.event.WindowEvent arg0)

Specified by:

windowDeactivated in interface java.awt.event.WindowListener

sendMessage

public void sendMessage()

Description copied from interface: AudioInput

Send locally stored messages when called.

Specified by:

sendMessage in interface AudioInput

getPathToIcon

public java.lang.String getPathToIcon()

Description copied from interface: AudioInput

Returns the path an image suitable for use as an icon.

Specified by:

getPathToIcon in interface AudioInput

Returns:

The image path or null.

getType

public java.lang.String getType()

Description copied from interface: AudioInput

Returns the type of the interface - useful for writing specific display algorithms for specific instrument types

Specified by:

getType in interface AudioInput

Returns:

"midi" or similar