Module org.praxislive.code

Package org.praxislive.code

Class TriggerControl.Descriptor

java.lang.Object

org.praxislive.code.Descriptor<TriggerControl.Descriptor>

org.praxislive.code.ControlDescriptor<TriggerControl.Descriptor>

org.praxislive.code.TriggerControl.Descriptor

Enclosing class:

TriggerControl

public static class TriggerControl.Descriptor
extends ControlDescriptor<TriggerControl.Descriptor>

Nested Class Summary

Nested classes/interfaces inherited from class org.praxislive.code.ControlDescriptor

ControlDescriptor.Category

Constructor Summary

Constructors

Constructor	Description
Descriptor(String id, int index, TriggerControl.Binding binding)	Deprecated, for removal: This API element is subject to removal in a future version.
Descriptor(String id, int index, TriggerControl.Binding binding, Field triggerField)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
void	attach(CodeContext<?> context, TriggerControl.Descriptor previous)	Attach the descriptor to the provided context.
Control	control()	Get the wrapped control.
ControlInfo	controlInfo()	Get the control info for this control.
static TriggerControl.Descriptor	create(CodeConnector<?> connector, Inject ann, Field field)
static TriggerControl.Descriptor	create(CodeConnector<?> connector, T ann, Field field)
static TriggerControl.Descriptor	create(CodeConnector<?> connector, T ann, Method method)
PortDescriptor	createPortDescriptor()
void	onReset()	Hook called when the code context becomes inactive, including on context swap, or if anything else triggers a reset while active.
void	onStart()	Hook called when the code context becomes active due to the execution context state changing.
void	onStop()	Hook called when the code context becomes inactive due to the execution context state changing.

Methods inherited from class org.praxislive.code.ControlDescriptor

category, index

Methods inherited from class org.praxislive.code.Descriptor

dispose, id, onInit, write

Methods inherited from class java.lang.Object

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

Constructor Details

Descriptor

@Deprecated(forRemoval=true)
public Descriptor(String id,
 int index,
 TriggerControl.Binding binding)

Deprecated, for removal: This API element is subject to removal in a future version.

Descriptor

@Deprecated(forRemoval=true)
public Descriptor(String id,
 int index,
 TriggerControl.Binding binding,
 Field triggerField)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

controlInfo

public ControlInfo controlInfo()

Description copied from class: ControlDescriptor

Get the control info for this control.

Specified by:

controlInfo in class ControlDescriptor<TriggerControl.Descriptor>

Returns:

info

attach

public void attach(CodeContext<?> context,
 TriggerControl.Descriptor previous)

Description copied from class: Descriptor

Attach the descriptor to the provided context. The previous descriptor with the same ID and type is provided, if it exists. The implementation should handle disposal of the previous descriptor if required.

The Descriptor.onInit() hook will be called after attachment if the code context is active, or when the code context becomes active.

Specified by:

attach in class Descriptor<TriggerControl.Descriptor>

Parameters:

context - code context

previous - previous descriptor or null

onReset

public void onReset()

Description copied from class: Descriptor

Hook called when the code context becomes inactive, including on context swap, or if anything else triggers a reset while active. The default implementation does nothing.

Overrides:

onReset in class Descriptor<TriggerControl.Descriptor>

onStart

public void onStart()

Description copied from class: Descriptor

Hook called when the code context becomes active due to the execution context state changing. The Descriptor.onInit() hook will have been called prior to this hook. The default implementation does nothing.

Overrides:

onStart in class Descriptor<TriggerControl.Descriptor>

onStop

public void onStop()

Description copied from class: Descriptor

Hook called when the code context becomes inactive due to the execution context state changing. This hook will be called before the Descriptor.onReset() hook. The default implementation does nothing.

Overrides:

onStop in class Descriptor<TriggerControl.Descriptor>

control

public Control control()

Description copied from class: ControlDescriptor

Get the wrapped control. Should only be called when attached - behaviour is otherwise undefined.

Specified by:

control in class ControlDescriptor<TriggerControl.Descriptor>

Returns:

control

createPortDescriptor

public PortDescriptor createPortDescriptor()

create

public static TriggerControl.Descriptor create(CodeConnector<?> connector,
 T ann,
 Field field)

create

public static TriggerControl.Descriptor create(CodeConnector<?> connector,
 T ann,
 Method method)

create

public static TriggerControl.Descriptor create(CodeConnector<?> connector,
 Inject ann,
 Field field)