org.apache.beehive.controls.api.bean
Interface ControlBean

All Superinterfaces:
BeanContextProxy, Serializable
All Known Implementing Classes:
ControlBean

public interface ControlBean
extends BeanContextProxy, Serializable

The ControlBean interface defines a base set of methods that are implemented by all JavaBeans that host Java Controls.

A ControlBean will implement the java.beans.beancontext.BeanContextProxy interface to provide a way to get the BeanContext directly associated with the Java Control. The getBeanContext() API on the interface will return the parent (containing) context.

See Also:
BeanContextProxy

Field Summary
static char IDSeparator
          The IDSeparator character is used to separated individual control IDs in nesting scenarios whether the identifier is actually a composite path that represents a nesting relationship.
 
Method Summary
 BeanContext getBeanContext()
          Returns the java.beans.beancontext.BeanContext that provides the parent context for the Java Control.
 ControlBeanContext getControlBeanContext()
          Returns the org.apache.beehive.controls.api.context.ControlBeanContext instance that provides the local context for this control bean.
 String getControlID()
          Returns the unique control ID associated with the Java ControlBean.
 Class getControlInterface()
          Returns the Java Control public interface for the ControlBean.
 
Methods inherited from interface BeanContextProxy
getBeanContextProxy
 

Field Detail

IDSeparator

static final char IDSeparator
The IDSeparator character is used to separated individual control IDs in nesting scenarios whether the identifier is actually a composite path that represents a nesting relationship.

See Also:
Constant Field Values
Method Detail

getBeanContext

BeanContext getBeanContext()
Returns the java.beans.beancontext.BeanContext that provides the parent context for the Java Control.

Returns:
the containing BeanContext for the Java ControlBean.
See Also:
BeanContext

getControlBeanContext

ControlBeanContext getControlBeanContext()
Returns the org.apache.beehive.controls.api.context.ControlBeanContext instance that provides the local context for this control bean. This is not the parent context for the control. It is the context that would be the parent context for any nested controls hosted by this control.


getControlID

String getControlID()
Returns the unique control ID associated with the Java ControlBean. This control ID is guaranteed to be unique within the containing BeanContext

Returns:
the control ID

getControlInterface

Class getControlInterface()
Returns the Java Control public interface for the ControlBean. This interface defines the operations and events exposed by the Java Control to its clients.

Returns:
the control public interface