net.happybrackets.core.control

Class DynamicControl

java.lang.Object

net.happybrackets.core.control.DynamicControl

All Implemented Interfaces:

ScheduledEventListener

public class DynamicControl
extends java.lang.Object
implements ScheduledEventListener

This class facilitates sending message values between sketches, devices, and a graphical environment. The values can be represented as sliders, text boxes, check boxes, and buttons A message can either be an integer, a double, a string, a boolean, a trigger or a complete class. Although similar to the send and receive objects in Max in that the name and type parameter of the DynamicControl determines message interconnection, DynamicControls also have an attribute called ControlScope, which dictates how far (in a topological sense) the object can reach in order to communicate with other DynamicControls. DynamicControls can be bound to different objects, the default being the class that instantiated it.
The classes are best accessed through DynamicControlParent abstractions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DynamicControl.ControlScopeChangedListener
static class	DynamicControl.DISPLAY_TYPE Define how we want the object displayed in the plugin
static interface	DynamicControl.DynamicControlListener Create an Interface to listen to
static class	DynamicControl.NETWORK_TRANSMIT_MESSAGE_ARGS

Constructor Summary

Constructors

Constructor and Description
DynamicControl(ControlType control_type, java.lang.String name) A dynamic control that can be accessed from outside this sketch it is created with the sketch object that contains it along with the type
DynamicControl(ControlType control_type, java.lang.String name, java.lang.Object initial_value) A dynamic control that can be accessed from outside this sketch it is created with the sketch object that contains it along with the type
DynamicControl(ControlType control_type, java.lang.String name, java.lang.Object initial_value, java.lang.Object min_value, java.lang.Object max_value) A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type
DynamicControl(java.lang.Object parent_sketch, ControlType control_type, java.lang.String name) A dynamic control that can be accessed from outside this sketch it is created with the sketch object that contains it along with the type
DynamicControl(java.lang.Object parent_sketch, ControlType control_type, java.lang.String name, java.lang.Object initial_value) A dynamic control that can be accessed from outside this sketch it is created with the sketch object that contains it along with the type
DynamicControl(java.lang.Object parent_sketch, ControlType control_type, java.lang.String name, java.lang.Object initial_value, java.lang.Object min_value, java.lang.Object max_value) A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type
DynamicControl(java.lang.Object parent_sketch, ControlType control_type, java.lang.String name, java.lang.Object initial_value, java.lang.Object min_value, java.lang.Object max_value, DynamicControl.DISPLAY_TYPE display_type) A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type
DynamicControl(de.sciss.net.OSCMessage msg) Create a DynamicControl based on OSC Message.
DynamicControl(java.lang.String name, java.lang.Object initial_value) A dynamic control that can be accessed from outside this sketch it is created with the sketch object that contains it along with the type

Method Summary

