net.happybrackets.core.control

Class IntegerControl

java.lang.Object

net.happybrackets.core.control.DynamicControlParent

net.happybrackets.core.control.IntegerControl

Direct Known Subclasses:

IntegerBuddyControl, IntegerSliderControl, IntegerTextControl

public class IntegerControl
extends DynamicControlParent

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

All IntegerControl controls with the same name and ControlScope will respond to a message send. For example: For example, consider two IntegerControls with the same ControlScope and name Setting the value of control1 will cause any objects listening to control1 or control2 to receive the action. EG

When the control receives the value, it will be passed through to the valueChanged(int) )} listener that is implemented when the class is created.
For example:

 IntegerControl control1 = new IntegerControl(this, "Read", 0);

 IntegerControl control2 = new IntegerControl(this, "Read", 0) {
     @Override
    public void valueChanged(int control_val) {
        System.out.println("Read " + control_val);
    }
};

 control1.setValue(2); // this will also set the value of control2
 

Will cause the valueChanged(int) function to be called with the new value, causing Read 2 to be printed to standard output. This is because both controls are ControlScope.SKETCH by default and are both have their name as "Read.

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(int, double) function. Eg
control1.setValue (2, HB.getSchedulerTime() + 1000); // this will set control1 value, as well as all other IntegerControl with same ControlScope and name, to true 1 second in the future
You can also set the value from within the HappyBrackets plugin IDE.
Additionally, you can get current value by calling the getValue() function. If you require a handler on the class, override the valueChanged(int) function

Constructor Summary

Constructors

Constructor and Description
IntegerControl(java.lang.Object parent_sketch, java.lang.String name, int initial_value) Constructor for abstract IntegerControl.
IntegerControl(java.lang.Object parent_sketch, java.lang.String name, int initial_value, int min_val, int max_val, DynamicControl.DISPLAY_TYPE display_type) Constructor for IntegerControl if you want it displayed other than text control.

Method Summary

Modifier and Type	Method and Description
int	getValue() Get the value for the control.
IntegerControl	setControlScope(ControlScope new_scope) Changed the ControlScope the object has has.
IntegerControl	setDisplayRange(int minimum, int maximum, DynamicControl.DISPLAY_TYPE display_type) Set how we want this control displayed
IntegerControl	setDisplayType(DynamicControl.DISPLAY_TYPE display_type) Change how to display object We must do this in subclass
void	setValue(int val) set the value for the control.
void	setValue(int val, double scheduler_time) set the value for the control at a specific time.
void	valueChanged(int control_val) When the control receives the value, it will be passed through to the valueChanged(int) listener that is implemented when the class is created.

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

IntegerControl

public IntegerControl(java.lang.Object parent_sketch,
                      java.lang.String name,
                      int initial_value,
                      int min_val,
                      int max_val,
                      DynamicControl.DISPLAY_TYPE display_type)

Constructor for IntegerControl if you want it displayed other than text control.

Parameters:

parent_sketch - The parent object for control

name - The name to Display

initial_value - Initial value of the object

min_val - Minimum value to display on Slider

max_val - Maximum value to display on Slider

display_type - The way we want object displayed

IntegerControl

public IntegerControl(java.lang.Object parent_sketch,
                      java.lang.String name,
                      int initial_value)

Constructor for abstract IntegerControl. This allows creation without a display

Parameters:

parent_sketch - The parent object for control

name - The name to Display

initial_value - Initial value of the object

Method Detail

getValue

public int getValue()

Get the value for the control.

IntegerControl control1 = new IntegerControl(this, "Read", 0);

IntegerControl control2 = new IntegerControl(this, "Read", 0) {
      @Override
    public void valueChanged(int control_val) {
        System.out.println("Read " + control_val);
    }
};

int val = control1.getValue(); // val = 0
control1.setValue(2);
val = control1.getValue();// val = 1
     

Returns:

the control value

valueChanged

public void valueChanged(int control_val)

When the control receives the value, it will be passed through to the valueChanged(int) listener that is implemented when the class is created.
For example

IntegerControl control1 = new IntegerControl(this, "Read", 0);

IntegerControl control2 = new IntegerControl(this, "Read", 0) {
     @Override
    public void valueChanged(int control_val) {
        System.out.println("Read " + control_val);
    }
};

control1.setValue(2); // this will also set the value of control2

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

Parameters:

control_val - the value received

setValue

public void setValue(int val)

set the value for the control. This will pass the message on to all other DynamicControl with matching name, type and ControlScope and call valueChanged(int).

 IntegerControl control1 = new IntegerControl(this, "Read", 0);

 IntegerControl control2 = new IntegerControl(this, "Read", 0) {
     @Override
    public void valueChanged(int control_val) {
        System.out.println("Read " + control_val);
    }
 };

 control1.setValue(2); // this will also set the value of control2
     

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

Parameters:

val - the value to set to

setValue

public void setValue(int val,
                     double scheduler_time)

set the value for the control at a specific time. Identical to the setValue(int) with the exception that the valueChanged(int) 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

     IntegerControl control1 = new IntegerControl(this, "Read", 0);

     IntegerControl control2 = new IntegerControl(this, "Read", 0) {
         @Override
        public void valueChanged(int control_val) {
        System.out.println("Read " + control_val);
        }
     };

     control1.setValue(2, HB.getSchedulerTime() + 1000); // this will also set the value of control2
     

Parameters:

val - the value to set to

scheduler_time - the scheduler time this is supposed to occur at

setDisplayType

public IntegerControl setDisplayType(DynamicControl.DISPLAY_TYPE display_type)

Change how to display object We must do this in subclass

Parameters:

display_type - The new Control Scope

Returns:

this object

setControlScope

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

setDisplayRange

public IntegerControl setDisplayRange(int minimum,
                                      int maximum,
                                      DynamicControl.DISPLAY_TYPE display_type)

Set how we want this control displayed

Parameters:

minimum - minimum display value on slider

maximum - maximum display value on slider

display_type - the type of display

Returns:

this