ComponentContext (Oracle Fusion Middleware Java API Reference for Oracle Extension SDK)

java.lang.Object
- oracle.ide.db.components.ComponentContext

```
public final class ComponentContext
extends java.lang.Object
```
Context object to hold information required by ComponentFactory framework. A ComponentContext always contains a single property, and an object that can be a child object (e.g. a Column) or a top level object (e.g. a Table). The context object also has the DBEditorConfig that the current editor was launched with, which contains the SystemObject being edited (which can be the context DBObject, or its top-level parent).

Since:

12

See Also:
ComponentFactory.createComponentContext(java.lang.String, oracle.javatools.db.DBObject, oracle.javatools.db.DBObject), ComponentWrapper.initialise(oracle.ide.db.components.ComponentContext)

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getBasePath()` Gets the base property path for the "updated object" in this context relative to the "updated system object" top level object.
`Namespace`	`getDataContext()` Gets the Namespace that is the "data context" of the owning Traversable panels.
`DBEditorConfig`	`getEditorConfig()` Gets the configuration that the current editor was launched with.
`java.lang.String`	`getFullPropertyPath()` Gets the full property path for the property in this context relative to the "updated system object".
`DBObject`	`getOriginalObject()` Get object that the updated object is a copy of.
`SystemObject`	`getOriginalSystemObject()` Gets the original, top level, object that is being edited.
`java.lang.String`	`getOwningPanelName()` Gets the name of the panel that created this context object.
`ComponentContext`	`getParentComponentContext()` Get the component context for the parent component.
`PropertyInfo`	`getPropertyInfo()` Gets the PropertyInfo object for the property in this context.
`java.lang.String`	`getPropertyName()` Gets the property to edit from this context.
`DBObjectProvider`	`getProvider()` Get DB object provider for the component's DB object
`DBObject`	`getUpdatedObject()` Get the updated object for this context.
`SystemObject`	`getUpdatedSystemObject()` Gets the updated, top level, object that is being edited.
`boolean`	`isInFlatEditor()` Is the current context a flat editor
`boolean`	`isInTable()` Is the current context a table
`void`	`setBasePath(java.lang.String basePath)` Sets the base property path for the "updated object" in this context relative to the "updated system object" top level object.
`void`	`setInTable(boolean inTable)` Is the current context a table
`void`	`setParentComponentContext(ComponentContext parentComponentContext)` Sets the ComponentContext that is parent to this ComponentContext - i.e.
`void`	`setUpdatedObject(DBObject updatedObject)` Set the updated version of the context object, this will include any changes made in the UI.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getOriginalObject
```
public DBObject getOriginalObject()
```
    Get object that the updated object is a copy of.
    
    Returns:
    original object instance
  - setUpdatedObject
```
public void setUpdatedObject(DBObject updatedObject)
```
    Set the updated version of the context object, this will include any changes made in the UI.
    
    Parameters:
    updatedObject -
  - getUpdatedObject
```
public DBObject getUpdatedObject()
```
    Get the updated object for this context. For a child object context this is the child object.
    
    Returns:
    updated object instance
  - getUpdatedSystemObject
```
public SystemObject getUpdatedSystemObject()
```
    Gets the updated, top level, object that is being edited. This might be the same as getUpdatedObject() if this context is the context for the top level object (e.g. Table), or it might be the parent of the child object in this context.
    
    Returns:
    the updated object the user is editing
  - getOriginalSystemObject
```
public SystemObject getOriginalSystemObject()
```
    Gets the original, top level, object that is being edited.
    
    Returns:
    the original object the user is editing
  - isInFlatEditor
```
public boolean isInFlatEditor()
```
    Is the current context a flat editor
    
    Returns:
    true if the component is in a flat editor else false
  - setInTable
```
public void setInTable(boolean inTable)
```
    Is the current context a table
    
    Parameters:
    inTable - flag to determine whether context is a table
  - isInTable
```
public boolean isInTable()
```
    Is the current context a table
    
    Returns:
    true if in a table else false
  - getPropertyInfo
```
public PropertyInfo getPropertyInfo()
```
    Gets the PropertyInfo object for the property in this context. Note that a PropertyInfo is only ever for the last property in a property path, so if getPropertyName() returns a path this will be for the final property in that path.
    
    See Also:
    getPropertyName()
  - getEditorConfig
```
public DBEditorConfig getEditorConfig()
```
    Gets the configuration that the current editor was launched with. This includes the containing DBObjectProvider, and the SystemObject that is being edited.
  - getDataContext
```
public Namespace getDataContext()
```
    Gets the Namespace that is the "data context" of the owning Traversable panels.
  - getParentComponentContext
```
public ComponentContext getParentComponentContext()
```
    Get the component context for the parent component.
    
    Returns:
    parent component context
  - setParentComponentContext
```
public void setParentComponentContext(ComponentContext parentComponentContext)
```
    Sets the ComponentContext that is parent to this ComponentContext - i.e. the context for the parent DBObject of the DBObject in this context.
    
    Parameters:
    parentComponentContext - the parent DBObject's context
  - getProvider
```
public DBObjectProvider getProvider()
```
    Get DB object provider for the component's DB object
    
    Returns:
    database object provider
  - getOwningPanelName
```
public java.lang.String getOwningPanelName()
```
    Gets the name of the panel that created this context object. It should be used to prefix the names of all owned Components.
  - getPropertyName
```
public java.lang.String getPropertyName()
```
    Gets the property to edit from this context. This could be a path, not just a simple property, but it is relative to the "updated object" in this context.
    
    Returns:
    the property on the "updated object" to edit.
  - getBasePath
```
public java.lang.String getBasePath()
```
    Gets the base property path for the "updated object" in this context relative to the "updated system object" top level object.
    
    Returns:
    the base property path
    See Also:
    getUpdatedObject(), getUpdatedSystemObject()
  - setBasePath
```
public void setBasePath(java.lang.String basePath)
```
    Sets the base property path for the "updated object" in this context relative to the "updated system object" top level object.
    
    Parameters:
    basePath - the base property path
    See Also:
    getUpdatedObject(), getUpdatedSystemObject()
  - getFullPropertyPath
```
public java.lang.String getFullPropertyPath()
```
    Gets the full property path for the property in this context relative to the "updated system object".

Class ComponentContext

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getOriginalObject

setUpdatedObject

getUpdatedObject

getUpdatedSystemObject

getOriginalSystemObject

isInFlatEditor

setInTable

isInTable

getPropertyInfo

getEditorConfig

getDataContext

getParentComponentContext

setParentComponentContext

getProvider

getOwningPanelName

getPropertyName

getBasePath

setBasePath

getFullPropertyPath