Modifier and Type	Method and Description
DynamicControl	addControlListener(DynamicControl.DynamicControlListener listener) Register Listener to receive changed values in the control
DynamicControl	addControlScopeListener(DynamicControl.ControlScopeChangedListener listener) Register Listener to receive changed values in the control scope
DynamicControl	addGlobalControlListener(DynamicControl.DynamicControlListener listener) Register Listener to receive changed values in the control that need to be global type messages
void	addTargetDevice(java.net.InetAddress... inetAddresses) Add one or more device InetAddress for use in ControlScope.TARGET Message
void	addTargetDevice(java.lang.String... deviceNames) Add one or more device names or addresses as strings to use in ControlScope.TARGET Message
DynamicControl	addValueSetListener(DynamicControl.DynamicControlListener listener) Register Listener to receive changed values in the control that need to be received when value is specifically set from Within sketch
de.sciss.net.OSCMessage	buildCreateMessage() Build the OSC Message for a create message
static de.sciss.net.OSCMessage	buildDeviceNameMessage() Build OSC Message that gives our device name
static de.sciss.net.OSCMessage	buildDeviceRequestNameMessage() Build OSC Message that requests devices send us their name
de.sciss.net.OSCMessage	buildNetworkSendMessage() Build OSC Message that specifies a Network update
de.sciss.net.OSCMessage	buildRemoveMessage() Build OSC Message that specifies a removal of a control
de.sciss.net.OSCMessage	buildUpdateMessage() Build OSC Message that specifies an update
void	clearTargetDevices() Clear all devices as Targets
void	doScheduledEvent(double scheduledTime, java.lang.Object param) Notification interface that a scheduled event is occuring
static boolean	enableProcessControlMessage(java.lang.String device_name, int message_id) See if we will process a control message based on device name and message_id If the message_id is mapped against the device_name, ignore message, otherwise store mapping and return true;
DynamicControl	eraseListeners() Erase all listeners from this control
static DynamicControl	getControl(java.lang.String map_key) Get the Dynamic control based on Map key
java.lang.String	getControlMapKey() Get the map key created in the device as a method for mapping back
java.lang.String	getControlName() Get the name of the control used for ControlScope matching.
ControlScope	getControlScope() Get the scope of this control.
ControlType	getControlType() Get the type of control we want
static ControlType	getControlType(java.lang.Object value) Ascertain the Control Type based on the Value
DynamicControl.DISPLAY_TYPE	getDisplayType() Whether we disable the control on the screen
double	getExecutionTime() Returns the JVM execution time we last used when we set the value
java.lang.Object	getMaximumDisplayValue() The maximum value that we want as a display, for example, in a slider control.
java.lang.Object	getMinimumDisplayValue() The minimum value that we want as a display, for example, in a slider control.
java.lang.Object	getParentSketch() Get the Sketch or class object linked to this control
java.lang.String	getSendingDevice() Get the name of the device that sent the message.
java.util.Set<java.lang.String>	getTargetDeviceAddresses() Return all mapped device addresses for this control
java.lang.String	getTooltipText() Get the tooltip to display
java.lang.Object	getValue() Gets the value of the control.
static long	integersToLong(int msi, int lsi) Convert two halves of a long stored integer values into a long value
static double	integersToScheduleTime(int msi, int lsi, int nano) Convert three integers to a double representing scheduler time
boolean	isPersistentControl() See if control is a persistent control
static int[]	longToIntegers(long l_value) Convert a long into two integers in an array of two integers
DynamicControl	notifyControlChangeListeners() Notify all registered listeners of object value
void	notifyGlobalListeners() Send Global Update Message
DynamicControl	notifyLocalListeners() Notify all registered listeners of object value on this device
void	notifyValueSetListeners() Send Update Message when value set
static int	numberIntsForScheduledTime() Return the array size of Integers that would be required to encode a scheduled time
static void	postRequestNamesMessage() Post a request device name message to other devices so we can target them specifically and update our map
static void	processDeviceNameMessage(java.net.InetAddress src_address, de.sciss.net.OSCMessage msg) Process the DynamicControl deviceName message and map device name to IPAddress We ignore our own device
static void	processOSCControlMessage(de.sciss.net.OSCMessage msg, ControlScope controlScope) Process the ControlScope.GLOBAL or ControlScope.TARGET Message from an OSC Message.
static void	processRequestNameMessage(java.net.InetAddress src_address, de.sciss.net.OSCMessage msg) Process the DynamicControl deviceRequest message Send a deviceName back to src.
static void	processUpdateMessage(de.sciss.net.OSCMessage msg) Process the Update Message from an OSC Message.
DynamicControl	removeControlListener(DynamicControl.DynamicControlListener listener) Deregister listener so it no longer receives messages from this control
DynamicControl	removeControlScopeChangedListener(DynamicControl.ControlScopeChangedListener listener) Deregister listener so it no longer receives messages from this control
DynamicControl	removeGlobalControlListener(DynamicControl.DynamicControlListener listener) Deregister listener so it no longer receives messages from this control
void	removeTargetDevice(java.net.InetAddress... inetAddresses) Remove one or more InetAddress for use in ControlScope.TARGET Message
void	removeTargetDevice(java.lang.String... deviceNames) Remove one or more device names or addresses as a string.
static int[]	scheduleTimeToIntegers(double d_val) Convert a SchedulerTime into integers in an array of three integers
DynamicControl	setControlScope(ControlScope new_scope) Changed the scope that the control has.
static void	setDisableScheduler(boolean disabled) Set whether we disable setting all values in context of scheduler
DynamicControl	setDisplayType(DynamicControl.DISPLAY_TYPE display_type) Set how we will display control object on the screen
DynamicControl	setMaximumDisplayValue(java.lang.Object max) Set the maximum display range for display
DynamicControl	setMinimumValue(java.lang.Object min) Set the minimum display range for display
DynamicControl	setPersistentController() Set this control as a persistentSimulation control so it does not get removed on reset
void	setTargetDevice(java.net.InetAddress... inetAddresses) Remove all set target devices and replace with the those provided as arguments Adds device addresses to ControlScope.TARGET Message
void	setTargetDevice(java.lang.String... deviceNames) Remove all set target devices and replace with the those provided as arguments Adds device address as a string or device name to ControlScope.TARGET Message
DynamicControl	setTooltipPrefix(java.lang.String tooltipPrefix) Create the text we will display at the beginning of tooltip
DynamicControl	setValue(java.lang.Object val) Set the value of the object and notify any listeners Additionally, the value will propagate to any controls that match the control scope If we are using a trigger, send a random number or a unique value
DynamicControl	setValue(java.lang.Object val, double execution_time) Set the value of the object and notify any listeners Additionally, the value will propagate to any controls that match the control scope If we are using a trigger, send a random number or a unique value
DynamicControl	updateControl(DynamicControl mirror_control) Update the parameters of this control with another.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicControl

