JSampler
v0.8a

org.jsampler.view
Class JSChannelsPane

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by org.jsampler.view.JSChannelsPane
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public abstract class JSChannelsPane
extends javax.swing.JPanel

This class defines the skeleton of a pane containg sampler channels.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
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
static java.lang.String TITLE
          The key used for reporting title's property change.
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
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
JSChannelsPane(java.lang.String title)
          Creates a new instance of JSChannelsPane.
 
Method Summary
abstract  void addChannel(SamplerChannelModel channelModel)
          Adds new channel to this channels pane.
abstract  void addChannels(JSChannel[] chns)
          Adds the specified channels to this channels pane.
abstract  void addListSelectionListener(javax.swing.event.ListSelectionListener listener)
          Registers the specified listener for receiving list selection events.
abstract  JSChannel getChannel(int idx)
          Gets the channel at the specified index.
abstract  int getChannelCount()
          Gets the number of channels in this channels pane.
abstract  JSChannel[] getChannels()
          Gets an array of all channels in this channels pane.
abstract  JSChannel getFirstChannel()
          Gets the first channel in this channels pane.
abstract  JSChannel getLastChannel()
          Gets the last channel in this channels pane.
abstract  int getSelectedChannelCount()
          Gets the number of the selected channels.
abstract  JSChannel[] getSelectedChannels()
          Gets an array of all selected channels.
 java.lang.String getTitle()
          Returns the title of this JSChannelsPane.
abstract  boolean hasSelectedChannel()
          Determines whether there is at least one selected channel.
abstract  void removeChannel(JSChannel chn)
          Removes the specified channel from this channels pane.
abstract  void removeListSelectionListener(javax.swing.event.ListSelectionListener listener)
          Removes the specified listener.
abstract  int removeSelectedChannels()
          Removes all selected channels in this channels pane.
 void setTitle(java.lang.String title)
          Sets the title of this JSChannelsPane.
 java.lang.String toString()
          Returns the title of this JSChannelsPane.
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TITLE

public static final java.lang.String TITLE
The key used for reporting title's property change.

See Also:
Constant Field Values
Constructor Detail

JSChannelsPane

public JSChannelsPane(java.lang.String title)
Creates a new instance of JSChannelsPane.

Method Detail

getTitle

public java.lang.String getTitle()
Returns the title of this JSChannelsPane.

Returns:
The title of this JSChannelsPane.

setTitle

public void setTitle(java.lang.String title)
Sets the title of this JSChannelsPane.

Parameters:
title - The new title of this JSChannelsPane.

toString

public java.lang.String toString()
Returns the title of this JSChannelsPane.

Overrides:
toString in class java.awt.Component
Returns:
The title of this JSChannelsPane.

addChannel

public abstract void addChannel(SamplerChannelModel channelModel)
Adds new channel to this channels pane.

Parameters:
channelModel - The sampler channel model to be used by the new channel.

addChannels

public abstract void addChannels(JSChannel[] chns)
Adds the specified channels to this channels pane.

Parameters:
chns - The channels to be added.

removeChannel

public abstract void removeChannel(JSChannel chn)
Removes the specified channel from this channels pane. This method is invoked when a sampler channel is removed in the back-end.

Parameters:
chn - The channel to be removed from this channels pane.

hasSelectedChannel

public abstract boolean hasSelectedChannel()
Determines whether there is at least one selected channel.

Returns:
true if there is at least one selected channel, false otherwise.

getFirstChannel

public abstract JSChannel getFirstChannel()
Gets the first channel in this channels pane.

Returns:
The first channel in this channels pane or null if the channels pane is empty.

getLastChannel

public abstract JSChannel getLastChannel()
Gets the last channel in this channels pane.

Returns:
The last channel in this channels pane or null if the channels pane is empty.

getChannel

public abstract JSChannel getChannel(int idx)
Gets the channel at the specified index.

Returns:
The channel at the specified index.
Throws:
java.lang.ArrayIndexOutOfBoundsException - If the index is out of range.

getChannels

public abstract JSChannel[] getChannels()
Gets an array of all channels in this channels pane.

Returns:
An array of all channels in this channels pane.

getChannelCount

public abstract int getChannelCount()
Gets the number of channels in this channels pane.

Returns:
The number of channels in this channels pane.

getSelectedChannels

public abstract JSChannel[] getSelectedChannels()
Gets an array of all selected channels. The channels are sorted in increasing index order.

Returns:
The selected channels or an empty array if nothing is selected.

getSelectedChannelCount

public abstract int getSelectedChannelCount()
Gets the number of the selected channels.

Returns:
The number of the selected channels.

removeSelectedChannels

public abstract int removeSelectedChannels()
Removes all selected channels in this channels pane. Notice that this method does not remove any channels in the back-end. It is invoked after the channels are already removed in the back-end.

Returns:
The number of removed channels.

addListSelectionListener

public abstract void addListSelectionListener(javax.swing.event.ListSelectionListener listener)
Registers the specified listener for receiving list selection events.

Parameters:
listener - The ListSelectionListener to register.

removeListSelectionListener

public abstract void removeListSelectionListener(javax.swing.event.ListSelectionListener listener)
Removes the specified listener.

Parameters:
listener - The ListSelectionListener to remove.

JSampler
v0.8a

Copyright © 2007 Grigor Iliev. All rights reserved.