Module org.praxislive.code

Package org.praxislive.code

Class PropertyControl.Descriptor

java.lang.Object

org.praxislive.code.Descriptor<PropertyControl.Descriptor>

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

org.praxislive.code.PropertyControl.Descriptor

Enclosing class:

PropertyControl

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

Nested Class Summary

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

ControlDescriptor.Category

Method Summary

Modifier and Type	Method	Description
void	attach(CodeContext<?> context, PropertyControl.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 PropertyControl.Descriptor	create(CodeConnector<?> connector, P ann, Field field)
PortDescriptor	createPortDescriptor()
void	dispose()	Hook called when the descriptor is disposed, when the code context is changing or the component is being removed.
void	onReset()	Hook called when the code context becomes inactive, including on context swap, or if anything else triggers a reset while active.
void	onStop()	Hook called when the code context becomes inactive due to the execution context state changing.
void	write(TreeWriter writer)	Write properties or annotations as part of serialization of the component.

Methods inherited from class org.praxislive.code.ControlDescriptor

category, index

Methods inherited from class org.praxislive.code.Descriptor

id, onInit, onStart

Methods inherited from class java.lang.Object

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

Method Details

controlInfo

public ControlInfo controlInfo()

Description copied from class: ControlDescriptor

Get the control info for this control.

Specified by:

controlInfo in class ControlDescriptor<PropertyControl.Descriptor>

Returns:

info

attach

public void attach(CodeContext<?> context,
 PropertyControl.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<PropertyControl.Descriptor>

Parameters:

context - code context

previous - previous descriptor or null

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<PropertyControl.Descriptor>

Returns:

control

createPortDescriptor

public PortDescriptor createPortDescriptor()

dispose

public void dispose()

Description copied from class: Descriptor

Hook called when the descriptor is disposed, when the code context is changing or the component is being removed. This hook is not called by default when a descriptor is passed in as the previous instance in Descriptor.attach(org.praxislive.code.CodeContext, org.praxislive.code.Descriptor). The default implementation does nothing.

Overrides:

dispose in class Descriptor<PropertyControl.Descriptor>

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<PropertyControl.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<PropertyControl.Descriptor>

write

public void write(TreeWriter writer)

Description copied from class: Descriptor

Write properties or annotations as part of serialization of the component. The default implementation does nothing.

Overrides:

write in class Descriptor<PropertyControl.Descriptor>

Parameters:

writer - component tree writer

create

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