com.ibm.designer.domino.xsp.api.published
Class XSPNodeData

java.lang.Object
  com.ibm.designer.domino.scripting.data.AbstractScriptData
      com.ibm.designer.domino.xsp.api.published.XSPNodeData

All Implemented Interfaces:

IScriptData

public class XSPNodeData
extends AbstractScriptData

Implementation of an script data map for a particular XSP node.

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.designer.domino.scripting.data.AbstractScriptData

AbstractScriptData.DataSourceObject, AbstractScriptData.DesignerObject, AbstractScriptData.JavaScriptObject

Nested classes/interfaces inherited from interface com.ibm.designer.domino.scripting.api.IScriptData

IScriptData.PublishedObject

Field Summary

Fields inherited from class com.ibm.designer.domino.scripting.data.AbstractScriptData

DIRECTORY_LIB, DOCDB_LIB, DOM_LIB, MAIL_LIB, RUNTIME_LIB, STANDARD_LIB, WEBSERVICES_LIB, XSP_LIB

Fields inherited from interface com.ibm.designer.domino.scripting.api.IScriptData

HAS_XML_DOCUMENT, JAVA_CLASS, JAVASCRIPT_TYPE, XML_DOCUMENT

Constructor Summary

XSPNodeData(IPanelExtraData data)
Consturcts a new instance of this class.

XSPNodeData(org.w3c.dom.Node node)
Constructs a new instance of this class.

Method Summary

protected void	addObjectsToMap(java.util.Map<java.lang.String,IScriptData.PublishedObject> map) Adds PublishedObjects to the given map.
protected void	addPrototypesToMap(java.util.Map<java.lang.String,com.ibm.xsp.javascript.XSPFunctions> map) Allows subclasses to add libraries to the reference tab in the JS Editor.
boolean	isPageData()

Methods inherited from class com.ibm.designer.domino.scripting.data.AbstractScriptData

getPrototypes, getPublishedObjects, isLibraryValid

Methods inherited from class java.lang.Object

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

Constructor Detail

XSPNodeData

public XSPNodeData(org.w3c.dom.Node node)

Constructs a new instance of this class.

Parameters:

node - the XPage DOM node that this object will represent

XSPNodeData

public XSPNodeData(IPanelExtraData data)

Consturcts a new instance of this class.

Parameters:

data - the IPanelExtraData object that has a reference to the currently selected XPages DOM node

Method Detail

addObjectsToMap

protected void addObjectsToMap(java.util.Map<java.lang.String,IScriptData.PublishedObject> map)

Description copied from class: AbstractScriptData

Adds PublishedObjects to the given map. Provides PublishedObjectProviders with the opportunity to contribute to the JS editor. Items added to the map via addObjectsToMap will be added to the reference tab of the JS Editor.

Overrides:

addObjectsToMap in class AbstractScriptData

addPrototypesToMap

protected void addPrototypesToMap(java.util.Map<java.lang.String,com.ibm.xsp.javascript.XSPFunctions> map)

Description copied from class: AbstractScriptData

Allows subclasses to add libraries to the reference tab in the JS Editor.

Specified by:

addPrototypesToMap in class AbstractScriptData

Parameters:

map - a map containing the name of the library as the key, and a list of functions as the key.

isPageData

public boolean isPageData()

Specified by:

isPageData in interface IScriptData

Overrides:

isPageData in class AbstractScriptData

Returns:

true or false depending on whether or not this data object is created based on data in an XPage