de.cismet.commons.gui.equalizer

Class EqualizerPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

de.cismet.commons.gui.equalizer.EqualizerPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class EqualizerPanel
extends JPanel

This component is a view to an EqualizerModel. It displays the different categories of the model using sliders which can be used to adjust the value of the respective category. Optionally, the range of the model can be visualised right next to the slider group and a spline graph can be drawn to connect all the slider knobs of the categories to visually indicate their togetherness.

Version:

1.0

Author:

martin.scholl@cismet.de

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

Modifier and Type	Field and Description
static Paint	DEFAULT_PAINT The default paint used for the spline, a pastel greenish tone.
static Stroke	DEFAULT_STROKE The default stroke used for the spline, a dashed line, 3 pixels wide.

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
EqualizerPanel() Creates a new EqualizerPanel object using: a single category model splinePaint=DEFAULT_PAINT splineStroke=DEFAULT_STROKE splinePainted=true rangeAxisName= null rangeAxisPainted= true updateModelWhileAdjusting= false updateSplineWhileAdjusting= true
EqualizerPanel(EqualizerModel model) Creates a new EqualizerPanel object from the provided EqualizerModel using: splinePaint=DEFAULT_PAINT splineStroke=DEFAULT_STROKE splinePainted=true rangeAxisName= null rangeAxisPainted= true updateModelWhileAdjusting= false updateSplineWhileAdjusting= true
EqualizerPanel(EqualizerModel model, Paint splinePaint, Stroke splineStroke, boolean splinePainted, String rangeAxisName, boolean rangeAxisPainted, boolean updateModelWhileAdjusting, boolean updateSplineWhileAdjusting) Creates a new EqualizerPanel object.

Method Summary

Modifier and Type	Method and Description
EqualizerModel	getModel() Getter for the current EqualizerModel.
String	getRangeAxisName() Getter for the current range axis name.
Paint	getSplinePaint() Getter for the current spline paint.
Stroke	getSplineStroke() Getter for the current spline stroke.
boolean	isRangeAxisPainted() Indicates if the range axis is painted or not.
boolean	isSplinePainted() Indicates if the spline is painted or not.
boolean	isUpdateModelWhileAdjusting() Whether or not the model is updated while the user is adjusting a slider value.
boolean	isUpdateSplineWhileAdjusting() Whether or not the spline curve will reflect the user's adjusting activity.
void	setEnabled(boolean enabled)
void	setModel(EqualizerModel model) Sets a new EqualizerModel.
void	setRangeAxisName(String rangeAxisName) Sets the new range axis name.
void	setRangeAxisPainted(boolean rangeAxisPainted) Sets if the range axis is painted or not.
void	setSplinePaint(Paint splinePaint) Sets the new spline paint.
void	setSplinePainted(boolean splinePainted) Sets if the spline is painted or not.
void	setSplineStroke(Stroke splineStroke) Sets the new spline stroke.
void	setUpdateModelWhileAdjusting(boolean updateModelWhileAdjusting) Through this setter one can control if user interaction with a slider will constantly update the model while the user is still choosing the new slider value.
void	setUpdateSplineWhileAdjusting(boolean updateSplineWhileAdjusting) Through this setter one can control if the user interaction with a slider will constantly update the spline curve while the user is still choosing the new slider value.

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

DEFAULT_PAINT

public static final Paint DEFAULT_PAINT

The default paint used for the spline, a pastel greenish tone.

DEFAULT_STROKE

public static final Stroke DEFAULT_STROKE

The default stroke used for the spline, a dashed line, 3 pixels wide.

Constructor Detail

EqualizerPanel

public EqualizerPanel()

Creates a new EqualizerPanel object using:

• a single category model
• splinePaint=DEFAULT_PAINT
• splineStroke=DEFAULT_STROKE
• splinePainted=true
• rangeAxisName= null
• rangeAxisPainted= true
• updateModelWhileAdjusting= false
• updateSplineWhileAdjusting= true

Throws:

IllegalArgumentException - DOCUMENT ME!

See Also:

EqualizerPanel(de.cismet.commons.gui.equalizer.EqualizerModel, java.awt.Paint, java.awt.Stroke, boolean, java.lang.String, boolean, boolean, boolean)

EqualizerPanel

public EqualizerPanel(EqualizerModel model)

Creates a new EqualizerPanel object from the provided EqualizerModel using:

