Package heronarts.lx.midi.surface

Class FocusedDevice

java.lang.Object

heronarts.lx.midi.surface.FocusedDevice

public class FocusedDevice
extends Object

Utility class for a control surface to subscribe to notifications about which device is focused in the UI. This needs to be registered and unregistered as appropriate to enable/disable notifications. And the listener interface is invoked whenever there is a device focus change.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FocusedDevice.Listener

Constructor Summary

Constructors

Constructor	Description
FocusedDevice(LX lx, FocusedDevice.Listener listener)
FocusedDevice(LX lx, LXMidiSurface surface, FocusedDevice.Listener listener)

Method Summary

Modifier and Type	Method	Description
void	dispose()
LXDeviceComponent	getDevice()	Returns the device presently focused, if any
LXBus	getFocusedChannel()	Returns the currently focused bus
DiscreteParameter	getFocusedChannelTarget()
boolean	isAux()
boolean	isAuxActive()
void	nextChannel()
void	nextDevice()	Shift focus to the next device on the channel, if there is one
void	previousChannel()
void	previousDevice()	Shift focus to the previous device on the channel, if there is one
void	register()	Register the focused device listener, which will result in a listener callback to the presently focused device.
FocusedDevice	setAux(boolean isAux)
FocusedDevice	setAuxSticky(boolean isAuxSticky)
FocusedDevice	toggleAux()
void	unregister()	Unregister the focus listener.
void	updateRemoteControlFocus()

Methods inherited from class java.lang.Object

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

Constructor Details

FocusedDevice

public FocusedDevice(LX lx,
 FocusedDevice.Listener listener)

FocusedDevice

public FocusedDevice(LX lx,
 LXMidiSurface surface,
 FocusedDevice.Listener listener)

Method Details

isAux

public boolean isAux()

toggleAux

public FocusedDevice toggleAux()

setAux

public FocusedDevice setAux(boolean isAux)

setAuxSticky

public FocusedDevice setAuxSticky(boolean isAuxSticky)

register

public void register()

Register the focused device listener, which will result in a listener callback to the presently focused device.

unregister

public void unregister()

Unregister the focus listener. Will clear the focused device and alert the listener to null focus before clearing all internal listeners.

getFocusedChannel

public LXBus getFocusedChannel()

Returns the currently focused bus

Returns:

Current bus focus

isAuxActive

public boolean isAuxActive()

getFocusedChannelTarget

public DiscreteParameter getFocusedChannelTarget()

previousChannel

public void previousChannel()

nextChannel

public void nextChannel()

previousDevice

public void previousDevice()

Shift focus to the previous device on the channel, if there is one

nextDevice

public void nextDevice()

Shift focus to the next device on the channel, if there is one

getDevice

public LXDeviceComponent getDevice()

Returns the device presently focused, if any

Returns:

Focused device, or null

updateRemoteControlFocus

public void updateRemoteControlFocus()

dispose

public void dispose()