Module org.praxislive.code

Package org.praxislive.code

Class CodeComponent<D extends CodeDelegate>

java.lang.Object

org.praxislive.code.CodeComponent<D>

Type Parameters:

D - wrapped delegate type

All Implemented Interfaces:

Component

Direct Known Subclasses:

CodeContainer

public class CodeComponent<D extends CodeDelegate>
extends Object
implements Component

A CodeComponent is a Component instance that is rewritable at runtime. The CodeComponent itself remains constant, but passes most responsibility to a CodeContext wrapping a CodeDelegate (user code). This component handles switching from one context to the next. A CodeComponent cannot be created directly - see CodeFactory.

Method Summary

Modifier and Type	Method	Description
Control	getControl(String id)	Get a Control that can handle a Call to the given ID, or null if it does not exist.
ComponentInfo	getInfo()	Get the ComponentInfo object for this component.
Container	getParent()	Return the Container that is the immediate parent of this Component, or null if this Component is not currently contained within a Component hierarchy.
Port	getPort(String id)	Get the Port with the given ID, or null if it does not exist.
void	hierarchyChanged()	Notify the component that a change has happened in its component hierarchy.
void	parentNotify(Container parent)	Notify the Component that it has been added to the supplied Container, or removed from its parent if the supplied argument is null.

Methods inherited from class java.lang.Object

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

Method Detail

getParent

public final Container getParent()

Description copied from interface: Component

Return the Container that is the immediate parent of this Component, or null if this Component is not currently contained within a Component hierarchy.

Specified by:

getParent in interface Component

Returns:

Container

parentNotify

public final void parentNotify(Container parent)
                        throws VetoException

Description copied from interface: Component

Notify the Component that it has been added to the supplied Container, or removed from its parent if the supplied argument is null. The Component may throw a VetoException if it should not be added to the Container provided. It should also throw this exception if a parent is already set.

Specified by:

parentNotify in interface Component

Throws:

VetoException

hierarchyChanged

public void hierarchyChanged()

Description copied from interface: Component

Notify the component that a change has happened in its component hierarchy. For example its direct parent or an ancestor has changed. This method will be called after parentNotify() if the result of an immediate parent change.

Specified by:

hierarchyChanged in interface Component

getControl

public Control getControl(String id)

Description copied from interface: Component

Get a Control that can handle a Call to the given ID, or null if it does not exist. Component implementations are free to return a different Control for each ID, a single control to handle any message, or somewhere in between. A null return from this method shall be handled by the Root component by responding with an error message to the sender where required.

Specified by:

getControl in interface Component

Returns:

Control or null

getPort

public Port getPort(String id)

Description copied from interface: Component

Get the Port with the given ID, or null if it does not exist.

Specified by:

getPort in interface Component

Returns:

Port or null

getInfo

public ComponentInfo getInfo()

Description copied from interface: Component

Get the ComponentInfo object for this component.

Specified by:

getInfo in interface Component

Returns:

ComponentInfo