JSampler
v0.8a

org.jsampler.view
Class JSMainFrame

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Frame
                  extended by javax.swing.JFrame
                      extended by org.jsampler.view.JSMainFrame
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public abstract class JSMainFrame
extends javax.swing.JFrame

Defines the skeleton of a JSampler's main frame.

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.BaselineResizeBehavior, 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
JSMainFrame()
          Creates a new instance of JSMainFrame.
 
Method Summary
 void addChannelsPane(JSChannelsPane chnPane)
          Adds the specified JSChannelsPane to the view.
 JSChannel findChannel(int id)
          Searches for the first occurence of a channel with numerical ID id.
 JSChannelsPane getChannelsPane(int idx)
          Return the JSChannelsPane at the specified position.
 int getChannelsPaneCount()
          Gets the current number of JSChannelsPanes added to the view.
 java.util.Vector<JSChannelsPane> getChannelsPaneList()
          Returns a list containing all JSChannelsPanes added to the view.
abstract  JSChannelsPane getSelectedChannelsPane()
          Gets the JSChannelsPane that is currently shown, or has the focus if more than one channels' panes are shown.
abstract  void insertChannelsPane(JSChannelsPane pane, int idx)
          Inserts the specified JSChannelsPane at the specified position in the view and in the code>JSChannelsPane list.
abstract  void installJSamplerHome()
          Invoked on startup when no JSampler home directory is specified or the specified JSampler home directory doesn't exist.
protected  void onWindowClose()
          Invoked when this window is about to close.
 JSChannel removeChannel(int id)
          Removes the first occurence of a channel with numerical ID id.
 boolean removeChannelsPane(JSChannelsPane chnPane)
          Removes the specified JSChannelsPane from the view.
abstract  void setSelectedChannelsPane(JSChannelsPane pane)
          Sets the JSChannelsPane to be selected.
abstract  void showDetailedErrorMessage(java.awt.Dialog owner, java.lang.String err, java.lang.String details)
          Shows a detailed error information about the specified exception.
abstract  void showDetailedErrorMessage(java.awt.Frame owner, java.lang.String err, java.lang.String details)
          Shows a detailed error information about the specified exception.
 
Methods inherited from class javax.swing.JFrame
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
 
Methods inherited from class java.awt.Frame
addNotify, 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, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, 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, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, 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 java.awt.MenuContainer
getFont, postEvent
 

Constructor Detail

JSMainFrame

public JSMainFrame()
Creates a new instance of JSMainFrame.

Method Detail

onWindowClose

protected void onWindowClose()
Invoked when this window is about to close. Don't forget to call super.onWindowClose() at the end, when override this method.


installJSamplerHome

public abstract void installJSamplerHome()
Invoked on startup when no JSampler home directory is specified or the specified JSampler home directory doesn't exist. This method should ask the user to specify a JSampler home directory and then set the specified JSampler home directory using CC.setJSamplerHome(java.lang.String) method.

See Also:
CC.getJSamplerHome(), CC.setJSamplerHome(java.lang.String)

showDetailedErrorMessage

public abstract void showDetailedErrorMessage(java.awt.Frame owner,
                                              java.lang.String err,
                                              java.lang.String details)
Shows a detailed error information about the specified exception.


showDetailedErrorMessage

public abstract void showDetailedErrorMessage(java.awt.Dialog owner,
                                              java.lang.String err,
                                              java.lang.String details)
Shows a detailed error information about the specified exception.


getChannelsPaneList

public java.util.Vector<JSChannelsPane> getChannelsPaneList()
Returns a list containing all JSChannelsPanes added to the view.

Returns:
A list containing all JSChannelsPanes added to the view.
See Also:
addChannelsPane(org.jsampler.view.JSChannelsPane), removeChannelsPane(org.jsampler.view.JSChannelsPane)

getChannelsPane

public JSChannelsPane getChannelsPane(int idx)
Return the JSChannelsPane at the specified position.

Parameters:
idx - The position of the JSChannelsPane to be returned.
Returns:
The JSChannelsPane at the specified position.

addChannelsPane

public void addChannelsPane(JSChannelsPane chnPane)
Adds the specified JSChannelsPane to the view.

Parameters:
chnPane - The JSChannelsPane to be added.

removeChannelsPane

public boolean removeChannelsPane(JSChannelsPane chnPane)
Removes the specified JSChannelsPane from the view. Override this method to remove chnPane from the view, and don't forget to call super.removeChannelsPane(chnPane);.

Parameters:
chnPane - The JSChannelsPane to be removed.
Returns:
true if the specified code>JSChannelsPane is actually removed from the view, false otherwise.

getChannelsPaneCount

public int getChannelsPaneCount()
Gets the current number of JSChannelsPanes added to the view.

Returns:
The current number of JSChannelsPanes added to the view.

insertChannelsPane

public abstract void insertChannelsPane(JSChannelsPane pane,
                                        int idx)
Inserts the specified JSChannelsPane at the specified position in the view and in the code>JSChannelsPane list. Where and how this pane will be shown depends on the view/GUI implementation. Note that some GUI implementation may have only one pane containing sampler channels.

Parameters:
pane - The JSChannelsPane to be inserted.
idx - Specifies the position of the JSChannelsPane.
See Also:
getChannelsPaneList()

getSelectedChannelsPane

public abstract JSChannelsPane getSelectedChannelsPane()
Gets the JSChannelsPane that is currently shown, or has the focus if more than one channels' panes are shown. If the GUI implementation has only one pane containing sampler channels, than this method should always return that pane (the JSChannelsPane with index 0).

Returns:
The selected JSChannelsPane.

setSelectedChannelsPane

public abstract void setSelectedChannelsPane(JSChannelsPane pane)
Sets the JSChannelsPane to be selected.

Parameters:
pane - The JSChannelsPane to be shown.

findChannel

public JSChannel findChannel(int id)
Searches for the first occurence of a channel with numerical ID id.

Returns:
The first occurence of a channel with numerical ID id or null if there is no channel with numerical ID id.

removeChannel

public JSChannel removeChannel(int id)
Removes the first occurence of a channel with numerical ID id. This method is invoked when a sampler channel is removed in the back-end.

Returns:
The removed channel or null if there is no channel with numerical ID id.

JSampler
v0.8a

Copyright © 2007 Grigor Iliev. All rights reserved.