|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.5.0) E13403-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ModelFactory
ModelFactory describes the API by which an integrator may extend the UIEditor to provide custom design surfaces, known as UIEditorCanvas, which may be used by the user to manipulate an associated custom CmtModel implementation.
For example; a ModelFactory implementation might be provided to produce instances of 'UICanvas' which in turn manipulates instances of its custom model 'UIModel'. Additionally, a ModelFactory implementation might be provided to produce instaces of a 'MenuCanvas' which in turn manipulates instances of its custom model 'MenuModel'. Implementations of this interface are expected to be singletons. A ModelFactory is expected upon a call to annotate to generate relevant custom CmtModel instances which are then to be held by the target CmtComponentSource. Likewise, a ModelFactory instance is expected to keep track of an associated UIEditorCanvas on a UIEdiotr by UIEditor basis.
UIEditorCanvas
, CmtComponentSource
Field Summary | |
---|---|
static float |
DEFAULT_SECTION Default section for use when registering submenus, actions |
static float |
DEFAULT_WEIGHT Default weight for use when registering submenus, actions |
static int |
NO_PARENT Identifier meaning no parent for use when registering submenus, actions |
Method Summary | |
---|---|
void |
annotate(CmtComponentSource source, CmtComponents mgr) Called by the UIManager to parse the CmtComponentSource to produce any applicable CmtModel instances. |
IdeAction[] |
getActions() Get an array of all registered IdeActions for this ModelFactory. |
XMLKeyStrokeContext |
getKeyStrokeContext() Get an XMLKeyStrokeContext for use with the UIEditorCanavs objects produced by this ModelFactory. |
java.lang.Class |
getModelClass() Get the class of CmtModel produced by this ModelFactory. |
UIEditorCanvas |
getView(UIEditor editor) Find or create, for the given UIEditor, a UIEditorCanvas which is capable of manipulating instance of the CmtModel class produced by this ModelFactory. |
boolean |
isRegistered(IdeAction action) Determine whether the given IdeAction has been registered with this ModelFactory. |
IdeAction |
registerAction(int cmdID, java.lang.String name, java.lang.Integer mnemonic, ArrayResourceBundle bundle, int key, int parentID, float weight, float section) Generate an IdeAction for use when interacting with instances of the UIEditorCanvas produced by this factory. |
IdeAction |
registerAction(int cmdID, java.lang.String name, java.lang.Integer mnemonic, javax.swing.Icon icon, int parentID, float weight, float section) Generate an IdeAction for use when interacting with instances of the UIEditorCanvas produced by this factory. |
int |
registerSubMenu(int parentID, java.lang.String name, java.lang.Integer mnemonic, float weight, float section) Create a unique identifier for a given submenu name within a given submenu parent. |
Methods inherited from interface oracle.ide.controller.DynamicMenuListener |
---|
gatherDynamicActions |
Field Detail |
---|
static final int NO_PARENT
static final float DEFAULT_WEIGHT
static final float DEFAULT_SECTION
Method Detail |
---|
void annotate(CmtComponentSource source, CmtComponents mgr)
source
- the CmtComponentSource to be parsedmgr
- the CmtComponents instance that produced the sourceCmtComponentSource
, UIManager
UIEditorCanvas getView(UIEditor editor)
editor
- the UIEditor for which a UIEditorCanvas is desiredUIEditor
, UIEditorCanavs
, getModelClass()
java.lang.Class getModelClass()
CmtModel
XMLKeyStrokeContext getKeyStrokeContext()
XMLKeyStrokeContext
int registerSubMenu(int parentID, java.lang.String name, java.lang.Integer mnemonic, float weight, float section)
parentID
- the identifier for the parent submenu, else NO_PARENT.name
- the caption appearing on the menu.mnemonic
- the mnemonic appearing on the menu.weight
- the weight for positioning the menu relative to its siblings within the same section as used by oracle.ide.MenuManager.section
- the section in which to group the menu.oracle.ide.MenuManager
IdeAction registerAction(int cmdID, java.lang.String name, java.lang.Integer mnemonic, javax.swing.Icon icon, int parentID, float weight, float section)
cmdID
- the Command ID for which an IdeAction is desiredname
- the name for the resulting IdeActionmnemonic
- the mnemonic for the resulting IdeActionicon
- the Icon for the resulting IdeActionparentID
- the submenu ID onto which to add the IdeAction, else NO_PARENTweight
- the weight of the associated menu item.section
- the section of the associated menu item.oracle.ide.addin.Command
, oracle.ide.IdeAction
, oracle.ide.MenuManager
IdeAction registerAction(int cmdID, java.lang.String name, java.lang.Integer mnemonic, ArrayResourceBundle bundle, int key, int parentID, float weight, float section)
cmdID
- the Command ID for which an IdeAction is desiredname
- the name for the resulting IdeActionmnemonic
- the mnemonic for the resulting IdeActionbundle
- the ArrayResourceBundle from which to fetch the Iconkey
- the resource key to use when fetching an Icon for the resulting IdeActionparentID
- the submenu ID onto which to add the IdeAction, else NO_PARENTweight
- the weight of the associated menu item.section
- the section of the associated menu item.oracle.ide.addin.Command
, oracle.ide.IdeAction
IdeAction[] getActions()
registerAction(int, java.lang.String, java.lang.Integer, javax.swing.Icon, int, float, float)
boolean isRegistered(IdeAction action)
action
- the IdeAction to check.
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.5.0) E13403-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |