org.objectweb.fractal.api.control
Interface ContentController
public interface ContentController
A component interface to control the content of the component to which it
belongs. This content is supposed to be made of an unordered, unstructured
set of components.
addFcSubComponent
public void addFcSubComponent(Component subComponent)
throws IllegalContentException,
IllegalLifeCycleException
Adds a sub-component to this component. More precisely adds the component
whose reference is given as a sub-component of the component to which this
interface belongs. If
C is the sub-component set returned by
getFcSubComponents
just before a call to this
method, and
C' is the sub-component set just after this call, then
subComponent is guaranteed to be in
C', but
C' is
not guaranted to be the union of
C and
{subComponent},
nor to contain all the elements of
C.
subComponent
- the component to be added inside this component.
IllegalContentException
- if the given component cannot be added
inside this component.IllegalLifeCycleException
- if this component has a LifeCycleController
interface, but it is not in an appropriate state
to perform this operation.
getFcInternalInterface
public Object getFcInternalInterface(String interfaceName)
throws NoSuchInterfaceException
Returns an internal interface of the component to which this interface
belongs.
interfaceName
- the name of the internal interface that must be
returned.
- the internal interface of the component to which this interface
belongs, whose name is equal to the given name.
NoSuchInterfaceException
- if there is no such interface.
getFcInternalInterfaces
public Object[] getFcInternalInterfaces()
Returns the internal interfaces of the component to which this interface
belongs.
- the internal interfaces of the component to which this interface
belongs.
getFcSubComponents
public Component[] getFcSubComponents()
Returns the sub-components of this component.
- the
Component
interfaces of the sub-components of the
component to which this interface belongs.
removeFcSubComponent
public void removeFcSubComponent(Component subComponent)
throws IllegalContentException,
IllegalLifeCycleException
Removes a sub-component from this component. More precisely removes the
sub-component whose reference is given from the component to which this
interface belongs. If
C is the sub-component set returned by
getFcSubComponents
just before a call to this
method, and
C' is the sub-component set just after this call, then
subComponent is guaranteed not to be in
C', but
C'
is
not guaranted to be the difference of
C and
{subComponent}, nor to contain all the elements of
C distinct
from
subComponent.
subComponent
- the component to be removed from this component.
IllegalContentException
- if the given component cannot be removed
from this component.IllegalLifeCycleException
- if this component has a LifeCycleController
interface, but it is not in an appropriate state
to perform this operation.