public DynamicControl(java.lang.String name,
                      java.lang.Object initial_value)

A dynamic control that can be accessed from outside this sketch it is created with the sketch object that contains it along with the type

Parameters:

name - The name we will give to associate it with other DynamicControls with identical ControlScope and type.

initial_value - The initial value of the control

DynamicControl

public DynamicControl(ControlType control_type,
                      java.lang.String name,
                      java.lang.Object initial_value)

A dynamic control that can be accessed from outside this sketch it is created with the sketch object that contains it along with the type

Parameters:

control_type - The type of control message you want to send

name - The name we will give to associate it with other DynamicControls with identical ControlScope and type.

initial_value - The initial value of the control

DynamicControl

public DynamicControl(java.lang.Object parent_sketch,
                      ControlType control_type,
                      java.lang.String name)

A dynamic control that can be accessed from outside this sketch it is created with the sketch object that contains it along with the type

Parameters:

parent_sketch - the object calling - typically this, however, you can use any class object

control_type - The type of control message you want to send

name - The name we will give to associate it with other DynamicControls with identical ControlScope and type.

DynamicControl

public DynamicControl(ControlType control_type,
                      java.lang.String name)

A dynamic control that can be accessed from outside this sketch it is created with the sketch object that contains it along with the type

Parameters:

control_type - The type of control message you want to send

name - The name we will give to associate it with other DynamicControls with identical ControlScope and type.

DynamicControl

public DynamicControl(java.lang.Object parent_sketch,
                      ControlType control_type,
                      java.lang.String name,
                      java.lang.Object initial_value)

A dynamic control that can be accessed from outside this sketch it is created with the sketch object that contains it along with the type

Parameters:

parent_sketch - the object calling - typically this, however, you can use any class object

control_type - The type of control message you want to send

name - The name we will give to associate it with other DynamicControls with identical ControlScope and type.

initial_value - The initial value of the control

DynamicControl

public DynamicControl(java.lang.Object parent_sketch,
                      ControlType control_type,
                      java.lang.String name,
                      java.lang.Object initial_value,
                      java.lang.Object min_value,
                      java.lang.Object max_value)

A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type

Parameters:

parent_sketch - the object calling - typically this, however, you can use any class object

control_type - The type of control message you want to send

name - The name we will give to associate it with other DynamicControls with identical ControlScope and type.

initial_value - The initial value of the control

min_value - The minimum display value of the control. Only used for display purposes

max_value - The maximum display value of the control. Only used for display purposes

DynamicControl

public DynamicControl(java.lang.Object parent_sketch,
                      ControlType control_type,
                      java.lang.String name,
                      java.lang.Object initial_value,
                      java.lang.Object min_value,
                      java.lang.Object max_value,
                      DynamicControl.DISPLAY_TYPE display_type)

A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type

Parameters:

parent_sketch - the object calling - typically this, however, you can use any class object

control_type - The type of control message you want to send

name - The name we will give to associate it with other DynamicControls with identical ControlScope and type.

initial_value - The initial value of the control

min_value - The minimum display value of the control. Only used for display purposes

max_value - The maximum display value of the control. Only used for display purposes

display_type - The way we want the control displayed

DynamicControl

public DynamicControl(ControlType control_type,
                      java.lang.String name,
                      java.lang.Object initial_value,
                      java.lang.Object min_value,
                      java.lang.Object max_value)

A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type

Parameters:

control_type - The type of control message you want to send

name - The name we will give to associate it with other DynamicControls with identical ControlScope and type.

initial_value - The initial value of the control

