net.happybrackets.core.control

Class BooleanControl

java.lang.Object

net.happybrackets.core.control.DynamicControlParent

net.happybrackets.core.control.BooleanControl

Direct Known Subclasses:

BooleanControlSender

public class BooleanControl
extends DynamicControlParent

This class encapsulates the functionality of DynamicControl classes of type ControlType.BOOLEAN in a simple API.

All BooleanControl objects with the same name and ControlScope will respond to a setValue(Boolean). For example, consider two BooleanControls with the same ControlScope and name

 BooleanControl control1 = new BooleanControl(this, "Read", false);
 BooleanControl control2 = new BooleanControl(this, "Read", false) {
     @Override
    public void valueChanged(Boolean control_val) {
        System.out.println("Read " + control_val);
    }
};// End DynamicControl control2 code

 control1.setValue(true); // Setting control1 will also set control2
 

Will cause the valueChanged(Boolean) function to be called with the new value, causing Read true to be printed to standard output

The control can also schedule messages to be sent at a time in the future by adding the time to the message using an absolute time in the setValue(Boolean, double) function. Eg:

control1.setValue (true, HB.getSchedulerTime() + 1000); // this will set control1 value, as well as all other BooleanControls with same ControlScope and name, to true 1 second in the future


Setting the value within the HappyBrackets controls display is effected using a checkbox, where a checked value is true.
It is possible to get current value using the getValue() If you require a handler on the class, override valueChanged(Boolean) function

Constructor Summary

Constructors

Constructor and Description
BooleanControl(java.lang.Object parent_sketch, java.lang.String name, java.lang.Boolean initial_value) Constructor for abstract FloatControl.

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getValue() Get the value for the control
BooleanControl	setControlScope(ControlScope new_scope) Changed the ControlScope the object has has.
BooleanControl	setDisplayType(DynamicControl.DISPLAY_TYPE display_type) Change how to display object as DynamicControl.DISPLAY_TYPE
void	setValue(java.lang.Boolean val) set the value for the control.
void	setValue(java.lang.Boolean val, double scheduler_time) Identical to the setValue(Boolean) with the exception that the valueChanged(Boolean) event will be caused at the HBScheduler scheduled time passed in.
void	valueChanged(java.lang.Boolean control_val) Fired event that occurs when the value for the control has been set.

Methods inherited from class net.happybrackets.core.control.DynamicControlParent

addControlListener, addControlScopeListener, addControlTarget, addControlTarget, clearControlTargets, getDynamicControl, getSendingDevice, removeControlListener, removeControlScopeChangedListener, removeControlTarget, removeControlTarget, removeListeners, setControlTarget, setControlTarget

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanControl

public BooleanControl(java.lang.Object parent_sketch,
                      java.lang.String name,
                      java.lang.Boolean initial_value)

Constructor for abstract FloatControl. Slider, Text and Buddy Control will derive from this class

Parameters:

parent_sketch - The parent object for control

name - The name to Display

initial_value - Initial value of the object

Method Detail

getValue

public java.lang.Boolean getValue()

Get the value for the control

     BooleanControl control1 = new BooleanControl(this, "Read", false);

     boolean val = control1.getValue(); // val will be false
     control1.setValue(true);
     val = control1.getValue(); // val will be true
     

Returns:

the control value

valueChanged

public void valueChanged(java.lang.Boolean control_val)

Fired event that occurs when the value for the control has been set. This will pass the message on to all other DynamicControl with matching name, type and ControlScope and call valueChanged(Boolean). The function must be implemented when creating objects

     BooleanControl control1 = new BooleanControl(this, "Read", false);
     BooleanControl control2 = new BooleanControl(this, "Read", false) {
        @Override
        public void valueChanged(Boolean control_val) {
            System.out.println("Read " + control_val);
        }
     };// End DynamicControl control2 code

     control1.setValue(true);// Setting control1 will also set control2
     

Will cause the valueChanged(Boolean) function to be called with the new value, causing Read true to be printed to standard output

Parameters:

control_val - The new value of the control

setValue

public void setValue(java.lang.Boolean val)

set the value for the control. This will notify all the listeners with same name and ControlScope. For example

     BooleanControl control1 = new BooleanControl(this, "Read", false);
     BooleanControl control2 = new BooleanControl(this, "Read", false) {
         @Override
        public void valueChanged(Boolean control_val) {
            System.out.println("Read " + control_val);
        }
     };// End DynamicControl control2 code

     control1.setValue(true); // Setting control1 will also set control2
     

Will cause the valueChanged(Boolean) function to be called with the new value, causing Read true to be printed to standard output

The control can also schedule messages to be sent at a time in the future by adding the time to the message using an absolute time in the setValue(Boolean, double) function.

Parameters:

val - the value to set to

setValue

public void setValue(java.lang.Boolean val,
                     double scheduler_time)

Identical to the setValue(Boolean) with the exception that the valueChanged(Boolean) event will be caused at the HBScheduler scheduled time passed in.
For example, the following code will cause matching DynamicControl objects to respond 1 second in the future

     BooleanControl control1 = new BooleanControl(this, "Read", false);
     BooleanControl control2 = new BooleanControl(this, "Read", false) {
         @Override
            public void valueChanged(Boolean control_val) {
            System.out.println("Read " + control_val);
        }
     };// End DynamicControl control2 code

     control1.setValue(true, HB.getSchedulerTime() + 1000); // Setting control1 will also set control2
     

Will cause the valueChanged(Boolean) function to be called with the new value one second in the future, causing Read true to be printed to standard output one second in the future

Parameters:

val - the value to set to

scheduler_time - the scheduler time this is supposed to occur at

setControlScope

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

Overrides:

setControlScope in class DynamicControlParent

Parameters:

new_scope - The new Control Scope

Returns:

this object

setDisplayType

public BooleanControl setDisplayType(DynamicControl.DISPLAY_TYPE display_type)

Change how to display object as DynamicControl.DISPLAY_TYPE

Parameters:

display_type - The new Control Scope

Returns:

this object