oracle.adfdt.view.common.binding

Class BaseADFDesignTimeContext

java.lang.Object

oracle.adfdt.view.common.binding.BaseADFDesignTimeContext

All Implemented Interfaces:

ADFDesignTimeContext

Direct Known Subclasses:

MDSDesignTimeContext

public abstract class BaseADFDesignTimeContext
extends java.lang.Object
implements ADFDesignTimeContext

Serves as a base implementation for ADFDesignTimeContexts. Classes implementing ADFDesignTimeContext are encouraged to use this as a base.

Constructor Summary

Constructors

Constructor and Description
BaseADFDesignTimeContext()

Method Summary

Modifier and Type	Method and Description
oracle.adfdt.model.objects.PageDefinition	findAndCachePageDefinition() If supported by the environment, this will locate the page definition if it exists, then cache it for further use.
java.util.Set<java.lang.String>	gatherViewIds() Returns all view ids currently in the owning document.
java.lang.String	generateName(java.util.Set<java.lang.String> existingNames, java.lang.String name) Generates a unique name from the set of existing names.
java.lang.String	generateUniqueIdForView(java.lang.String baseId)
org.w3c.dom.DocumentFragment	parseDocumentFragment(java.util.Map namespaces, java.lang.String text)
void	prepareAppendElement(org.w3c.dom.Element root, org.w3c.dom.Element subtree)
void	setupApplication(oracle.adfdt.model.objects.Application application)
void	setupEnvironmentForADFModelController()
void	setupEnvironmentForDataControl(oracle.adfdt.model.objects.DataControl control)
void	setupEnvironmentForView()

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.adfdt.ADFDesignTimeContext

findOrCreateApplication, findOrCreatePageDefinition, findOrCreatePageDefinition, findOrCreatePageDefinitionUsage, findPageDefinition, getDefaultLocale, getEnvironmentContext, getNormalizedPagePath, getViewDocument, launchBindingEditor

Constructor Detail

BaseADFDesignTimeContext

public BaseADFDesignTimeContext()

Method Detail

findAndCachePageDefinition

public oracle.adfdt.model.objects.PageDefinition findAndCachePageDefinition()

If supported by the environment, this will locate the page definition if it exists, then cache it for further use. This method is not thread safe.

Specified by:

findAndCachePageDefinition in interface ADFDesignTimeContext

gatherViewIds

public java.util.Set<java.lang.String> gatherViewIds()

Returns all view ids currently in the owning document.

Returns:

view ids currently in owning document

generateName

public java.lang.String generateName(java.util.Set<java.lang.String> existingNames,
                                     java.lang.String name)

Generates a unique name from the set of existing names. Typically, this method is preferred from generateUniqueIdForFiew when there are multiple elements with the same preferred name to be inserted in the document. Since generateUniqueIdForView only considers ids already in the document, successive calls to this with the same name will return the same result. The set of ids returned is mutable. When an id is set on a component, that id should be added to this set so that future calls of this method with the same name will return a unique result. The typical use for this method is as follows: Set<String> ids = <context>.gatherViewIds(); String id1 = <context>.generateName(ids, "foo"); // set id1 on some element ids.add(id1); String id2 = <context>.generateName(ids, "foo"); // set id2 on some element ids.add(id2);

Parameters:

existingNames - input existing names

name - input name

Returns:

generated name

parseDocumentFragment

public org.w3c.dom.DocumentFragment parseDocumentFragment(java.util.Map namespaces,
                                                          java.lang.String text)

Specified by:

parseDocumentFragment in interface ADFDesignTimeContext

generateUniqueIdForView

public java.lang.String generateUniqueIdForView(java.lang.String baseId)

Specified by:

generateUniqueIdForView in interface ADFDesignTimeContext

prepareAppendElement

public void prepareAppendElement(org.w3c.dom.Element root,
                                 org.w3c.dom.Element subtree)

Specified by:

prepareAppendElement in interface ADFDesignTimeContext

setupEnvironmentForView

public void setupEnvironmentForView()

Specified by:

setupEnvironmentForView in interface ADFDesignTimeContext

setupApplication

public void setupApplication(oracle.adfdt.model.objects.Application application)

Specified by:

setupApplication in interface ADFDesignTimeContext

setupEnvironmentForADFModelController

public void setupEnvironmentForADFModelController()

Specified by:

setupEnvironmentForADFModelController in interface ADFDesignTimeContext

setupEnvironmentForDataControl

public void setupEnvironmentForDataControl(oracle.adfdt.model.objects.DataControl control)

Specified by:

setupEnvironmentForDataControl in interface ADFDesignTimeContext