net.sourceforge.geeboss.view.editors.pedal
Class Pedal

java.lang.Object
  org.eclipse.swt.widgets.Widget
      org.eclipse.swt.widgets.Control
          org.eclipse.swt.widgets.Scrollable
              org.eclipse.swt.widgets.Composite
                  net.sourceforge.geeboss.view.editors.pedal.Pedal

All Implemented Interfaces:

Editor, ParameterUpdateListener, org.eclipse.swt.graphics.Drawable

Direct Known Subclasses:

DOut, LedPedal, Volume

public abstract class Pedal
extends org.eclipse.swt.widgets.Composite
implements Editor

Base class for pedals

Author:

Frederic BORRY

Field Summary

static int	HEIGHT Pedal height
protected org.eclipse.swt.graphics.Image	mBackgroundImage Background image
protected LedButton	mDetailButton Detail button
protected EditorHandler	mEditorHandler Reference to EditorHandler
protected org.eclipse.swt.graphics.Image	mLayeredBackgroundImage Layered background image
static int	WIDTH Pedal width

Fields inherited from class org.eclipse.swt.widgets.Control

handle

Constructor Summary

Pedal(EditorHandler handler, org.eclipse.swt.widgets.Composite parent, int style, org.eclipse.swt.graphics.Image background)
Create a new pedal component

Method Summary

protected abstract org.eclipse.swt.graphics.Image	getBackgroundImage() Get the implementation specific background image
org.eclipse.swt.graphics.Image	getBackGroundImage() Get this pedal's background image
protected abstract org.eclipse.swt.graphics.Point	getDetailButtonLocation() Get the implementation specific detail button location
EditorHandler	getHandler() Returns the handler of this editor
void	parametersUpdated(java.util.List<Parameter> parameters) Notify the listener that the provided parameters have been updated
void	setActive(boolean active) Set the active state for this pedal

Methods inherited from class org.eclipse.swt.widgets.Composite

changed, checkSubclass, computeSize, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setFocus, setLayout, setLayoutDeferred, setTabList

Methods inherited from class org.eclipse.swt.widgets.Scrollable

computeTrim, getClientArea, getHorizontalBar, getVerticalBar

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addFocusListener, addHelpListener, addKeyListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addPaintListener, addTraverseListener, computeSize, forceFocus, getAccessible, getBackground, getBorderWidth, getBounds, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removePaintListener, removeTraverseListener, setBackground, setBounds, setBounds, setCapture, setCursor, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString

Methods inherited from class java.lang.Object

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

Field Detail

WIDTH

public static final int WIDTH

Pedal width

See Also:

Constant Field Values

HEIGHT

public static final int HEIGHT

Pedal height

See Also:

Constant Field Values

mBackgroundImage

protected org.eclipse.swt.graphics.Image mBackgroundImage

Background image

mLayeredBackgroundImage

protected org.eclipse.swt.graphics.Image mLayeredBackgroundImage

Layered background image

mDetailButton

protected LedButton mDetailButton

Detail button

mEditorHandler

protected EditorHandler mEditorHandler

Reference to EditorHandler

Constructor Detail

Pedal

public Pedal(EditorHandler handler,
             org.eclipse.swt.widgets.Composite parent,
             int style,
             org.eclipse.swt.graphics.Image background)

Create a new pedal component

Parameters:

handler - the associated editor handler

parent - the parent component

style - the style flag

background - the background the pedal will be displayed on

Method Detail

setActive

public void setActive(boolean active)

Set the active state for this pedal

Parameters:

active - the active state for this pedal

getHandler

public EditorHandler getHandler()

Returns the handler of this editor

Specified by:

getHandler in interface Editor

Returns:

the handler of this editor

parametersUpdated

public void parametersUpdated(java.util.List<Parameter> parameters)

Notify the listener that the provided parameters have been updated

Specified by:

parametersUpdated in interface ParameterUpdateListener

Parameters:

parameters - the changed paramerters

getBackgroundImage

protected abstract org.eclipse.swt.graphics.Image getBackgroundImage()

Get the implementation specific background image

Returns:

the implementation specific background image

getDetailButtonLocation

protected abstract org.eclipse.swt.graphics.Point getDetailButtonLocation()

Get the implementation specific detail button location

Returns:

the implementation specific detail button location

getBackGroundImage

public org.eclipse.swt.graphics.Image getBackGroundImage()

Get this pedal's background image

Returns:

this pedal's background image