• splinePaint=DEFAULT_PAINT
• splineStroke=DEFAULT_STROKE
• splinePainted=true
• rangeAxisName= null
• rangeAxisPainted= true
• updateModelWhileAdjusting= false
• updateSplineWhileAdjusting= true

Parameters:

model - the underlying EqualizerModel

See Also:

EqualizerPanel(de.cismet.commons.gui.equalizer.EqualizerModel, java.awt.Paint, java.awt.Stroke, boolean, java.lang.String, boolean, boolean, boolean)

EqualizerPanel

public EqualizerPanel(EqualizerModel model,
                      Paint splinePaint,
                      Stroke splineStroke,
                      boolean splinePainted,
                      String rangeAxisName,
                      boolean rangeAxisPainted,
                      boolean updateModelWhileAdjusting,
                      boolean updateSplineWhileAdjusting)

Creates a new EqualizerPanel object.

Parameters:

model - the underlying EqualizerModel

splinePaint - the paint for the spline

splineStroke - the stroke for the spline

splinePainted - if the spline is painted at all

rangeAxisName - the name of the range axis

rangeAxisPainted - if the range axis is painted at all

updateModelWhileAdjusting - if updates are sent to the model while the user is adjusting the value

updateSplineWhileAdjusting - if the spline is updated while the user is adjusting the value

Method Detail

setEnabled

public void setEnabled(boolean enabled)

Overrides:

setEnabled in class JComponent

getModel

public EqualizerModel getModel()

Getter for the current EqualizerModel.

Returns:

the current EqualizerModel

setModel

public final void setModel(EqualizerModel model)

Sets a new EqualizerModel.

Parameters:

model - the new model

Throws:

IllegalArgumentException - if the model is null

isSplinePainted

public boolean isSplinePainted()

Indicates if the spline is painted or not.

Returns:

if the spline is painted or not

setSplinePainted

public void setSplinePainted(boolean splinePainted)

Sets if the spline is painted or not.

Parameters:

splinePainted - if the spline is painted or not

getSplinePaint

public Paint getSplinePaint()

Getter for the current spline paint.

Returns:

the current spline paint

setSplinePaint

public final void setSplinePaint(Paint splinePaint)

Sets the new spline paint.

Parameters:

splinePaint - the new spline paint

Throws:

IllegalArgumentException - if the spline paint is null

getSplineStroke

public Stroke getSplineStroke()

Getter for the current spline stroke.

Returns:

the current spline stroke

setSplineStroke

public final void setSplineStroke(Stroke splineStroke)

Sets the new spline stroke.

Parameters:

splineStroke - the new spline stroke

Throws:

IllegalArgumentException - if the spline stroke is null

isRangeAxisPainted

public boolean isRangeAxisPainted()

Indicates if the range axis is painted or not.

Returns:

if the range axis is painted or not.

setRangeAxisPainted

public final void setRangeAxisPainted(boolean rangeAxisPainted)

Sets if the range axis is painted or not.

Parameters:

rangeAxisPainted - paint the range axis of not

getRangeAxisName

public String getRangeAxisName()

Getter for the current range axis name.

Returns:

the current range axis name

setRangeAxisName

public final void setRangeAxisName(String rangeAxisName)

Sets the new range axis name.

Parameters:

rangeAxisName - the new range axis name

isUpdateModelWhileAdjusting

public boolean isUpdateModelWhileAdjusting()

Whether or not the model is updated while the user is adjusting a slider value.

Returns:

whether or not the model is updated while the user is adjusting a slider value

See Also:

JSlider.getValueIsAdjusting()

setUpdateModelWhileAdjusting

public void setUpdateModelWhileAdjusting(boolean updateModelWhileAdjusting)

Through this setter one can control if user interaction with a slider will constantly update the model while the user is still choosing the new slider value.

Parameters:

updateModelWhileAdjusting - whether or not update the model while adjusting

See Also:

JSlider.getValueIsAdjusting()

isUpdateSplineWhileAdjusting

public boolean isUpdateSplineWhileAdjusting()

Whether or not the spline curve will reflect the user's adjusting activity.

Returns:

whether or not the spline curve will reflect the user's adjusting activity

setUpdateSplineWhileAdjusting

public void setUpdateSplineWhileAdjusting(boolean updateSplineWhileAdjusting)

Through this setter one can control if the user interaction with a slider will constantly update the spline curve while the user is still choosing the new slider value.

Parameters:

updateSplineWhileAdjusting - whether or not update the spline curve while adjusting