com.ibm.designer.domino.xsp.api.util
Class XPagesPropertiesViewUtils

java.lang.Object
  com.ibm.designer.domino.xsp.api.util.XPagesPropertiesViewUtils

public class XPagesPropertiesViewUtils
extends java.lang.Object

A utility class that is used in conjunction with the XPage properties panels, and related UI.

Field Summary

protected static java.lang.String	XFACES_DOM_LOADER_KEY KEY used to cache the ILoader associated with XPages
protected static java.lang.String	XFACES_MULTI_DOM_LOADER_KEY

Constructor Summary

XPagesPropertiesViewUtils()

Method Summary

static ILoader	getXPagesMultiDomLoader(DesignerProject project) Returns an ILoader which is aware of XPages.
static org.w3c.dom.Document	getXspConfigDocument() Returns the DOM Document for the xsp-config file corresponding to a custom control which is open in the currently active editor.
static org.w3c.dom.Document	getXspConfigDocument(org.eclipse.ui.IEditorPart editorPart) Returns the DOM Document for the xsp-config file corresponding to a custom control which is open in the provided editor part.
static boolean	isEditingCustomControl() Determines if the currently active editor part is editing a custom control.
static boolean	isEditingCustomControl(org.eclipse.ui.IEditorPart editor) Determines if the provided editor is editing a custom control.

Methods inherited from class java.lang.Object

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

Field Detail

XFACES_DOM_LOADER_KEY

protected static final java.lang.String XFACES_DOM_LOADER_KEY

KEY used to cache the ILoader associated with XPages

See Also:

Constant Field Values

XFACES_MULTI_DOM_LOADER_KEY

protected static final java.lang.String XFACES_MULTI_DOM_LOADER_KEY

See Also:

Constant Field Values

Constructor Detail

XPagesPropertiesViewUtils

public XPagesPropertiesViewUtils()

Method Detail

getXPagesMultiDomLoader

public static ILoader getXPagesMultiDomLoader(DesignerProject project)

Returns an ILoader which is aware of XPages. The XPages loader is used in conjunction with the XPages editor to create DOM Elements.

Parameters:

project - a DesignerProject representing a Notes application

Returns:

an ILoader capable of working with XPage controls

isEditingCustomControl

public static boolean isEditingCustomControl(org.eclipse.ui.IEditorPart editor)

Determines if the provided editor is editing a custom control.

Parameters:

editorPart - the part that is to be tested.

Returns:

true if the item being edited is a custom control

isEditingCustomControl

public static boolean isEditingCustomControl()

Determines if the currently active editor part is editing a custom control.

Returns:

true if the item being edited is a custom contrl

getXspConfigDocument

public static org.w3c.dom.Document getXspConfigDocument(org.eclipse.ui.IEditorPart editorPart)

Returns the DOM Document for the xsp-config file corresponding to a custom control which is open in the provided editor part.

Parameters:

editorPart - an opened editor part

Returns:

a DOM Document if the editor part is editing a custom control

getXspConfigDocument

public static org.w3c.dom.Document getXspConfigDocument()

Returns the DOM Document for the xsp-config file corresponding to a custom control which is open in the currently active editor.

Returns:

a DOM Document if the active editor part is editing a custom control