org.jsynthlib.synthdrivers.YamahaUB99

Class Knob

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.jsynthlib.device.viewcontroller.widgets.SysexWidget

org.jsynthlib.synthdrivers.YamahaUB99.Knob

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class Knob
extends SysexWidget

A rotary knob widget. Uses the class DKnob by DreamFabric which is responsible for drawing the widget. This component should rather be used for parameters which do not need fine adjustment. A tooltip is used to display the current value. A prior version used a text field instead, but the resulting component was inconsistent and diffucult to place.

Version:

$Id: Knob.java 1074 2007-09-18 05:12:22Z billzwicky $

Author:

denis queffeulou mailto:dqueffeulou@free.fr

See Also:

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

Modifier and Type	Field and Description
protected DKnob	mKnob DKnob widget object
protected ClickLabel	mLabel

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

Constructor and Description
Knob(String label, Patch patch, int min, int max, IFormat format, IParamModel pmodel, ISender sender)
Knob(String label, Patch patch, int min, int max, int base, IParamModel pmodel, ISender sender) Creates a new Knob instance.

Method Summary

Modifier and Type	Method and Description
void	addEventListener(ChangeListener l) Adds a ChangeListener to the Knob.
void	addEventListener(MouseWheelListener l) Adds a MouseWheelListener to the Knob.
protected void	createWidgets() create Widgets.
protected String	display(int v)
protected void	eventListener(ChangeEvent e) invoked when knob is moved.
protected void	eventListener(MouseWheelEvent e) invoked when mouse wheel is moved.
protected void	labelListener(ChangeEvent e) invoked when label is clicked.
protected void	layoutWidgets() layout Widgets.
void	setEnabled(boolean e) Enable/disable the widget.
void	setValue(int v) Set value, and update widget state.

Methods inherited from class org.jsynthlib.device.viewcontroller.widgets.SysexWidget

_setLabel, _setSliderNum, getDriver, getInsets, getJLabel, getLabel, getNumFaders, getPatch, getSliderNum, getValue, getValueMax, getValueMin, sendSysex, sendSysex, setFaderValue, setJLabel, setLabel, setMax, setMin, setNumFaders, setSliderNum, setValue

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

Field Detail

mKnob

protected DKnob mKnob

DKnob widget object

mLabel

protected ClickLabel mLabel

Constructor Detail

Knob

public Knob(String label,
            Patch patch,
            int min,
            int max,
            int base,
            IParamModel pmodel,
            ISender sender)

Creates a new Knob instance.

Parameters:

label - label String.

patch - a Patch value.

min - minimum value.

max - maximum value.

base - value display offset.

pmodel - a ParamModel object.

sender - a ISender object.

Knob

public Knob(String label,
            Patch patch,
            int min,
            int max,
            IFormat format,
            IParamModel pmodel,
            ISender sender)

Method Detail

createWidgets

protected void createWidgets()

Description copied from class: SysexWidget

create Widgets.

Specified by:

createWidgets in class SysexWidget

eventListener

protected void eventListener(ChangeEvent e)

invoked when knob is moved.

labelListener

protected void labelListener(ChangeEvent e)

invoked when label is clicked.

eventListener

protected void eventListener(MouseWheelEvent e)

invoked when mouse wheel is moved.

addEventListener

public void addEventListener(ChangeListener l)

Adds a ChangeListener to the Knob.

addEventListener

public void addEventListener(MouseWheelListener l)

Adds a MouseWheelListener to the Knob.

layoutWidgets

protected void layoutWidgets()

Description copied from class: SysexWidget

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

Specified by:

layoutWidgets in class SysexWidget

display

protected String display(int v)

setValue

public void setValue(int v)

Description copied from class: SysexWidget

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.).

Overrides:

setValue in class SysexWidget

setEnabled

public void setEnabled(boolean e)

Description copied from class: SysexWidget

Enable/disable the widget.

Specified by:

setEnabled in class SysexWidget