min_value - The minimum display value of the control. Only used for display purposes

max_value - The maximum display value of the control. Only used for display purposes

DynamicControl

public DynamicControl(de.sciss.net.OSCMessage msg)

Create a DynamicControl based on OSC Message. This will keep OSC implementation inside this class The buildUpdateMessage shows how messages are constructed

Parameters:

msg - the OSC Message with the parameters to make Control

Method Detail

enableProcessControlMessage

public static boolean enableProcessControlMessage(java.lang.String device_name,
                                                  int message_id)

See if we will process a control message based on device name and message_id If the message_id is mapped against the device_name, ignore message, otherwise store mapping and return true;

Parameters:

device_name - the device name

message_id - the message_id

Returns:

true if we are going to process this message

getSendingDevice

public java.lang.String getSendingDevice()

Get the name of the device that sent the message. If the message was local, will return this device name

Returns:

name of device that sent message

getTargetDeviceAddresses

public java.util.Set<java.lang.String> getTargetDeviceAddresses()

Return all mapped device addresses for this control

Returns:

returns the set of mapped targeted devices

doScheduledEvent

public void doScheduledEvent(double scheduledTime,
                             java.lang.Object param)

Description copied from interface: ScheduledEventListener

Notification interface that a scheduled event is occuring

Specified by:

doScheduledEvent in interface ScheduledEventListener

Parameters:

scheduledTime - the time that was scheduled for the callback to occur

param - the parameter to pass to the listener.

addTargetDevice

public void addTargetDevice(java.lang.String... deviceNames)

Add one or more device names or addresses as strings to use in ControlScope.TARGET Message

Parameters:

deviceNames - device name or IP Address

setTargetDevice

public void setTargetDevice(java.lang.String... deviceNames)

Remove all set target devices and replace with the those provided as arguments Adds device address as a string or device name to ControlScope.TARGET Message

Parameters:

deviceNames - device name or IP Address

setTargetDevice

public void setTargetDevice(java.net.InetAddress... inetAddresses)

Remove all set target devices and replace with the those provided as arguments Adds device addresses to ControlScope.TARGET Message

Parameters:

inetAddresses - device name or IP Address

addTargetDevice

public void addTargetDevice(java.net.InetAddress... inetAddresses)

Add one or more device InetAddress for use in ControlScope.TARGET Message

Parameters:

inetAddresses - the target addresses to add

clearTargetDevices

public void clearTargetDevices()

Clear all devices as Targets

removeTargetDevice

public void removeTargetDevice(java.lang.String... deviceNames)

Remove one or more device names or addresses as a string. For use in ControlScope.TARGET Messages

Parameters:

deviceNames - device names or IP Addresses to remove

removeTargetDevice

public void removeTargetDevice(java.net.InetAddress... inetAddresses)

Remove one or more InetAddress for use in ControlScope.TARGET Message

Parameters:

inetAddresses - the target addresses to remove

setTooltipPrefix

public DynamicControl setTooltipPrefix(java.lang.String tooltipPrefix)

Create the text we will display at the beginning of tooltip

Parameters:

tooltipPrefix - The starting text of the tooltip

Returns:

this object

setDisableScheduler

public static void setDisableScheduler(boolean disabled)

Set whether we disable setting all values in context of scheduler

Parameters:

disabled - set true to disable

getDisplayType

public DynamicControl.DISPLAY_TYPE getDisplayType()

Whether we disable the control on the screen

Returns:

How we will disable control on screen

setDisplayType

public DynamicControl setDisplayType(DynamicControl.DISPLAY_TYPE display_type)

Set how we will display control object on the screen

Parameters:

display_type - how we will display control

Returns:

this

getExecutionTime

public double getExecutionTime()

Returns the JVM execution time we last used when we set the value

Returns:

lastExecution time set

getParentSketch

public java.lang.Object getParentSketch()

Get the Sketch or class object linked to this control

Returns:

the parentSketch or Object

getControlType

public static ControlType getControlType(java.lang.Object value)

Ascertain the Control Type based on the Value

Parameters:

value - the value we are obtaing a control value from

Returns:

a control type

setPersistentController

public DynamicControl setPersistentController()

Set this control as a persistentSimulation control so it does not get removed on reset

Returns:

this

isPersistentControl

public boolean isPersistentControl()

See if control is a persistent control

Returns:

true if a simulator control

getControlType

public ControlType getControlType()

Get the type of control we want

