ScriptLabel

Create a reference to a Label UI component and modify its values.

const var Label1 = Content.getComponent("Label1");

Class methods

addToMacroControl

Adds the knob / button to a macro controller (from 0 to 7). Edit on GitHub

ScriptLabel.addToMacroControl(int macroIndex)

changed

Call this to indicate that the value has changed (the onControl callback will be executed. Edit on GitHub

ScriptLabel.changed()

createLocalLookAndFeel

Returns a local look and feel if it was registered before. Edit on GitHub

ScriptLabel.createLocalLookAndFeel(ScriptContentComponent *contentComponent, Component *componentToRegister)

fadeComponent

Toggles the visibility and fades a component using the global animator. Edit on GitHub

ScriptLabel.fadeComponent(bool shouldBeVisible, int milliseconds)

get

returns the value of the property. Edit on GitHub

ScriptLabel.get(String propertyName)

getAllProperties

Returns a list of all property IDs as array. Edit on GitHub

ScriptLabel.getAllProperties()

getChildComponents

Returns list of component's children Edit on GitHub

ScriptLabel.getChildComponents()

getGlobalPositionX

Returns the absolute x-position relative to the interface. Edit on GitHub

ScriptLabel.getGlobalPositionX()

getGlobalPositionY

Returns the absolute y-position relative to the interface. Edit on GitHub

ScriptLabel.getGlobalPositionY()

getHeight

Returns the height of the component. Edit on GitHub

ScriptLabel.getHeight()

getId

Returns the ID of the component. Edit on GitHub

ScriptLabel.getId()

getLocalBounds

Returns a [x, y, w, h] array that was reduced by the given amount. Edit on GitHub

ScriptLabel.getLocalBounds(float reduceAmount)

getValue

Returns the current value. Edit on GitHub

ScriptLabel.getValue()  override

getValueNormalized

Returns the normalized value. Edit on GitHub

ScriptLabel.getValueNormalized()

getWidth

Returns the width of the component. Edit on GitHub

ScriptLabel.getWidth()

grabFocus

Call this method in order to grab the keyboard focus for this component. Edit on GitHub

ScriptLabel.grabFocus()

loseFocus

Call this method in order to give away the focus for this component. Edit on GitHub

ScriptLabel.loseFocus()

sendRepaintMessage

Manually sends a repaint message for the component. Edit on GitHub

ScriptLabel.sendRepaintMessage()

set

Sets the property. Edit on GitHub

ScriptLabel.set(String propertyName, var value)

setColour

sets the colour of the component (BG, IT1, IT2, TXT). Edit on GitHub

ScriptLabel.setColour(int colourId, int colourAs32bitHex)

setConsumedKeyPresses

Registers a selection of key presses to be consumed by this component. Edit on GitHub

ScriptLabel.setConsumedKeyPresses(var listOfKeys)

setControlCallback

Pass a inline function for a custom callback event. Edit on GitHub

ScriptLabel.setControlCallback(var controlFunction)

setEditable

makes a label editable . Edit on GitHub

ScriptLabel.setEditable(bool shouldBeEditable)

setKeyPressCallback

Adds a callback to react on key presses (when this component is focused). Edit on GitHub

ScriptLabel.setKeyPressCallback(var keyboardFunction)

setLocalLookAndFeel

Attaches the local look and feel to this component. Edit on GitHub

ScriptLabel.setLocalLookAndFeel(var lafObject)

setPosition

Sets the position of the component. Edit on GitHub

ScriptLabel.setPosition(int x, int y, int w, int h)

setPropertiesFromJSON

Restores all properties from a JSON object. Edit on GitHub

ScriptLabel.setPropertiesFromJSON( var jsonData)

setStyleSheetClass

Sets the given class selectors for the component stylesheet. Edit on GitHub

ScriptLabel.setStyleSheetClass( String classIds)

setStyleSheetProperty

Sets a variable for this component that can be queried from a style sheet. Edit on GitHub

ScriptLabel.setStyleSheetProperty( String variableId,  var value,  String type)

setStyleSheetPseudoState

Programatically sets a pseudo state (:hover, :active, :checked, :focus, :disabled) that will be used by the CSS renderer. Edit on GitHub

ScriptLabel.setStyleSheetPseudoState( String pseudoState)

setTooltip

Shows a informative text on mouse hover. Edit on GitHub

ScriptLabel.setTooltip( String tooltip)

setValueNormalized

Sets the current value from a range 0.0 ... 1.0. Edit on GitHub

ScriptLabel.setValueNormalized(double normalizedValue)

setValueWithUndo

Sets the current value and adds it to the undo list. Don't call this from onControl! Edit on GitHub

ScriptLabel.setValueWithUndo(var newValue)

setZLevel

Changes the depth hierarchy (z-axis) of sibling components (Back, Default, Front or AlwaysOnTop). Edit on GitHub

ScriptLabel.setZLevel(String zLevel)

showControl

Hides / Shows the control. Edit on GitHub

ScriptLabel.showControl(bool shouldBeVisible)

updateContentPropertyInternal

This updates the internal content data object from the script processor. Edit on GitHub

ScriptLabel.updateContentPropertyInternal(int propertyId,  var newValue)

updateValueFromProcessorConnection

Updates the value from the processor connection. Call this method whenever the module state has changed and you want to refresh the knob value to show the current state. Edit on GitHub

ScriptLabel.updateValueFromProcessorConnection()