net.happybrackets.core.control

Class ControlMap

java.lang.Object

net.happybrackets.core.control.ControlMap

public class ControlMap
extends java.lang.Object

Control Map is a singleton that will store dynamic controls and allow us to access them via their unique map key string

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ControlMap.dynamicControlCreatedListener Create an Interface where we can look for created Dynamic Controls
static interface	ControlMap.dynamicControlRemovedListener Create an Interface where we can look for created Dynamic Controls

Method Summary

Modifier and Type	Method and Description
void	addControl(DynamicControl control) Add a control to our map.
void	addDynamicControlAdvertiseListener(OSCVocabulary.OSCAdvertiseListener listener)
void	addDynamicControlCreatedListener(ControlMap.dynamicControlCreatedListener listener)
void	addDynamicControlRemovedListener(ControlMap.dynamicControlRemovedListener listener)
void	addGlobalDynamicControlAdvertiseListener(OSCVocabulary.OSCAdvertiseListener listener)
void	addPersistentControl(DynamicControl control) Add a control to the persistentControls list.
void	clearAllListeners() Erase all the listeners
static void	disableControlMimic(boolean disable) We will disable sending messages to other controls with same name and scope when we are in plugin
DynamicControl	getControl(java.lang.String map_key) Get the Dynamic Control based on HashCode
java.util.List<DynamicControl>	getControlsByName(java.lang.String name) Get the Control list by name.
static ControlMap	getInstance() Get the Control Map
java.util.List<DynamicControl>	GetSortedControls() get all Dynamic Controls sorted by creation order
boolean	isPersistentControl(DynamicControl control) Test if the Dynamic Control is a Persistent control
void	removeControl(DynamicControl control) Remove all listeners and reference to Dynamic Control
void	removeDynamicControlRemovedListener(ControlMap.dynamicControlRemovedListener listener)

Methods inherited from class java.lang.Object

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

Method Detail

disableControlMimic

public static void disableControlMimic(boolean disable)

We will disable sending messages to other controls with same name and scope when we are in plugin

Parameters:

disable - set true for plugin

addDynamicControlCreatedListener

public void addDynamicControlCreatedListener(ControlMap.dynamicControlCreatedListener listener)

addDynamicControlAdvertiseListener

public void addDynamicControlAdvertiseListener(OSCVocabulary.OSCAdvertiseListener listener)

addDynamicControlRemovedListener

public void addDynamicControlRemovedListener(ControlMap.dynamicControlRemovedListener listener)

removeDynamicControlRemovedListener

public void removeDynamicControlRemovedListener(ControlMap.dynamicControlRemovedListener listener)

addGlobalDynamicControlAdvertiseListener

public void addGlobalDynamicControlAdvertiseListener(OSCVocabulary.OSCAdvertiseListener listener)

getInstance

public static ControlMap getInstance()

Get the Control Map

Returns:

the singletonInstance

addControl

public void addControl(DynamicControl control)

Add a control to our map. Generate a control added event

Parameters:

control - The Dynamic Control we are adding

getControlsByName

public java.util.List<DynamicControl> getControlsByName(java.lang.String name)

Get the Control list by name. If no list exists, it will create a list and add it to controlScopedDevices

Parameters:

name - the name used as a search key

Returns:

the List of DynamicControls that have that name

getControl

public DynamicControl getControl(java.lang.String map_key)

Get the Dynamic Control based on HashCode

Parameters:

map_key - the String we are using as the key

Returns:

the Dynamic control associated, otherwise null if does not exist

removeControl

public void removeControl(DynamicControl control)

Remove all listeners and reference to Dynamic Control

Parameters:

control - the control to remove

addPersistentControl

public void addPersistentControl(DynamicControl control)

Add a control to the persistentControls list. These do not get removed

Parameters:

control - the DynamicControl object we are adding

isPersistentControl

public boolean isPersistentControl(DynamicControl control)

Test if the Dynamic Control is a Persistent control

Parameters:

control - the DynamicControl object we are adding

Returns:

true if has been previously added through addPersistentControl(DynamicControl) ()}

clearAllListeners

public void clearAllListeners()

Erase all the listeners

GetSortedControls

public java.util.List<DynamicControl> GetSortedControls()

get all Dynamic Controls sorted by creation order

Returns:

List of dynamic controls on the device.