net.happybrackets.core.control

Class TextControl

java.lang.Object

net.happybrackets.core.control.DynamicControlParent

net.happybrackets.core.control.TextControl

Direct Known Subclasses:

TextControlSender

public class TextControl
extends DynamicControlParent

This class encapsulates the functionality of DynamicControl classes of type ControlType.TEXT in a simple API
All Text controls with the same name and ControlScope will respond to a message send. For example: For example, consider two TextControls with the same ControlScope and name
When the control receives the value, it will be passed through to the valueChanged(String) listener that is implemented when the class is created.
For example

 TextControl control1 = new TextControl(this, "Read", "");
 TextControl control2 = new TextControl(this, "Read", "") {
     @Override
    public void valueChanged(String control_val) {
        System.out.println("Read " + control_val);
    }
};

 control1.setValue("This is text");
 

Will cause the valueChanged(String) function to be called with the new value, causing Read This is text 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(String, double) function. Eg
control1.setValue ("Hi There", HB.getSchedulerTime() + 1000); // this will set control1 value, as well as all other TextControls with same ControlScope and name, to "Hi There" 1 second in the future
Setting the value within the HappyBrackets control display is effected by typing a new value in and pressing ENTER or RETURN If you do not require a handler on the class, override the valueChanged(String) function

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getValue() Get the value for the control.
TextControl	setControlScope(ControlScope new_scope) Changed the ControlScope that the control has.
TextControl	setDisplayType(DynamicControl.DISPLAY_TYPE display_type) Change how to display object as DynamicControl.DISPLAY_TYPE We must do this in subclass
void	setValue(java.lang.String val) Set the value for the control.
void	setValue(java.lang.String val, double scheduler_time) set the value for the control at a specific time.
void	valueChanged(java.lang.String control_val)

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

TextControl

public TextControl(java.lang.Object parent_sketch,
                   java.lang.String name,
                   java.lang.String 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.String getValue()

Get the value for the control. For example

    TextControl control1 = new TextControl(this, "Read", "");

    String val =  control1.getValue(); // val = ""
    control1.setValue("This is text");
    val =  control1.getValue(); // val = "This is text"
     

Returns:

the control value

valueChanged

public void valueChanged(java.lang.String control_val)

setValue

public void setValue(java.lang.String 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(String).

 TextControl control1 = new TextControl(this, "Read", "");
 TextControl control2 = new TextControl(this, "Read", "") {
     @Override
    public void valueChanged(String control_val) {
        System.out.println("Read " + control_val);
    }
 };

 control1.setValue("This is text");
 

Will cause the valueChanged(String) function to be called with the new value, causing Read This is text to be printed to standard output.

Parameters:

val - the value to set to

setValue

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

set the value for the control at a specific time. Identical to the setValue(String) with the exception that the valueChanged(String) 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 control1.setValue ("Hi There", HB.getSchedulerTime() + 1000); // this will set control1 value, as well as all other TextControls with same ControlScope and name, to "Hi There" 1 second in the future

Parameters:

val - the value to set to

scheduler_time - the scheduler time this is supposed to occur at

setControlScope

public TextControl setControlScope(ControlScope new_scope)

Changed the ControlScope that the control has. It will update control map so the correct events will be generated based on its scope We must do this in subclass

Overrides:

setControlScope in class DynamicControlParent

Parameters:

new_scope - The new Control Scope

Returns:

this object

setDisplayType

public TextControl setDisplayType(DynamicControl.DISPLAY_TYPE display_type)

Change how to display object as DynamicControl.DISPLAY_TYPE We must do this in subclass

Parameters:

display_type - The new Display type

Returns:

this object