uk.org.toot.control
Class CompoundControl

java.lang.Object
  extended by java.util.Observable
      extended by uk.org.toot.control.Control
          extended by uk.org.toot.control.CompoundControl
Direct Known Subclasses:
AmplifierControls, AudioControls, CompoundControlChain, EnvelopeControls, Example2SynthControls, Example3SynthControls, FilterControls, LFOControls, MixerControls, MixerControls, MultiWaveOscillatorControls, SynthControls, SynthRackControls

public abstract class CompoundControl
extends Control

A CompoundControl, such as a graphic equalizer, provides control over two or more related properties, each of which is itself represented as a Control.


Nested Class Summary
static class CompoundControl.BypassControl
          A BypassControl is used if canBypass() is overridden to return true (default is false).
 
Field Summary
static int USE_PARENT_PROVIDER_ID
           
 
Method Summary
 boolean canBeDeleted()
           
 boolean canBeInsertedBefore()
           
 boolean canBeMinimized()
           
 boolean canBeMoved()
           
 boolean canBeMovedBefore()
           
 Control deepFind(int controlId)
           
<T> T
find(java.lang.Class<T> clazz)
           
 CompoundControl find(int providerId, int moduleId, int instanceIndex)
           
 Control find(java.lang.String name)
           
 float getAlignmentY()
           
 java.lang.String getAlternate()
           
 java.lang.Object getClientProperty(java.lang.Object key)
           
 java.util.List<Control> getControls()
           
 int getInstanceIndex()
           
 Control[] getMemberControls()
          Returns the set of member controls that comprise the compound control.
 NativeSupport getNativeSupport()
           
static CompoundControlPersistence getPersistence()
           
 java.lang.String getPersistenceDomain()
           
 int getProviderId()
           
 boolean hasCustomUI()
           
 boolean hasPresets()
           
 boolean isAlwaysHorizontal()
           
 boolean isAlwaysVertical()
           
 boolean isNeverBordered()
           
 boolean isPluginParent()
           
 void putClientProperty(java.lang.Object key, java.lang.Object value)
           
 void setEnabled(boolean enable)
           
static void setPersistence(CompoundControlPersistence p)
           
 void setProviderId(int id)
           
 java.lang.String toString()
          Provides a string representation of the control
 
Methods inherited from class uk.org.toot.control.Control
getAnnotation, getControlPath, getControlPath, getId, getIntValue, getName, getParent, getValueString, isAdjusting, isEnabled, isHidden, isIndicator, setAdjusting, setAnnotation, setHidden, setIntValue, setName
 
Methods inherited from class java.util.Observable
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

USE_PARENT_PROVIDER_ID

public static final int USE_PARENT_PROVIDER_ID
See Also:
Constant Field Values
Method Detail

getMemberControls

public Control[] getMemberControls()
Returns the set of member controls that comprise the compound control.

Returns:
the set of member controls.

getControls

public java.util.List<Control> getControls()

toString

public java.lang.String toString()
Provides a string representation of the control

Overrides:
toString in class Control
Returns:
a string description

isAlwaysVertical

public boolean isAlwaysVertical()

isAlwaysHorizontal

public boolean isAlwaysHorizontal()

isNeverBordered

public boolean isNeverBordered()

getAlignmentY

public float getAlignmentY()

getAlternate

public java.lang.String getAlternate()

getInstanceIndex

public int getInstanceIndex()

find

public <T> T find(java.lang.Class<T> clazz)

find

public Control find(java.lang.String name)

find

public CompoundControl find(int providerId,
                            int moduleId,
                            int instanceIndex)

deepFind

public Control deepFind(int controlId)

getClientProperty

public final java.lang.Object getClientProperty(java.lang.Object key)

putClientProperty

public void putClientProperty(java.lang.Object key,
                              java.lang.Object value)

getPersistence

public static CompoundControlPersistence getPersistence()

setPersistence

public static void setPersistence(CompoundControlPersistence p)

canBeMoved

public boolean canBeMoved()

canBeMovedBefore

public boolean canBeMovedBefore()

canBeInsertedBefore

public boolean canBeInsertedBefore()

canBeDeleted

public boolean canBeDeleted()

canBeMinimized

public boolean canBeMinimized()

hasPresets

public boolean hasPresets()

hasCustomUI

public boolean hasCustomUI()

getPersistenceDomain

public java.lang.String getPersistenceDomain()

isPluginParent

public boolean isPluginParent()

getProviderId

public int getProviderId()

setProviderId

public void setProviderId(int id)

getNativeSupport

public NativeSupport getNativeSupport()

setEnabled

public void setEnabled(boolean enable)
Overrides:
setEnabled in class Control


Copyright © 2004, 2005, 2006, 2007 Steve Taylor. All Rights Reserved.