org.jsynthlib.device.viewcontroller.widgets

Class SysexWidget

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.jsynthlib.device.viewcontroller.widgets.SysexWidget

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

CheckBoxWidget, ComboBoxWidget, EnvelopeWidget, IdComboWidget, Knob, KnobWidget, LabelWidget, MultiWidget, PatchNameWidget, ScrollBarLookupWidget, ScrollBarWidget, SpinnerWidget, TreeWidget

public abstract class SysexWidget
extends JPanel

Base class of SysexWidgets. There are many kinds of extended class.

They can be used as is, and can be used by being extended. Here is an example of extended ScrollBarWidget class.

 class MyScrollBarWidget extends ScrollBarWidget {
     MyScrollBarWidget(String label, Patch patch, int min, int max, int base,
             IParamModel pmodel, ISender sender) {
         super(lable, patch, min, max, base, pmodel, sender);
     }

     protected void layoutWidgets() {
         setLayout(new BorderLayout());
         JLabel label = getJLabel();
         label.setHorizontalAlignment(SwingConstants.CENTER);
         slider.setMinimumSize(new Dimension(50, 25));
         slider.setMaximumSize(new Dimension(125, 25));

         add(label, BorderLayout.NORTH);
         add(slider, BorderLayout.CENTER);
         add(text, BorderLayout.EAST);
     }
 }
 

Version:

$Id: SysexWidget.java 995 2005-03-17 19:59:31Z ribrdb $

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Modifier	Constructor and Description
protected	SysexWidget(String label, Patch patch, int min, int max, IParamModel pmodel, ISender sender) Creates a new SysexWidget instance.
protected	SysexWidget(String label, Patch patch, IParamModel pmodel, ISender sender) min is set to Integer.MIN_VALUE and max is set to Integer.MAX_VALUE.

Method Summary

Modifier and Type	Method and Description
protected void	_setLabel(String l) Setter of label.
protected void	_setSliderNum(int num) Setter of fader slider number.
protected abstract void	createWidgets() create Widgets.
protected IPatchDriver	getDriver() Return driver value.
Insets	getInsets() Return Insets(0,0,0,0).
JLabel	getJLabel() Getter of jlabel.
String	getLabel() Getter of label.
int	getNumFaders() Get number of faders.
protected Patch	getPatch() Return Patch value.
int	getSliderNum() Getter of fader slider number.
int	getValue() Return the current value.
int	getValueMax() Return max value.
int	getValueMin() Return min value.
protected abstract void	layoutWidgets() layout Widgets.
protected void	sendSysex(int value) Set value and send MIDI messages for the value to the MIDI port of driver.
protected void	sendSysex(ISender sender, int value) Set value and send MIDI messages for the value to the MIDI port of driver.
abstract void	setEnabled(boolean e) Enable/disable the widget.
void	setFaderValue(int fader, int value) Set the value specified by fader and send System Exclusive message to a MIDI port.
protected void	setJLabel(JLabel l) Setter of jlabel.
void	setLabel(String l) Set label string.
void	setMax(int max)
void	setMin(int min)
protected void	setNumFaders(int v) Set number of faders.
void	setSliderNum(int num) Set a fader slider number.
void	setValue() Set value by using paramModel.get, and update the widget state.
void	setValue(int v) Set value, and update widget state.

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, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, 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, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

SysexWidget

protected SysexWidget(String label,
                      Patch patch,
                      int min,
                      int max,
                      IParamModel pmodel,
                      ISender sender)

Creates a new SysexWidget instance.

Parameters:

label - a label text for the sysexWidget.

patch - a Patch, which is edited.

min - mininum value.

max - maxinum value.

pmodel - a ParamModel instance.

sender - ISender for transmitting the value at editing the parameter.

SysexWidget

protected SysexWidget(String label,
                      Patch patch,
                      IParamModel pmodel,
                      ISender sender)

min is set to Integer.MIN_VALUE and max is set to Integer.MAX_VALUE.

Method Detail

createWidgets

protected abstract void createWidgets()

create Widgets.

layoutWidgets

protected abstract void layoutWidgets()

layout Widgets. By overriding this method, a patch editor can change the layout as he wants.

setEnabled

public abstract void setEnabled(boolean e)

Enable/disable the widget.

Overrides:

setEnabled in class JComponent

getValue

public int getValue()

Return the current value.

setValue

public void setValue(int v)

Set value, and update widget state. An extended class has to override this method to let update the widget state (i.e. move a slider to the value set, etc.).

setValue

public void setValue()

Set value by using paramModel.get, and update the widget state.

sendSysex

protected void sendSysex(int value)

Set value and send MIDI messages for the value to the MIDI port of driver. An extended class calls this when widget state is chagned.

This method does not update the widget state.

sendSysex

protected void sendSysex(ISender sender,
                         int value)

Set value and send MIDI messages for the value to the MIDI port of driver. An extended class calls this when widget state is chagned.

This method does not update the widget state nor do min/max range check. It is caller's responsibility to do that.

getValueMin

public int getValueMin()

Return min value.

getValueMax

public int getValueMax()

Return max value.

setMin

public void setMin(int min)

setMax

public void setMax(int max)

getPatch

protected Patch getPatch()

Return Patch value.

getDriver

protected IPatchDriver getDriver()

Return driver value.

getLabel

public String getLabel()

Getter of label.

setLabel

public void setLabel(String l)

Set label string.

_setLabel

protected void _setLabel(String l)

Setter of label. This does not change the text in jlabel widget.

getJLabel

public JLabel getJLabel()

Getter of jlabel.

setJLabel

protected void setJLabel(JLabel l)

Setter of jlabel.

setSliderNum

public void setSliderNum(int num)

Set a fader slider number. Called by PatchEditorFrame.addWidget.

For a slider num is positive.

For a button num is negative.

The tool-tip text is also set.

bank number : 1, 2,..., 8

slider/button number : 1, 2,..., 16

Parameters:

num - ((bank number) - 1) * 16 + ((slider/button number) - 1)

See Also:

PatchEditorFrame

_setSliderNum

protected void _setSliderNum(int num)

Setter of fader slider number.

getSliderNum

public int getSliderNum()

Getter of fader slider number.

getNumFaders

public int getNumFaders()

Get number of faders.

setNumFaders

protected void setNumFaders(int v)

Set number of faders.

setFaderValue

public void setFaderValue(int fader,
                          int value)

Set the value specified by fader and send System Exclusive message to a MIDI port.

Called by PatchEditorFrame.faderMoved(byte, byte). This method is used and must be extended by a SysexWidget with multiple prameters (i.e. numFaders != 1, only EnvelopeWidget now).

Parameters:

fader - fader number.

value - value to be set. [0-127]

getInsets

public Insets getInsets()

Return Insets(0,0,0,0).

Overrides:

getInsets in class JComponent

Returns:

an Insets value