org.apache.beehive.controls.runtime.generator
Class ControlClient

Object
  extended by GenClass
      extended by ControlClient
Direct Known Subclasses:
AptControlClient

public abstract class ControlClient
extends GenClass


Constructor Summary
ControlClient()
           
 
Method Summary
 ArrayList<ControlField> getControls()
          Returns the list of ControlFields declared directly by this ControlImpl
 GenField getField(String name)
          Returns the field with the specified name
 String[] getGeneratedTypes()
          Returns the list of fully qualified class names for types that are derived from this GenClass
 List<GeneratorOutput> getGenerateOutput(Filer filer)
          Returns the information necessary to generate a ControlBean from this ControlInterface
protected abstract  String getSuperClientName()
          Returns the fully qualified classname of the closest control client in the inheritance chain.
 boolean hasControls()
          Returns true if the implemenation class contains any nested controls
protected abstract  boolean hasSuperClient()
           
protected  void init()
          Initializes the ControlClient class.
protected abstract  ArrayList<ControlField> initControls()
          Initializes the list of ControlFields declared directly by this ControlClient
protected abstract  void initEventAdaptors()
          Initializes the ControlEventAdaptors associated with this ControlClient
 boolean needsFieldInit()
          Returns true if the control client needs field initialization support
 
Methods inherited from class GenClass
getCheckOutput, getClassName, getPackage, getShortName, getSuperClass, hasSuperClass
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ControlClient

public ControlClient()
Method Detail

init

protected void init()
Initializes the ControlClient class. This will be called by custom subclasses to drive the initialization process.


initControls

protected abstract ArrayList<ControlField> initControls()
Initializes the list of ControlFields declared directly by this ControlClient


getControls

public ArrayList<ControlField> getControls()
Returns the list of ControlFields declared directly by this ControlImpl


hasControls

public boolean hasControls()
Returns true if the implemenation class contains any nested controls


hasSuperClient

protected abstract boolean hasSuperClient()

getSuperClientName

protected abstract String getSuperClientName()
Returns the fully qualified classname of the closest control client in the inheritance chain.

Returns:

initEventAdaptors

protected abstract void initEventAdaptors()
Initializes the ControlEventAdaptors associated with this ControlClient


needsFieldInit

public boolean needsFieldInit()
Returns true if the control client needs field initialization support


getField

public GenField getField(String name)
Returns the field with the specified name


getGeneratedTypes

public String[] getGeneratedTypes()
Returns the list of fully qualified class names for types that are derived from this GenClass

Overrides:
getGeneratedTypes in class GenClass

getGenerateOutput

public List<GeneratorOutput> getGenerateOutput(Filer filer)
                                        throws IOException
Returns the information necessary to generate a ControlBean from this ControlInterface

Overrides:
getGenerateOutput in class GenClass
Throws:
IOException