com.ibm.designer.domino.xsp.api.panels
Interface IPanelsFactory

All Known Implementing Classes:
AbstractPanelsFactory

public interface IPanelsFactory

An interface used by the Lotus Domino Designer properties panels framework to create property panels for a given control. The framework uses the com.ibm.designer.domino.xsp.editor.component extension point to calculate which Classes/panels are needed for any given control. Once the ids of the panels have been distinguished the framework resolves the name of the factory that is to be used to load the panels. The factory (which is an instance of IPanelsFactory) is then called, and asked to create an XPagesAVPage for each panel defined for the given control in the extension point.

It is STRONGLY advised that clients extend AbstractPanelsFactory rather than implementing this interface.


Method Summary
 XPagesAVPage createPage(com.ibm.etools.attrview.sdk.AVFolder folder, XPagesPanelDescriptor xfacesPanelDescriptor)
          Creates a new properties page based on the description provided via the com.ibm.designer.domino.xsp.editor.component extension point.
 org.eclipse.swt.widgets.Composite createPanelContents(org.eclipse.swt.widgets.Composite parent, java.lang.Class<? extends org.eclipse.swt.widgets.Composite> controlClass, XPagesPanelDescriptor xfacesPanelDescriptor, IPanelExtraData data)
          Creates the contents of the XPagesAVPage.
 

Method Detail

createPage

XPagesAVPage createPage(com.ibm.etools.attrview.sdk.AVFolder folder,
                        XPagesPanelDescriptor xfacesPanelDescriptor)
Creates a new properties page based on the description provided via the com.ibm.designer.domino.xsp.editor.component extension point.

Parameters:
folder - the parent attributes view folder
xfacesPanelDescriptor - a description of the page that is to be created
Returns:
returns a new attributes view page based on the parameters

createPanelContents

org.eclipse.swt.widgets.Composite createPanelContents(org.eclipse.swt.widgets.Composite parent,
                                                      java.lang.Class<? extends org.eclipse.swt.widgets.Composite> controlClass,
                                                      XPagesPanelDescriptor xfacesPanelDescriptor,
                                                      IPanelExtraData data)
                                                      throws java.lang.SecurityException,
                                                             java.lang.NoSuchMethodException,
                                                             java.lang.IllegalArgumentException,
                                                             java.lang.InstantiationException,
                                                             java.lang.IllegalAccessException,
                                                             java.lang.reflect.InvocationTargetException
Creates the contents of the XPagesAVPage.

Parameters:
parent - the parent composite
controlClass - the Class that is to display in the XPagesAVPage
xfacesPanelDescriptor - the IPanelExtraData if available (may be null)
data -
Returns:
returns the Composite that is to appear in the XPagesAVPage
Throws:
java.lang.SecurityException
java.lang.NoSuchMethodException
java.lang.IllegalArgumentException
java.lang.InstantiationException
java.lang.IllegalAccessException
java.lang.reflect.InvocationTargetException