public final class ComponentContext
extends java.lang.Object
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 |
isButtonContext()
Gets whether the UI has requested a "button wrapper".
|
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 |
setButtonContext(boolean isButton)
Sets whether the context is for a "button wrapper" - i.e.
|
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.
|
public DBObject getOriginalObject()
public void setUpdatedObject(DBObject updatedObject)
updatedObject
- public DBObject getUpdatedObject()
public SystemObject getUpdatedSystemObject()
public SystemObject getOriginalSystemObject()
public boolean isInFlatEditor()
public void setInTable(boolean inTable)
inTable
- flag to determine whether context is a tablepublic boolean isInTable()
public void setButtonContext(boolean isButton)
This is ignored unless there is a BaseEditorPanel registered via extension.xml for the context property.
isButton
- whether to request a button.public boolean isButtonContext()
setButtonContext(boolean)
public PropertyInfo getPropertyInfo()
getPropertyName()
returns a path this will be for
the final property in that path.getPropertyName()
public DBEditorConfig getEditorConfig()
public Namespace getDataContext()
public ComponentContext getParentComponentContext()
public void setParentComponentContext(ComponentContext parentComponentContext)
parentComponentContext
- the parent DBObject's contextpublic DBObjectProvider getProvider()
public java.lang.String getOwningPanelName()
public java.lang.String getPropertyName()
public java.lang.String getBasePath()
getUpdatedObject()
,
getUpdatedSystemObject()
public void setBasePath(java.lang.String basePath)
basePath
- the base property pathgetUpdatedObject()
,
getUpdatedSystemObject()
public java.lang.String getFullPropertyPath()