Returns:

The type of value this control is

getControlScope

public ControlScope getControlScope()

Get the scope of this control. Can be Sketch, Class, Device, or global

Returns:

The Scope

setControlScope

public DynamicControl setControlScope(ControlScope new_scope)

Changed the scope that the control has. It will update control map so the correct events will be generated based on its scope

Parameters:

new_scope - The new Control Scope

Returns:

this object

getControl

public static DynamicControl getControl(java.lang.String map_key)

Get the Dynamic control based on Map key

Parameters:

map_key - the string that we are using as the key

Returns:

the Object associated with this control

updateControl

public DynamicControl updateControl(DynamicControl mirror_control)

Update the parameters of this control with another. This would have been caused by an object having other than SKETCH control scope If the parameters are changed, this object will notify it's listeners that a change has occurred

Parameters:

mirror_control - The control that we are copying from

Returns:

this object

processDeviceNameMessage

public static void processDeviceNameMessage(java.net.InetAddress src_address,
                                            de.sciss.net.OSCMessage msg)

Process the DynamicControl deviceName message and map device name to IPAddress We ignore our own device

Parameters:

src_address - The address of the device

msg - The OSC Message that has device name

processRequestNameMessage

public static void processRequestNameMessage(java.net.InetAddress src_address,
                                             de.sciss.net.OSCMessage msg)

Process the DynamicControl deviceRequest message Send a deviceName back to src. Test that their name is mapped correctly If name is not mapped we will request from all devices globally

Parameters:

src_address - The address of the device

msg - The OSC Message that has device name

postRequestNamesMessage

public static void postRequestNamesMessage()

Post a request device name message to other devices so we can target them specifically and update our map

buildDeviceNameMessage

public static de.sciss.net.OSCMessage buildDeviceNameMessage()

Build OSC Message that gives our device name

Returns:

OSC Message that has name

buildDeviceRequestNameMessage

public static de.sciss.net.OSCMessage buildDeviceRequestNameMessage()

Build OSC Message that requests devices send us their name

Returns:

OSC Message to request name

integersToLong

public static long integersToLong(int msi,
                                  int lsi)

Convert two halves of a long stored integer values into a long value

Parameters:

msi - most significant integer

lsi - least significant integer

Returns:

a long value consisting of the concatenation of both int values

longToIntegers

public static int[] longToIntegers(long l_value)

Convert a long into two integers in an array of two integers

Parameters:

l_value - the Long values that needs to be encoded

Returns:

an array of two integers. ret[0] will be most significant integer while int [1] will be lease significant

numberIntsForScheduledTime

public static int numberIntsForScheduledTime()

Return the array size of Integers that would be required to encode a scheduled time

Returns:

the Array

scheduleTimeToIntegers

public static int[] scheduleTimeToIntegers(double d_val)

Convert a SchedulerTime into integers in an array of three integers

Parameters:

d_val - the double values that needs to be encoded

Returns:

an array of three integers. ret[0] will be most significant integer while int [1] will be lease significant. int [2] is the number of nano seconds

integersToScheduleTime

public static double integersToScheduleTime(int msi,
                                            int lsi,
                                            int nano)

Convert three integers to a double representing scheduler time

Parameters:

msi - the most significant value of millisecond value

lsi - the least significant value of millisecond value

nano - the number of nanoseconds

Returns:

a double representing the scheduler time

processOSCControlMessage

public static void processOSCControlMessage(de.sciss.net.OSCMessage msg,
                                            ControlScope controlScope)

Process the ControlScope.GLOBAL or ControlScope.TARGET Message from an OSC Message. Examine buildUpdateMessage for parameters inside Message We will not process messages that have come from this device because they will be actioned through local listeners

Parameters:

msg - OSC message with new value

controlScope - the type of ControlScope;

processUpdateMessage

public static void processUpdateMessage(de.sciss.net.OSCMessage msg)

Process the Update Message from an OSC Message. Examine buildUpdateMessage for parameters inside Message The message is directed as a specific control defined by the MAP_KEY parameter in the OSC Message

Parameters:

msg - OSC message with new value

buildRemoveMessage

public de.sciss.net.OSCMessage buildRemoveMessage()

Build OSC Message that specifies a removal of a control

Returns:

OSC Message to notify removal

buildUpdateMessage

public de.sciss.net.OSCMessage buildUpdateMessage()

Build OSC Message that specifies an update

Returns:

OSC Message To send to specific control

