com.ibm.designer.domino.xsp.api.panels
Class XPagesPanelDescriptor

java.lang.Object
  com.ibm.commons.swt.util.registry.ExecutableConfigurationElement
      com.ibm.designer.domino.xsp.api.panels.XPagesPanelDescriptor

public class XPagesPanelDescriptor
extends com.ibm.commons.swt.util.registry.ExecutableConfigurationElement

A description class used to describe a properties panel for an XPage control as defined by the com.ibm.designer.domino.xsp.editor.component extension point. The description contains such information as the panel id, name, icon, indentation etc.

Clients should not extend this class, instances of this class are created internally in Domino Designer, subclasses will not be picked up by Domino Designer.

Field Summary

Fields inherited from class com.ibm.commons.swt.util.registry.ExecutableConfigurationElement

confElement

Constructor Summary

XPagesPanelDescriptor(org.eclipse.core.runtime.IConfigurationElement confElement)
Constructs a new instance of this class.

XPagesPanelDescriptor(java.lang.String id, java.lang.String title, boolean indented, FacesDefinition def)
Creates a new instance of this class.

Method Summary

java.lang.String	getHelpContextId()
java.lang.String	getId() Returns the id of the panel
org.eclipse.swt.graphics.Image	getImage() Returns the image to be used in the properties panel tab, normally null.
java.lang.String	getTitle() Returns the name of the panel
boolean	isIndented() Returns whether or not the panel is to be indented
boolean	isLazyInit() Returns whether or not the panel is to be initialized lazily.

Methods inherited from class com.ibm.commons.swt.util.registry.ExecutableConfigurationElement

createExecutableExtension, getAttribute, getAttribute, getConfElement, getDeclaringBundleName, getPreferenceStoreFromDeclaringPlugin

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XPagesPanelDescriptor

public XPagesPanelDescriptor(org.eclipse.core.runtime.IConfigurationElement confElement)
                      throws com.ibm.commons.swt.util.registry.ExtensionMissingAttributeException

Constructs a new instance of this class.

Parameters:

confElement - the configuration element as defined in the extension point

Throws:

com.ibm.commons.swt.util.registry.ExtensionMissingAttributeException

XPagesPanelDescriptor

public XPagesPanelDescriptor(java.lang.String id,
                             java.lang.String title,
                             boolean indented,
                             FacesDefinition def)

Creates a new instance of this class.

Parameters:

id - the id of the property panel

title - the name of the property panel as it is to appear in the UI

indented - true if the property panel is to be indented

def - the FacesDefinition of the control that this panel represents

Method Detail

getImage

public org.eclipse.swt.graphics.Image getImage()

Returns the image to be used in the properties panel tab, normally null.

Returns:

getId

public java.lang.String getId()

Returns the id of the panel

Returns:

a unique ID to identify the panel

getTitle

public java.lang.String getTitle()

Returns the name of the panel

Returns:

the title that is to appear in the property panel tab

isIndented

public boolean isIndented()

Returns whether or not the panel is to be indented

Returns:

true if the panel is indented

isLazyInit

public boolean isLazyInit()

Returns whether or not the panel is to be initialized lazily. Defaults to true. It is recommended to return true for performance reasons. If false all of the panels for a given control will be created when the control is clicked on in the xsp page.

Returns:

true if the panel is only to be created when clicked on (brought to top)

getHelpContextId

public java.lang.String getHelpContextId()