oracle.jdeveloper.uieditor
Class UIManager

java.lang.Object
  oracle.jdeveloper.uieditor.UIManager

public final class UIManager
extends java.lang.Object

The UIManager provides the API necessary for the UIEditor to work in cooperation with integrator extensions. Integrators may register ModelFactory instances which in turn are responsible for tokenizing a given CmtComponentSource on demand. When opened, the UIEditor will ask the UIManager to annotate the CmtComponentSource upon which it has been opened. The UIManager will in turn defer annotation to each of the registered ModelFactory instances such that they may each add their own CmtModel trees to the CmtComponentSource for manipulation in the UIEditor via associated UIEditorCanvas instances.

Each variable declaration is expected to be represented by a CmtModelNode in a CmtModel produced by one of the ModelFactory instances. The UIManager supports the concept of a default ModelFactory which is the factory to use when no other registered ModelFactory has produced a CmtModelNode for a declared member.

Constructor Summary

UIManager()

Method Summary

static void	annotate(CmtComponentSource model, CmtComponents mgr) Tokenize the given CmtComponentSource into CmtModel trees of CmtModelNode with one CmtModelNode for each member field or local variable within the GUI initialization area.
static java.util.List	createApplicableOperations(Context c, oracle.javatools.datatransfer.ExtendedTransferable t)
static java.util.List	getAssistedLayouts()
static java.lang.String	getConcreteProxy(java.lang.String clsName) Get a registered proxy implementation class name for a given original class name.
static oracle.javatools.datatransfer.DataTransferPluginRegistry	getDataTransferPluginRegistry()
static oracle.javatools.datatransfer.ExtendedTransferable	getDropTransferable()
static java.util.Iterator	getFactories() Get an Iterator of all the registered ModeFactory instances.
static ModelFactory	getFactory(java.lang.Class cls) Get the ModelFactory that produced the CmtModel implementation class provided.
static LayoutAssistant	getLayoutAssistant(java.lang.String clsName)
static java.lang.String	getLibraryForLayout(java.lang.String layout)
static oracle.javatools.datatransfer.ExtendedTransferable	getPasteTransferable()
static URLPath	getProxyPath(java.lang.String clsName) Get the classpath in which the proxy class associated with a given original class name can be found.
static void	registerConcreteProxy(java.lang.String clsName, java.lang.String proxyName, URLPath proxyPath)
static void	registerFactory(ModelFactory factory) Register a ModelFactory.
static void	registerLayoutManager(java.lang.String layoutName, java.lang.String libID, java.lang.String assistantName)
static void	registerOperationFactory(oracle.jdeveloper.uieditor.datatransfer.OperationFactory factory)
static void	setDefaultFactory(ModelFactory factory) Set the ModelFactory to use as the default when no registered ModelFactory has produced a CmtModel containing a CmtModelNode for a given variable.
static void	setDropTransferable(java.awt.datatransfer.Transferable t) During a DnD, this is called to set the current transferable.
static void	setPasteTransferable(java.awt.datatransfer.Transferable t) During a copy/paste, this is called to set the current transferable.
static void	unregisterOperationFactory(oracle.jdeveloper.uieditor.datatransfer.OperationFactory factory)

Methods inherited from class java.lang.Object

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

Constructor Detail

UIManager

public UIManager()

Method Detail

setDefaultFactory

public static void setDefaultFactory(ModelFactory factory)

Set the ModelFactory to use as the default when no registered ModelFactory has produced a CmtModel containing a CmtModelNode for a given variable.

Parameters:

factory - the ModelFactory to use as default

See Also:

ModelFactory, CmtModel, oracle.jdeveloper.ctm.CmtModelNode

registerFactory

public static void registerFactory(ModelFactory factory)

Register a ModelFactory.

Parameters:

factory - the ModelFactory to register

See Also:

ModelFactory

getFactory

public static ModelFactory getFactory(java.lang.Class cls)

Get the ModelFactory that produced the CmtModel implementation class provided.

Parameters:

cls - an implementation of CmtModel

Returns:

the ModelFactory that produced the given CmtModel instance

getFactories

public static java.util.Iterator getFactories()

Get an Iterator of all the registered ModeFactory instances.

Returns:

an Iterator of all the registered ModelFactory instances.

annotate

public static void annotate(CmtComponentSource model,
                            CmtComponents mgr)

Tokenize the given CmtComponentSource into CmtModel trees of CmtModelNode with one CmtModelNode for each member field or local variable within the GUI initialization area.

Parameters:

model - the CmtCompnentModel to tokenize

mgr - the CmtComponents that produced the CmtComponentSource

registerLayoutManager

public static void registerLayoutManager(java.lang.String layoutName,
                                         java.lang.String libID,
                                         java.lang.String assistantName)

getAssistedLayouts

public static java.util.List getAssistedLayouts()

getLayoutAssistant

public static LayoutAssistant getLayoutAssistant(java.lang.String clsName)

getLibraryForLayout

public static java.lang.String getLibraryForLayout(java.lang.String layout)

registerConcreteProxy

public static void registerConcreteProxy(java.lang.String clsName,
                                         java.lang.String proxyName,
                                         URLPath proxyPath)

getConcreteProxy

public static java.lang.String getConcreteProxy(java.lang.String clsName)

Get a registered proxy implementation class name for a given original class name.

Parameters:

clsName - name of the original class for which a proxy is desired.

Returns:

name of a proxy class else null.

getProxyPath

public static URLPath getProxyPath(java.lang.String clsName)

Get the classpath in which the proxy class associated with a given original class name can be found.

Parameters:

clsName - name of the original class for which a proxy has been registered, else null to receive all paths from all proxy registrations.

Returns:

createApplicableOperations

public static java.util.List createApplicableOperations(Context c,
                                                        oracle.javatools.datatransfer.ExtendedTransferable t)

registerOperationFactory

public static void registerOperationFactory(oracle.jdeveloper.uieditor.datatransfer.OperationFactory factory)

unregisterOperationFactory

public static void unregisterOperationFactory(oracle.jdeveloper.uieditor.datatransfer.OperationFactory factory)

getDataTransferPluginRegistry

public static oracle.javatools.datatransfer.DataTransferPluginRegistry getDataTransferPluginRegistry()

getDropTransferable

public static oracle.javatools.datatransfer.ExtendedTransferable getDropTransferable()

setDropTransferable

public static void setDropTransferable(java.awt.datatransfer.Transferable t)

During a DnD, this is called to set the current transferable. If the parameter is non-null, this runs the given transferable through the augmentation process, which might result in the stored transferable being a different instance than what was passed.

getPasteTransferable

public static oracle.javatools.datatransfer.ExtendedTransferable getPasteTransferable()

setPasteTransferable

public static void setPasteTransferable(java.awt.datatransfer.Transferable t)

During a copy/paste, this is called to set the current transferable. If the parameter is non-null, this runs the given transferable through the augmentation process, which might result in the stored transferable being a different instance than what was passed.