net.happybrackets.core.control

Class DynamicControlParent

java.lang.Object

net.happybrackets.core.control.DynamicControlParent

Direct Known Subclasses:

BooleanControl, ClassObjectControl, FloatControl, IntegerControl, TextControl, TriggerControl

public abstract class DynamicControlParent
extends java.lang.Object

The DynamicControlParent facilitates a simplified abstract API to implement the DynamicControl class. The values can be represented as sliders, text boxes, check boxes, and buttons

A message can either be:
an integer - IntegerControl,
a double - FloatControl,
a string - TextControl,
a Boolean - BooleanControl,
a trigger - TriggerControl, or
a complete class - ClassObjectControl.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DynamicControlParent(DynamicControl dynamicControl) Constructor

Method Summary

Modifier and Type	Method and Description
DynamicControlParent	addControlListener(DynamicControl.DynamicControlListener listener) Register Listener to receive changed values in the control
DynamicControlParent	addControlScopeListener(DynamicControl.ControlScopeChangedListener listener) Register Listener to receive changed values in the control scope
void	addControlTarget(java.net.InetAddress... deviceAddresses) Add one or more InetAddress as a target for DynamicControl messages.
void	addControlTarget(java.lang.String... devices) Add one or more device names or IP address as a target for DynamicControl messages.
void	clearControlTargets() Erase all target addresses for the DynamicControl
DynamicControl	getDynamicControl() Provide underlying access to DynamicControl object
java.lang.String	getSendingDevice() Get the name of the device that sent the message.
DynamicControlParent	removeControlListener(DynamicControl.DynamicControlListener listener) Deregister listener so it no longer receives messages from this control
DynamicControlParent	removeControlScopeChangedListener(DynamicControl.ControlScopeChangedListener listener) Deregister listener so it no longer receives messages from this control
void	removeControlTarget(java.net.InetAddress... inetAddresses) Remove one or more InetAddress as a target for DynamicControl messages.
void	removeControlTarget(java.lang.String... devices) Remove one or more device name or IP address as a target for DynamicControl messages.
void	removeListeners() Removes all listeners from this object
DynamicControlParent	setControlScope(ControlScope new_scope) Changed the ControlScope the object has has.
void	setControlTarget(java.net.InetAddress... deviceAddresses) Clear existing targets and add one or more InetAddress as a target for DynamicControl messages.
void	setControlTarget(java.lang.String... devices) Clear existing targets and add one or more device names or IP address as a target for DynamicControl messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicControlParent

protected DynamicControlParent(DynamicControl dynamicControl)

Constructor

Parameters:

dynamicControl - our control

Method Detail

removeListeners

public void removeListeners()

Removes all listeners from this object

addControlListener

public DynamicControlParent addControlListener(DynamicControl.DynamicControlListener listener)

Register Listener to receive changed values in the control

Parameters:

listener - Listener to register for events

Returns:

this

removeControlListener

public DynamicControlParent 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

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

addControlScopeListener

public DynamicControlParent 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 DynamicControlParent removeControlScopeChangedListener(DynamicControl.ControlScopeChangedListener listener)

Deregister listener so it no longer receives messages from this control

Parameters:

listener - the listener

Returns:

this object

getDynamicControl

public DynamicControl getDynamicControl()

Provide underlying access to DynamicControl object

Returns:

the underlying DynamicControl object

addControlTarget

public void addControlTarget(java.lang.String... devices)

Add one or more device names or IP address as a target for DynamicControl messages. The control must have ControlScope.TARGET scope to have any effect

Parameters:

devices - the device name or IP address to target

setControlTarget

public void setControlTarget(java.lang.String... devices)

Clear existing targets and add one or more device names or IP address as a target for DynamicControl messages. The control must have ControlScope.TARGET scope to have any effect

Parameters:

devices - the device name or IP address to target

addControlTarget

public void addControlTarget(java.net.InetAddress... deviceAddresses)

Add one or more InetAddress as a target for DynamicControl messages. The control must have ControlScope.TARGET scope to have any effect

Parameters:

deviceAddresses - the addresses of the targets

setControlTarget

public void setControlTarget(java.net.InetAddress... deviceAddresses)

Clear existing targets and add one or more InetAddress as a target for DynamicControl messages. The control must have ControlScope.TARGET scope to have any effect

Parameters:

deviceAddresses - the addresses of the targets

clearControlTargets

public void clearControlTargets()

Erase all target addresses for the DynamicControl

removeControlTarget

public void removeControlTarget(java.lang.String... devices)

Remove one or more device name or IP address as a target for DynamicControl messages. The control must have ControlScope.TARGET scope to have any effect

Parameters:

devices - the device names or IP addresses to remove as targets

removeControlTarget

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

Remove one or more InetAddress as a target for DynamicControl messages. The control must have ControlScope.TARGET scope to have any effect

Parameters:

inetAddresses - the addresses of the targets to remove

setControlScope

public DynamicControlParent setControlScope(ControlScope new_scope)

Changed the ControlScope the object has 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