Module org.praxislive.code

Package org.praxislive.code

Class PropertyControl.Descriptor

java.lang.Object

org.praxislive.code.ControlDescriptor

org.praxislive.code.PropertyControl.Descriptor

Enclosing class:

PropertyControl

public static class PropertyControl.Descriptor
extends ControlDescriptor

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, Control previous)	Configure the control for the provided context during attachment.
static PropertyControl.Descriptor	create(CodeConnector<?> connector, P ann, Field field)
PortDescriptor	createPortDescriptor()
Control	getControl()	Get the wrapped control.
ControlInfo	getInfo()	Get the control info for this control.
void	reset(boolean full)	Hook called to reset during attachment / detachment, or execution context state changes.
void	stopping()	Deprecated hook - no op!

Methods inherited from class org.praxislive.code.ControlDescriptor

dispose, getCategory, getID, getIndex

Methods inherited from class java.lang.Object

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

Method Detail

getInfo

public ControlInfo getInfo()

Description copied from class: ControlDescriptor

Get the control info for this control.

Specified by:

getInfo in class ControlDescriptor

Returns:

info

attach

public void attach(CodeContext<?> context,
                   Control previous)

Description copied from class: ControlDescriptor

Configure the control for the provided context during attachment. The previous control with the same ID is provided - it may be null or of a different type.

Note : any control passed in as previous will not be disposed

Specified by:

attach in class ControlDescriptor

Parameters:

context - context being attached to

previous - previous control with same ID, may be null or different type

getControl

public Control getControl()

Description copied from class: ControlDescriptor

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

Specified by:

getControl in class ControlDescriptor

Returns:

control

createPortDescriptor

public PortDescriptor createPortDescriptor()

reset

public void reset(boolean full)

Description copied from class: ControlDescriptor

Hook called to reset during attachment / detachment, or execution context state changes. Full reset happens on execution context changes.

Overrides:

reset in class ControlDescriptor

Parameters:

full - true if execution context state

stopping

public void stopping()

Description copied from class: ControlDescriptor

Deprecated hook - no op!

Overrides:

stopping in class ControlDescriptor

create

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