buildNetworkSendMessage

public de.sciss.net.OSCMessage buildNetworkSendMessage()

Build OSC Message that specifies a Network update

Returns:

OSC Message directed to controls with same name, scope, but on different devices

buildCreateMessage

public de.sciss.net.OSCMessage buildCreateMessage()

Build the OSC Message for a create message

Returns:

OSC Message required to create the object

getControlMapKey

public java.lang.String getControlMapKey()

Get the map key created in the device as a method for mapping back

Returns:

The unique key to identify this object

setValue

public DynamicControl setValue(java.lang.Object val)

Set the value of the object and notify any listeners Additionally, the value will propagate to any controls that match the control scope If we are using a trigger, send a random number or a unique value

Parameters:

val - the value to set

Returns:

this object

setValue

public DynamicControl setValue(java.lang.Object val,
                               double execution_time)

Set the value of the object and notify any listeners Additionally, the value will propagate to any controls that match the control scope If we are using a trigger, send a random number or a unique value

Parameters:

val - the value to set

execution_time - the Scheduler time we want this to occur

Returns:

this object

getValue

public java.lang.Object getValue()

Gets the value of the control. The type needs to be cast to the required type in the listener

Returns:

Control Value

getMaximumDisplayValue

public java.lang.Object getMaximumDisplayValue()

The maximum value that we want as a display, for example, in a slider control. Does not limit values in the messages

Returns:

The maximum value we want a graphical display to be set to

setMinimumValue

public DynamicControl setMinimumValue(java.lang.Object min)

Set the minimum display range for display

Parameters:

min - minimum display value

Returns:

this

setMaximumDisplayValue

public DynamicControl setMaximumDisplayValue(java.lang.Object max)

Set the maximum display range for display

Parameters:

max - maximum display value

Returns:

this

getMinimumDisplayValue

public java.lang.Object getMinimumDisplayValue()

The minimum value that we want as a display, for example, in a slider control. Does not limit values in the messages

Returns:

The minimum value we want a graphical display to be set to

getControlName

public java.lang.String getControlName()

Get the name of the control used for ControlScope matching. Also displayed in GUI

Returns:

The name of the control for scope matching

addControlListener

public DynamicControl addControlListener(DynamicControl.DynamicControlListener listener)

Register Listener to receive changed values in the control

Parameters:

listener - Listener to register for events

Returns:

this

addGlobalControlListener

public DynamicControl addGlobalControlListener(DynamicControl.DynamicControlListener listener)

Register Listener to receive changed values in the control that need to be global type messages

Parameters:

listener - Listener to register for events

Returns:

this listener that has been created

addValueSetListener

public DynamicControl addValueSetListener(DynamicControl.DynamicControlListener listener)

Register Listener to receive changed values in the control that need to be received when value is specifically set from Within sketch

Parameters:

listener - Listener to register for events

Returns:

this

removeControlListener

public DynamicControl removeControlListener(DynamicControl.DynamicControlListener listener)

Deregister listener so it no longer receives messages from this control

Parameters:

listener - The lsitener we are removing

Returns:

this object

removeGlobalControlListener

public DynamicControl removeGlobalControlListener(DynamicControl.DynamicControlListener listener)

Deregister listener so it no longer receives messages from this control

Parameters:

listener - the listener we are remmoving

Returns:

this object

addControlScopeListener

public DynamicControl addControlScopeListener(DynamicControl.ControlScopeChangedListener listener)

Register Listener to receive changed values in the control scope

Parameters:

listener - Listener to register for events

Returns:

this object

removeControlScopeChangedListener

public DynamicControl removeControlScopeChangedListener(DynamicControl.ControlScopeChangedListener listener)

Deregister listener so it no longer receives messages from this control

Parameters:

listener - the listener

Returns:

this object

eraseListeners

public DynamicControl eraseListeners()

Erase all listeners from this control

Returns:

this object

notifyLocalListeners

public DynamicControl notifyLocalListeners()

Notify all registered listeners of object value on this device

Returns:

this object

notifyValueSetListeners

public void notifyValueSetListeners()

Send Update Message when value set

notifyGlobalListeners

public void notifyGlobalListeners()

Send Global Update Message

notifyControlChangeListeners

public DynamicControl notifyControlChangeListeners()

Notify all registered listeners of object value

Returns:

this object

getTooltipText

public java.lang.String getTooltipText()

Get the tooltip to display

Returns:

the tooltip to display