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

java.lang.Object
  com.ibm.designer.domino.xsp.api.panels.XPagesAttributesProvider

All Implemented Interfaces:

com.ibm.designer.domino.xsp.internal.panels.attrview.IXFacesAttributesProvider

public class XPagesAttributesProvider
extends java.lang.Object
implements com.ibm.designer.domino.xsp.internal.panels.attrview.IXFacesAttributesProvider

A provider class that gets called each time selection changes within the XPages editor. Once selection is changed the XPages attributes view framework queries a registry for a AttributesProvider for the current selection. If a custom provider is not provided a new instance of com.ibm.designer.domino.xsp.api.panels.XPagesAttributesProvider will be provided as the AttributeProvider.

The AttributesProvider is responsible for returning an array of XPagesAVPage for the given selection.

Constructor Summary

XPagesAttributesProvider()

Method Summary

protected XPagesAVPage[]	doGetAVPagesForTag(XPagesKey key, XPagesAVFolder folder) Uses the XPages property panel infrastructure to load the properties panels for a given XPages tag (key). Clients intending on providing their own XPagesAttributesProvider should override this method in order to get properties panels to load dynamically based on the contents of a tag rather than the tag name.
protected XPagesAVPage	getAllPropertiesTab(XPagesAVFolder folder) Creates a new instance of the All Properties tab.
java.lang.String	getCategoryID() Returns the category id for the current properties panels
org.w3c.dom.Node	getNode() Returns the currently selected Node.
XPagesAVPage[]	getXPagesAVPages(XPagesAVFolder folder) Returns an array of pages that are to be used as tabs in the properties view for XPages.
void	setIsCustomControl(boolean b) Sets whether or not the current selection is on a Custom Control.
void	setIsMultiSelect(boolean b) Sets whether or not the current selection contains multiple items.
void	setNode(org.w3c.dom.Node n) Sets the current node that is being selected

Methods inherited from class java.lang.Object

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

Constructor Detail

XPagesAttributesProvider

public XPagesAttributesProvider()

Method Detail

setIsCustomControl

public void setIsCustomControl(boolean b)

Sets whether or not the current selection is on a Custom Control.

Parameters:

b - true if a custom control is currently selected

setIsMultiSelect

public void setIsMultiSelect(boolean b)

Sets whether or not the current selection contains multiple items.

Parameters:

b - true if more than one item is selected.

setNode

public void setNode(org.w3c.dom.Node n)

Sets the current node that is being selected

Parameters:

n - the currently selected node

getCategoryID

public java.lang.String getCategoryID()

Returns the category id for the current properties panels

Specified by:

getCategoryID in interface com.ibm.designer.domino.xsp.internal.panels.attrview.IXFacesAttributesProvider

Returns:

a string id

getNode

public org.w3c.dom.Node getNode()

Returns the currently selected Node.

Specified by:

getNode in interface com.ibm.designer.domino.xsp.internal.panels.attrview.IXFacesAttributesProvider

Returns:

a node

getXPagesAVPages

public XPagesAVPage[] getXPagesAVPages(XPagesAVFolder folder)

Returns an array of pages that are to be used as tabs in the properties view for XPages.

Specified by:

getXPagesAVPages in interface com.ibm.designer.domino.xsp.internal.panels.attrview.IXFacesAttributesProvider

Parameters:

folder - the XPagesAVFolder object that will be used as a parent for the returned XPagesAVPages

Returns:

an array of properties panels

getAllPropertiesTab

protected XPagesAVPage getAllPropertiesTab(XPagesAVFolder folder)

Creates a new instance of the All Properties tab.

Parameters:

folder - the attributes folder in which the All Properties tab is to appear.

Returns:

a new instance of the All Properties tab

doGetAVPagesForTag

protected XPagesAVPage[] doGetAVPagesForTag(XPagesKey key,
                                            XPagesAVFolder folder)

Uses the XPages property panel infrastructure to load the properties panels for a given XPages tag (key).
Clients intending on providing their own XPagesAttributesProvider should override this method in order to get properties panels to load dynamically based on the contents of a tag rather than the tag name.

Parameters:

key - the XPages tag that the user wishes to load

folder - the parent folder

Returns:

an array of XPagesAVPage