| java.lang.Object
 org.netbeans.modules.vmd.api.model.ComponentProducer
All known Subclasses: org.netbeans.modules.vmd.midpnb.producers.CustomComponentProducer, org.netbeans.modules.vmd.model.XMLComponentProducer, org.netbeans.modules.vmd.midp.producers.CommandProducer, org.netbeans.modules.vmd.midp.producers.ListElementEventSourceProducer, org.netbeans.modules.vmd.midpnb.producers.SVGMenuElementEventSourceProducer, org.netbeans.modules.vmd.midp.producers.MidpComponentProducer, org.netbeans.modules.vmd.midp.producers.IfPointProducer, org.netbeans.modules.vmd.midp.producers.EntryPointProducer, org.netbeans.modules.vmd.midp.producers.ChoiceElementProducer,
| ComponentProducer | | abstract public class ComponentProducer (Code) | | Represents a factory for components. The DescriptorRegistry contains a set of component producers. These producers are
usually visualized in the palette and represents a component, a group of components or component with special post-initialization.
ComponentProducer is automatically created for all ComponentDescriptors which return non-null value from getPaletteDescriptor method.
Usually you have to implement postInitialize method to initialize main component and/or create secondary components.
Then you have to implement checkValidity method.
author:
David Kaspar |
| Inner Class :final public static class Result | |
| ComponentProducer | | protected ComponentProducer(String producerID, TypeID typeID, PaletteDescriptor paletteDescriptor)(Code) | | Creates a component producer.
Parameters:
producerID - the unique producer id
Parameters:
typeID - the type id of the main component created by the producer.
Parameters:
paletteDescriptor - the palette descriptor used for visualization of the producer. |
| checkValidity | | abstract public Boolean checkValidity(DesignDocument document, boolean useCachedValue)(Code) | | Called for checking validity or availability of the producer for a specified document.
Usually it check whether the main component is in registry and the class in target language is
available on the class of a project where the document belongs.
Parameters:
document - the document where the producer could be used (and therefore checked against)
Parameters:
useCachedValue - use value from cache the result checking; true if the producer is valid, false is not valid and null if unresolved yet |
| createComponent | | final public Result createComponent(DesignDocument document)(Code) | | Creates a component.
Parameters:
document - the document the result of creation |
| createMainComponent | | protected DesignComponent createMainComponent(DesignDocument document)(Code) | | Creates or finds a main component of the producer for a document.
Parameters:
document - the docuemnt created or found non-null main component |
| getMainComponentTypeID | | final public TypeID getMainComponentTypeID()(Code) | | Returns a type id of the main component created by the producer.
the type id of the main component |
| getPaletteDescriptor | | final public PaletteDescriptor getPaletteDescriptor()(Code) | | Returns palette descriptor of the producer.
the palette descriptor |
| getProducerID | | final public String getProducerID()(Code) | | Returns producer id.
the producer id |
| postInitialize | | public Result postInitialize(DesignDocument document, DesignComponent mainComponent)(Code) | | Post-initialize main component. You can also create secondary components and initialize them too.
Default implementation returns a result with unchanged main component only.
Parameters:
document - the document
Parameters:
mainComponent - the main component usually created from getMainComponentTypeID method the result of creation |
|
|